paved.docs

paved.sphinx – helpers and tasks for Sphinx documentation.

paved.docs.sphinx_make(*targets)

Call the Sphinx Makefile with the specified targets.

options.paved.docs.path: the path to the Sphinx folder (where the Makefile resides).

paved.docs.docs()

Make Sphinx docs.

options.paved.docs.path: the path to the Sphinx folder (where the Makefile resides).

options.paved.docs.targets: the Make targets to send to sphinx_make. Default is html.

paved.docs.clean_docs()

Clean Sphinx docs.

options.paved.docs.path: the path to the Sphinx folder (where the Makefile resides).

paved.docs.rsync_docs()

Upload the docs to a remote location via rsync.

options.paved.docs.rsync_location: the target location to rsync files to.

options.paved.docs.path: the path to the Sphinx folder (where the Makefile resides).

options.paved.docs.build_rel: the path of the documentation

build folder, relative to options.paved.docs.path.

paved.docs.ghpages()

Push Sphinx docs to github gh-pages branch.

1. Create file .nojekyll
2. Push the branch to origin/gh-pages after committing using ghp-import

Requirements:

• easy_install ghp-import

Options:

• options.paved.docs.* is not used
• options.sphinx.docroot is used (default=docs)
• options.sphinx.builddir is used (default=.build)

Warning

This will DESTROY your gh-pages branch. If you love it, you’ll want to take backups before playing with this. This script assumes that gh-pages is 100% derivative. You should never edit files in your gh-pages branch by hand if you’re using this script because you will lose your work.

paved.docs.showhtml()

Open your web browser and display the generated html documentation.