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 each tag, and decide which one is the default.

Like versions, RTD offers internationalization (i18n) support in case you want to write your documentation in several languages.

..................Content has been hidden....................

You can't read the all page of ebook, please click here login for view all page.
Reset