I try to create a html documentation for a project containing several thousand classes using sphinx and it's autodoc plugin. sphinx-apidoc creates wonderful rst-files, but lacks of an automatic creation of autoclasses and automethods.
Is there a way/command/utility in sphinx to auto-include all variables, functions, classes and decorators in the documentation?
Some sample code of one rst-file:
tagger Package
=================
:mod:`tagger` Package
------------------------
.. automodule:: project.tagger
:members:
:mod:`client` Module
--------------------
.. automodule:: project.analyzers.tagger.client
:members:
reStructuredText is the default plaintext markup language used by Sphinx. This section is a brief introduction to reStructuredText (reST) concepts and syntax, intended to provide authors with enough information to author documents productively.
There is a Sphinx extension which will help you in this called autodoc.
If you want to include the class then you have to write:
.. autoclass:: <ClassName>
Similarly for a method:
.. automethod:: <MethodName>
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With