Sorting display by class using sphinx with ‘autodoc’?

by

The autosummary extension, with the autosummary_generate configuration variable set to True, can be used to 1) generate compact summary listings and 2) generate class documentation with one page per class.

You have to explicitly specify each class to be included, but once this is done you have a setup for generating clear documentation where the classes are visually well separated.

The following markup will output one “stub” .rst page for each class (Class1, Class2, Class3). Each page is based on a template and includes an .. autoclass:: directive that extracts the full documentation. In the final HTML output, each class page is linked from the corresponding entry in the main autosummary table. 

:mod:`mymodule` --- Some module
===============================

This module contains several classes. 

.. currentmodule:: mymodule

Class overview
--------------

.. autosummary::
   :toctree: stubs
   :template: class.rst

   Class1
   Class2
   Class3

Details here: https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html

More Related Contents:

  1. Sphinx’s autodoc’s automodule having apparently no effect
  2. Sphinx autodoc is not automatic enough
  3. Adding a cross-reference to a subheading or anchor in another page
  4. Override function declaration in autodoc for sphinx
  5. Sphinx cannot find my python files. Says ‘no module named …’
  6. Format text in a link in reStructuredText
  7. Automatically document all modules recursively with Sphinx autodoc
  8. sphinx-build fail – autodoc can’t import/find module
  9. sphinx.ext.autodoc: Keeping names of constants in signature
  10. How would I cross-reference a function generated by autodoc in Sphinx?
  11. How do I document classes without the module name?
  12. Can sphinx link to documents that are not located in directories below the root document?
  13. How do I document classes imported from other modules – hence without the declaration module’s name?
  14. How do I set up custom styles for reStructuredText, Sphinx, ReadTheDocs, etc.?
  15. How to add custom css file to Sphinx?
  16. How do I output a config value in a Sphinx .rst file?
  17. Keeping the API updated in Sphinx
  18. How to preserve line breaks when generating python docs using sphinx
  19. How to force Sphinx to use Python 3.x interpreter
  20. How to document Python packages using Sphinx
  21. How to use sphinx automodule and exposed functions in __init__
  22. Customize sphinxdoc theme
  23. How to express multiple types for a single parameter or a return value in docstrings that are processed by Sphinx?

Leave a Comment