Contributing to the Documentation

This page contains all relevant Information for contributing to this Documentation.

Github

The Source for this Documentation is hosted on Github to allow easy collaboration via a standardized Git Workflow.

Reporting an Issue

If you don’t want to write whole articles or changes yourself, you can also submit Issues via the Github Interface to raise awareness about problems with the documentation, or just to suggest new topics that should be covered.

Making a Pull Request

If you want to directly contribute to the Documentation, you can do so via standard Github Pull Requests.

To do so, simply fork the CryDocs repository and commit your changes to a new Branch. Then you can submit a new Pull Request to the main Repository and your changes will be evaluated. Once your Pull Request has been approved, your name will be added to the List of contributors.

reStructuredText and Sphinx

This Documentation is written in reStructuredText and uses the Sphinx Tool to generate a viewable Html, Pdf or Epub version. The syntax is similar to Markdown, but extends upojn it.

Installing Sphinx

Sphinx requires a working Python installation on your machine. From there its as simple as running:

pip install -U sphinx

Installing the RTD Theme

To offer a modern look and feel for the documentation we are using the RTD Sphinx Theme. The conf.py is already set up to use it, so it needs to be installed on the local machine as well.

pip install sphinx_rtd_theme

The Documentation for the Theme can be found here.

Building the Documentation

To view your changes, simply use the make file or the windows bat script in the project root to build the html documentation. This can then be viewed in the browser. A reStructuredText extension for Visual Studio Code is available as well.

Make:

make html

Windows:

make.bat html