Auto-Generated Python Documentation with Sphinx (See comments for update fix)

**EDIT: The behaviour of sphinx-quickstart appears to have changed since this video was posted (where sphinx==1.6.7). Please see comments for updated fix.**
From user Luke Davoli: "append "--ext-autodoc" when running sphinx-apidoc"

How to use Sphinx to generate great looking documentation for your Python project.

Note: This is the bare minimum needed to get up and running, but should serve as a good jumping off point.

Have questions?

[gavinharmon]

This is a top notch tutorial, and I much appreciate you keeping up with it in the comments.

Subscribed, many thanks!!

[avcourt]

User: _jairo ruiz_ has proposed a fix for newer versions of Sphinx below in the comments:

*In order to make it work in the newest version (2.3.1), you will need to enable autodoc in the Sphinx **conf.py** file, just add 'sphinx.ext.autodoc' to the extensions list. Then you can run 'sphinx-apidoc' and 'make html' as it is explained in the video.*

[forklift]

Thank you. I couldn't get it working until I read the EDIT below the video. That was what I needed.

[edoardodamico]

Is the only good guide on YouTube for Sphinx, Thanks a lot.

Plz make more content about it !

[nicholasvieira]

Excellent, concise and complete tutorial. Thanks!!

[liborkom]

Excellent tutorial. I watched several other Sphinx tutorials, but I didn't get anything out of them. However, this one is simple, short and taught me everything I needed to know. You got yourself a subscriber.

[avcourt]

**EDIT: The behaviour of sphinx-quickstart appears to have changed since this video was posted, but should work with sphinx==1.6.7. I will be researching the new method of using Sphinx and posting an amendment to this video or creating a new one. If anyone has any tips in the mean-time, please leave them in the comments.**

[MaxMustermann-pu]

Now the name of the package python-sphinx has changed into python3-sphinx.

[tanzeelurrahman]

Thanks man! This is the best intro one can get.

[rajendradaslyf]

Thanks for the simple and quick video. It was straight to the point.

You got yourself a subscriber !

[ds]

I don't understand why this doesn't work. My index.rst doesn't display any of my comments. When creating the rst files using sphinx-apidoc, it only generate a single ./modules.rst file. Perhaps this is because I an using nested directories?

[peegee]

Very clear and good tutorial! Thanks for the support!

[mrwho]

Simple, quick, and informative. Thanks for this tutorial.

[TheRealBigEE]

Great work. Succinct and extremely useful.

[el-jay_]

Hi. Is it possible to one-time generate documentation for a multi-app django project? or do i have to manually generate for each app?

[zohaibjan]

Thank you so much for this such a concise and helpfull vid

[evgeniisharaborin]

Thank you for the great video!
I have only __init__.py file, how to add functions from this file? It seems that sphinx ignores all files beginning with __

[jamtart]

Good stuff. Only need 4 minutes, can get the rest from the docs

[henriqueoliveiracosta]

hey dude, question... how only writing "modules" make your sphinx detect spamfilter.py, test_spamfilter.py and create a .rst file? did I miss any step?

[RobertAlexanderRM]

Very good tutorial thanks. Would be even more complete if you could add or direct towards a similar tutorial giving tips and tricks on how to format the docstrings or other source for the documentaton to be generated.