Readthedocs¶
Introduction¶
Readthedocs is an online service to host technical documentation, especially in Sphinx format. If your documentation code lives on GitHub a webhook can configured to trigger Readthedocs to fetch and build Sphinx documentation.
Workflow¶
-
Git Commit -> Webhook -> Sphinx Build -> Publish
Use cases¶
Readthedocs provides different output formats like HTML, ePub, and PDF in different languages and different versions (branches).
You can configure your own sub-domain like http://docs-i18n.readthedocs.io/ or use your own name space and configure aliases or forwards.