improve docs for uploading gh-pages docs

This commit is contained in:
Jim Witschey
2017-05-25 11:30:59 -04:00
parent 6232eb5fdc
commit 336e7636d1

View File

@@ -48,18 +48,19 @@ To build the docs, run::
python setup.py doc
To upload the docs, checkout the ``gh-pages`` branch (it's usually easier to
clone a second copy of this repo and leave it on that branch) and copy the entire
To upload the docs, checkout the ``gh-pages`` branch and copy the entire
contents all of ``docs/_build/X.Y.Z/*`` into the root of the ``gh-pages`` branch
and then push that branch to github.
For example::
git checkout 1.0.0
python setup.py doc
cp -R docs/_build/1.0.0-beta1/* ~/python-driver-docs/
cd ~/python-driver-docs
git add --all
git commit -m 'Update docs'
git checkout gh-pages
cp -R docs/_build/1.0.0/* .
git add --update # add modified files
# Also make sure to add any new documentation files!
git commit -m 'Update docs (version 1.0.0)'
git push origin gh-pages
If docs build includes errors, those errors may not show up in the next build unless