openstack/deb-python-cassandra-driver
Code Issues Proposed changes

improve docs for uploading gh-pages docs

Browse Source
This commit is contained in:
Jim Witschey
2017-05-25 11:30:59 -04:00
parent 6232eb5fdc
commit 336e7636d1
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README-dev.rst
View File

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