Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: fde20bbf6b
Fetching contributors…

Cannot retrieve contributors at this time

49 lines (28 sloc) 1.091 kb

Building the docs

First initialize and pull the submodule containing the Sphinx theme. Do this from the top directory of rootpy (not here in docs):

git submodule init
git submodule update

To build the docs as html (you need Sphinx installed):

make html

or simply (html is the default):


The built html is then found in _build/html. To preview the docs locally before uploading:

make show

Uploading the docs

If you have not done so already, add a reference to the main rootpy repository from your fork:

git remote add upstream

Create a local branch that tracks the main gh-pages branch:

git fetch upstream
git branch gh-pages upstream/gh-pages

To upload the docs to install ghp-import:

pip install ghp-import

and from the top directory of rootpy (not here in docs):

ghp-import -r upstream -p docs/_build/html/
Jump to Line
Something went wrong with that request. Please try again.