KnowledgeHub
Questions
Tags
Users
Search
Alex Rivera
|
Logout
Edit Question
Title
Body
I just started to use Sphinx tool to generate a documentation for my code. But I'm a bit confused because it's not as easy as I expected. I create the Sphinx doc using: sphinx-quickstart and then I create my *.rst files into the "source" folder. Seems like I need to create a *.rst file for each module I want to create a document for. For test.py, I create test.rst. Inside test.rst, I have: .. automodule:: test :members: :show-inheritance: Then inside test.py, I have: """ .. module:: test :platform: Unix, Windows :synopsis: A useful module indeed. """ Then I generate the documentation using: sphinx-build -b html source/ build/ Everything works as expected, but the problem is that it's not as easy as I expected. I guess that there must be an easier way to do it with skipping some of these steps. I wonder if there is any way to generate a documentation for all the modules inside a package instead of generating a *.rst file for each module. Thanks.
Tags (comma-separated)
Save Edits
Cancel