https://github.com/synfig/synfig-docs-dev
Developer's documentation of Synfig
https://github.com/synfig/synfig-docs-dev
hacktoberfest synfig
Last synced: 9 months ago
JSON representation
Developer's documentation of Synfig
- Host: GitHub
- URL: https://github.com/synfig/synfig-docs-dev
- Owner: synfig
- Created: 2018-04-07T15:19:49.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2025-07-29T19:59:57.000Z (10 months ago)
- Last Synced: 2025-08-05T12:41:08.534Z (9 months ago)
- Topics: hacktoberfest, synfig
- Homepage: https://synfig-docs-dev.readthedocs.io/
- Size: 2.13 MB
- Stars: 7
- Watchers: 7
- Forks: 27
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Synfig developer documentation
==============================
Project documentation is built using [Sphinx docs](http://sphinx-doc.org/), which uses [ReST](http://docutils.sourceforge.net/rst.html) for markup. This allows the docs to cover a vast amount of topics without using a thousand-line README file.
We are using [pipenv](https://docs.pipenv.org/) to generate Sphinx docs.
Installation:
```bash
$ 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:
```bash
$ 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 .