Skip to main content

Read The Docs

Read The Docs is a documentation generator that utilizes either Sphinx or MkDocs, depending on your choice. The RTD GitHub houses the configurations and files that generates the Official Website. This provides a good example of the many features RTD offers, and allows you to step through configurations in a more feature-rich and complete setup.

Since there are different choices for the backend static site generator, the deployment procedure is different depending on which one you choose. Below, we will cover deploying Read The Docs with Sphinx and MkDocs. These two sections are each entirely different deployments of RTD, where the difference is only the Backend Static Site Generator that is used to build your documentation.

Alternatively, you can simply sign up on the RTD official website and allow them to host the documentation for you by linking a repository to your user account and following the Quick Start Instructions. Since this is nearly turn-key, we won't cover deploying RTD this way.

There are also two independent versions of RTD, one community and one for business related documentation that also supports private repositories and other security features. When visiting https://readthedocs.org, we are viewing community version documentation. When visiting https://readthedocs.com, we are viewing the business version documentation.

For the below documentation, we will be using the Community Version of Read The Docs since the business version is Subscription Based.

Sphinx

Need a place to host your Sphinx docs? readthedocs.org hosts a lot of Sphinx docs already, and integrates well with projects' source control. It also features a powerful built-in search that exceeds the possibilities of Sphinx' JavaScript-based offline search. - Sphinx

MkDocs

Themes

Community Themes

MkDocs is very themeable, you'll notice with the screenshot below that the Windmil Theme is quite different from the readthedocs theme used on the RTD Website.