Generate static/complete `.rst` files with autodoc

72 views Asked by At

is there a way to make sphinx-apidoc (by using the autodoc extension) generate fully static .rst files with the complete documentation content (docstrings) directly embedded in them?

For example, given a foo.py module with one fuction:

# foo.py
def add_one(a: int) -> int:
    """Some documentation.
    """
    return a + 1

currently the foo.rst file it produces is:

foo module
==========

.. automodule:: foo
   :members:
   :undoc-members:
   :show-inheritance:

Can we somehow get a complete static .rst so that e.g. you can copy the docs in a different directory, and run make html without the need to import the python code?

Thank you!

0

There are 0 answers