From a9c91a7fbf76bda59814e984bb8989fb6ae384eb Mon Sep 17 00:00:00 2001 From: Scott Sanderson Date: Thu, 19 Nov 2015 02:59:31 -0500 Subject: [PATCH] MAINT: Add a script for deploying docs changes. --- docs/source/release-process.rst | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/source/release-process.rst b/docs/source/release-process.rst index af5565db..24089c1a 100644 --- a/docs/source/release-process.rst +++ b/docs/source/release-process.rst @@ -171,27 +171,25 @@ Once you have tested the package, it can be uploaded to PyPI with: Documentation ~~~~~~~~~~~~~ -To update `zipline.io `__, run: +To update `zipline.io `__, checkout the +latest master and run: -.. code-block:: bash +.. code-block:: python - $ cd /docs - $ make html - $ cp -r build/html /tmp/zipline-doc - $ git checkout gh-pages - $ mv /tmp/zipline-doc/* . - $ rm /tmp/zipline-doc + python /docs/deploy.py +This will build the documentation, checkout a fresh copy of the ``gh-pages`` +git branch, and copy the built docs into the zipline root. Now, using our browser of choice, view the ``index.html`` page and verify that the docs look correct. -Once we are happy, run: +Once we are happy, push the updated docs to the GitHub ``gh-pages`` branch. .. code-block:: bash $ git add . $ git commit -m "DOC: update zipline.io" - $ git push + $ git push origin gh-pages `zipline.io `__ will update in a few moments.