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.
Attribute in a Class immediately runs at the wrong time?
Unable to handle “HTTP Badstatus line” exception
How to merge/join two resultset/table in django?
Maximise the Slope using CVXPY
Python-Instagram user_recent_media returning next of none
Django - AttributeError: 'module' object has no attribute 'admin'
Convert pandas (python) categorical x-axis to continuous values when plotting
How to make a specific type of python face tracker
OSError when trying to delete keys from redis
remove/reset matplotlib quiver arrows
Repeating elements in a list
Run python-rq worker process on application start
Chrome Not Starting When Using ChromeDriver
How to selectively iterate over files with Python
I'm having trouble using docker-py in a development environment on OSX
How to query AWS to get ELB names and attached instances to that using python boto modules?