sphinx documentation: split a python source into sections, using autodoc
I'm using Sphinx with autodoc to document my sources. Lets say i have a file pre_processing.py, containing 3 classes. I would like to have section in the generated html files, like this Main ==== Topic1 ------ blabla Here is included class1 and class2 doc Topic2 ------ blibli Here is included class3 doc However , all that i can manage so far is this: Main ==== Topic1 ------ blabla Here is a link to class1 and class2 doc Topic2 ------ blibli Here is a link to class3 doc Here is cdumped class1, class2 and class3 How can this be achieved please ? Do i have to abandon autodoc, and fill my rst file manually ?
You can do that, by putting your outline (and accompanying text) into the docstring of the module itself. Let’s say this is your pre_processing.py: # yada yada license yada """ Main ==== Topic1 ------ blabla .. autoclass:: class1 .. autoclass:: class2 Topic2 ------ blibli Here is a link to class3 doc """ class class1(…): """ docstring of class 1 """ … Then you can simply use .. automodule: in your .rst file: .. automodule:: pre_processing That will first read the docstring of the module and generate the documentation from there. Due to the autoclass directives in there, the classes are also documented.
xliff and placeable substitution
Checking that array doesn't contain negative numbers, and running function again if it does
Matplotlib and non-ascii characters
How does HttpResponse(status=<code>) work in django?
Write a CSV from Urlib and manage encoding properly
python - list index out of range, working with CSV?
Pandas DataFrame get substrings from column
Python GET is not working in browser
Django, Pinax, couldn't extract file
Getting proper list of members from pymongo
Not writing into an Excel file
How to integrate my python plugin with nagios
Find words containing . in middle or at the end
Using apply on a column
Maximum-sum subarray given constraints on indices
Converting text to columns