CODEWITHSUNDEEP
pythonpython-sphinxautodoc
user805981
user805981

Reputation: 11059

How do you make a Sphinx doc with one .py file that has only functions?

How do I make a Sphinx doc with one .py file that has only functions?

I have a .py file with multiple functions that have docstrings in them already but don't want to make a :function:: console.someFunction for all the functions. Is there a smarter or better way to iterate through all the functions?

Upvotes: 3

Views: 1155

Answers (1)

sashkello
sashkello

Reputation: 17871

Yes, it is possible, what you need is autodoc. Don't forget to add sphinx.ext.autodoc to conf.py.

Set up your sphinx docs as usual and in your .rst file have something along the lines of:

.. automodule:: myfile
   :members:

Upvotes: 4

Related Questions