Python Microservices Development

ReadTheDocs

In the same vein as Travis, another service that can be hooked from within your GitHub repository is ReadTheDocs (RTD) (https://docs.readthedocs.io ).

It generates and hosts the project documentation for you. There's nothing concrete to do in your repository. You just configure RTD, so it creates the documentation out of a Sphinx HtmlDir, and the service finds the elements automatically.

For non-trivial integration, RTD can be configured via a YAML file. Once the documentation is ready, it will be accessible at https://<yourprojectname>.readthedocs.io.

RTD comes with versions support, which is useful when you release a new version of your service. That feature scans Git tags, and lets you build and publish your documentation per ...