Join us and get access to hundreds of tutorials and a community of expert Pythonistas.

Unlock This Lesson

This lesson is for members only. Join us and get access to hundreds of tutorials and a community of expert Pythonistas.

Unlock This Lesson

Hint: You can adjust the default video playback speed in your account settings.
Hint: You can set the default subtitles language in your account settings.
Sorry! Looks like there’s an issue with video playback 🙁 This might be due to a temporary outage or because of a configuration issue with your browser. Please see our video player troubleshooting guide to resolve the issue.

Hosting Your Documentation on Read The Docs

Give Feedback

Learn how to upload your documentation to Read The Docs. You’ll see how to use the Read The Docs dashboard to import a project hosted on GitHub. The lesson will also show you how to create a post commit hook in GitHub to automatically build and update the documentation on Read The Docs.

The final part of the lesson is an overview of what you have learned in this course:

  • Building documentation from scratch
  • Creating a Sphinx configuration
  • Adding templates and structure for your documentation
  • Styling and formatting documentation
  • Adding a post commit hook to automatically update documentation when new code is pushed.

Florian Dahlitz RP Team on March 27, 2019

Hey Mahdi Yusuf,

First of all I want to thank you for this tutorial. As many people (including me) are preferring to use Markdown over reStructured Text, I wanna ask you if it’s possible to add a section about how to properly extend sphinx to support Markdown as well. Certain extensions of projects already exist, but maybe you can give some guidance on that.

Thanks again for creating this! Florian

Dan Bader RP Team on March 27, 2019

@Florian: I’ll chime in for Mahdi here—explaining how to use Sphinx with Markdown support is a great idea for extending this course or adding a new set of lessons, so thanks for that.

In the meantime, you might find this helpful:

www.sphinx-doc.org/en/master/usage/markdown.html

Evan E on May 28, 2019

Read the docs is giving me a build fail with an error of Sphinx error contents.rst is not found? How can I fix this to get the doctut up on read the docs?

Peter on June 27, 2019

Now that we know how to add the license information into our documentation: Will there be a Documenting Python Projects Part II that actually shows how to get the Python code docstrings well structured into html? I always thought this is the basic idea behind Sphinx.

PatrickB on Dec. 6, 2019

This tutorial is a good, basic overview of Sphinx.

Another course on restructuredtext (RST), which is closely tied to Python would be useful.

Thanks.

Ghani on Oct. 20, 2020

Thanks for this very useful tutorial!

Become a Member to join the conversation.