Sphinx autodoc is not automatic enough

Michael Zippo

👻 Check our latest review to choose the best laptop for Machine Learning engineers and Deep learning tasks!

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 I have many files. It would be much easier if I could just specify that I wanted the "mods" package to be documented. Sphinx could then recursively go through the package and make a page for each submodule.

Is there a feature like this? If not I could write a script to make all the .rst files, but that would take up a lot of time.

👻 Read also: what is the best laptop for engineering students?

We hope this article has helped you to resolve the problem. Apart from Sphinx autodoc is not automatic enough, check other code Python module-related topics.

Want to excel in Python? See our review of the best Python online courses 2023. If you are interested in Data Science, check also how to learn programming in R.

By the way, this material is also available in other languages:

Chen Lehnman

Moscow | 2023-02-07

I was preparing for my coding interview, thanks for clarifying this - Sphinx autodoc is not automatic enough in Python is not the simplest one. Will use it in my bachelor thesis

Dmitry Porretti

Paris | 2023-02-07

Simply put and clear. Thank you for sharing. Sphinx autodoc is not automatic enough and other issues with io Python module was always my weak point 😁. Will get back tomorrow with feedback

Javier Williams

Milan | 2023-02-07

I was preparing for my coding interview, thanks for clarifying this - Sphinx autodoc is not automatic enough in Python is not the simplest one. Will get back tomorrow with feedback