Paver Task

Description:Paver task to manage Python packages hosted at GitHub.

Configuration

These tasks use:

  • options.setup.name, used for your GitHub repository name.

  • options.setup.description, used for your GitHub repository description.

  • options.sphinx.docroot, set by default to docs/.

  • options.sphinx.build, set by default to build.

  • options.sphinx.source, set by default to source.

  • options.gh_pages.root, local path to gh_pages root; set by default to <options.sphinx.docroot>/<options.sphinx.build>/html

  • options.gh_pages.htmlroot, local path to the html output of your doc

    built; set by default options.gh_pages.root (you might want to host more than your Sphinx doc there).

  • options.gh_pages.remote_name, set by default to ``origin` and used for your github repository remote name.

  • options.gh_pages.master_branch, set by default to master.

options.gh_pages.root and options.gh_pages.htmlroot will only be of any used if you are using something else than Sphinx (and don’t want to use Sphinx options).

github.tools.task.gh_register(func)
Create a repository at GitHub and push it your local repository.
github.tools.task.gh_pages_create(func)
Create a submodule to host your documentation.
github.tools.task.gh_pages_update(func)
Push your documentation it to GitHub.
github.tools.task.gh_pages_clean(func)

Clean your documentation.

Update the submodule (every changes not committed and pushed will be lost), pull any changes and remove any file in options.gh_pages.docroot.

github.tools.task.gh_pages_build(func)
Build your documentation with sphinx.

Table Of Contents

Previous topic

PasteScript template

Next topic

Changes

This Page