Skip to content
This repository has been archived by the owner on Feb 27, 2020. It is now read-only.

Source repository for Clearwater's ReadTheDocs.org documentation

License

Notifications You must be signed in to change notification settings

Metaswitch/clearwater-readthedocs

Repository files navigation

Project Clearwater is backed by Metaswitch Networks. We have discontinued active support for this project as of 1st December 2019. The mailing list archive is available in GitHub. All of the documentation and source code remains available for the community in GitHub. Metaswitch’s Clearwater Core product, built on Project Clearwater, remains an active and successful commercial offering. Please contact clearwater@metaswitch.com for more information. Note – this email is for commercial contacts with Metaswitch. We are no longer offering support for Project Clearwater via this contact.

clearwater-readthedocs

This is the source repository for http://clearwater.readthedocs.org.

We prefer to use Markdown, but ReadTheDocs works best with reStructuredText, so this repo includes scripts to convert our Markdown files into reStructuredText in the autogenerated_rst_docs directory (which ReadTheDocs will then use, because it contains the conf.py file). It also includes scripts to convert the mkdocs.yml table of contents into a Sphinx/rST table of contents.

This processing is done automatically by our Jenkins CI server - human editors should just change the .md files and the mkdocs.yml file.