Sphinx Error Unknow directive type "automodule" or "autoclass"

Posted by user1130381 on Stack Overflow See other posts from Stack Overflow or by user1130381
Published on 2012-11-22T16:02:53Z Indexed on 2012/11/22 16:59 UTC
Read the original article Hit count: 2636

Filed under:

python-sphinx

|

autodoc

I need document my python project using Sphinx. But I can't use autodoc.

When I config my project I select the option "extension autodoc", but now if I use .. autoclass:: Class, I have a ERROR:

ERROR: Unknown directive type "autoclass"

I configure the PYTHONPATH, and now it's good. But I already have this problem.

My index file is:

.. ATOM documentation master file, created by sphinx-quickstart on Thu Nov 22 15:24:42 2012. You can adapt this file completely to your liking, but it should at least contain the root toctree directive.

Welcome to ATOM's documentation!

Contents:

.. toctree:: :maxdepth: 2

.. automodule:: atom

Indices and tables

:ref:genindex
:ref:modindex
:ref:search

Thank you, I need that someone say me how I find the problem, or how i can fix this!

Sorry for my English, I start now to learn English.

© Stack Overflow or respective owner

Related posts about python-sphinx

Include at text file as is in (Python) Sphinx Docs

as seen on Stack Overflow - Search for 'Stack Overflow'
(using Python-Sphinx Documentation tool) I have a .txt log file I'd like to build into _build/html unaltered. What do I need to alter in conf.py, index.rst, etc. Here is the layout: src/ index.rst some_doc.rst somefile.txt How do I get somefile.txt into the html build? I tried adding… >>> More
Documenting module/class/function bodies in python sphinx docs

as seen on Stack Overflow - Search for 'Stack Overflow'
Is there a way with Sphinx documentation to output a function or class body (the code itself) with the autodoc feature? I'm using autodoc to much success. In addition to the docstrings getting pulled in to the documentation I want like a link to click for each function where it will show you the source… >>> More
Sphinx Error Unknow directive type "automodule" or "autoclass"

as seen on Stack Overflow - Search for 'Stack Overflow'
I need document my python project using Sphinx. But I can't use autodoc. When I config my project I select the option "extension autodoc", but now if I use .. autoclass:: Class, I have a ERROR: ERROR: Unknown directive type "autoclass" I configure the PYTHONPATH, and now it's good. But I already… >>> More
Getting the source .rst file path in Sphinx extension

as seen on Stack Overflow - Search for 'Stack Overflow'
I am writing a Sphinx extension and I need to know the document page source code file system path (.rst file location) to extract some version control system information of it. How can I get this information in my event handler / which event handler I should use? Example: # This package may contain… >>> More
Package system broken - E: Sub-process /usr/bin/dpkg returned an error code (1)

as seen on Ask Ubuntu - Search for 'Ask Ubuntu'
After installing some packages and libraries I have an error on Package Manager, I can't run any update because it says: "The package system is broken If you are using third party repositories then disable them, since they are a common source of problems. Now run the following command in a terminal:… >>> More

Related posts about autodoc

displaying python's autodoc to the user (python 3.3)

as seen on Programmers - Search for 'Programmers'
I'm writing a simple command line math game, and I'm using python's autodoc for my math algorithms to help me remember, for example, what a proth number is while i'm writing the algorithm, but later on I'll want to tell that information to the user as well, so they'll know what the answer was. So… >>> More
Sphinx autodoc is not automatic enough

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm trying to use Sphinx to document a 5,000+ line project in Python. It has about 7 base modules. As far as I know, In order to use autodoc I need to write code like this for each file in my project: .. automodule:: mods.set.tests :members: :show-inheritance: This is way too tedious because… >>> More
How to autodoc .Net Google code projects?

as seen on Stack Overflow - Search for 'Stack Overflow'
I know how to generate html documentation using Sandcastle and similar tools. But if I want to host the project on Google code, how can I easily publish the documentation straight into the Google project Wiki pages? I can see the SVN repository has a wiki folder which I assume maps to the project… >>> More
Sphinx Error Unknow directive type "automodule" or "autoclass"

as seen on Stack Overflow - Search for 'Stack Overflow'
I need document my python project using Sphinx. But I can't use autodoc. When I config my project I select the option "extension autodoc", but now if I use .. autoclass:: Class, I have a ERROR: ERROR: Unknown directive type "autoclass" I configure the PYTHONPATH, and now it's good. But I already… >>> More
Documenting module/class/function bodies in python sphinx docs

as seen on Stack Overflow - Search for 'Stack Overflow'
Is there a way with Sphinx documentation to output a function or class body (the code itself) with the autodoc feature? I'm using autodoc to much success. In addition to the docstrings getting pulled in to the documentation I want like a link to click for each function where it will show you the source… >>> More