From 336e7636d1c06e6092558ae43e99ce7a34c4b172 Mon Sep 17 00:00:00 2001 From: Jim Witschey Date: Thu, 25 May 2017 11:30:59 -0400 Subject: [PATCH] improve docs for uploading gh-pages docs --- README-dev.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README-dev.rst b/README-dev.rst index a26dcf99..8812bce6 100644 --- a/README-dev.rst +++ b/README-dev.rst @@ -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