Pregunta

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?

¿Fue útil?

Solución

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:
Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow
scroll top