saurabh-ramola / synfig-docs-dev

Developer's documentation of Synfig

Synfig developer documentation

Project documentation is built using Sphinx docs, which uses ReST for markup. This allows the docs to cover a vast amount of topics without using a thousand-line README file.

We are using pipenv to generate Sphinx docs.

Installation:

$ sudo pip3 install pipenv
$ cd docs
$ pipenv install --three

This will install the python virtual environment needed for generating the docs.

Afterwards you can generate documentation by running this command:

$ pipenv run make html

The docs will be generated, the output files will be placed in the _build/html/ directory, and can be browsed (locally) with any browser.

The docs can also be found online at https://synfig-docs-dev.readthedocs.org/.