asherehsa / syncany-docs

Syncany User Guide

Syncany User Guide

The is the source project for the Syncany User Guide. The documentation is built using the Sphinx documentation generator on the Read the Docs platform. It is automatically rebuilt with every commit to the develop branch.

Building

To build the docs locally, run:

$ sudo pip install sphinx
$ make html

Theme

The documentation uses the Sphinx Read The Docs Theme. To add/update it locally, do this:

$ git remote add readthedocs [email protected]:snide/sphinx_rtd_theme.git
$ git fetch readthedocs
$ git subtree add --prefix=source/_themes readthedocs/master
$ rm -rf (everything in source/_themes, but sphinx_rtd_theme)

The last rm is a workaround to prevent the inclusion of other rst files.