Skip to content

Building and uploading the official documentation

jorisvandenbossche edited this page Oct 27, 2014 · 4 revisions

Following steps for building and uploading the official online documentation when a new version is released.

Setting up an appropriate environment

Supposing you are on linux (building the docs on Windows generates some extra errors)

In /home/joris/scipy:

conda create -n docs --file pandas-docs/requirements.txt
conda install setuptools
cd pandas
python setup.py develop
easy_install rpy2
sudo apt-get install dvipng

(om één of andere reden werkt dat laatste niet met pip)

Checkout the released version

Checkout the released (tagged) version, and rebuild (in case there were changes to cython files, and moreover this is needed to ensure the correct version is outputted!):

git checkout v0.15.0
python setup.py build_ext -i

Build the docs

Note: an internet connection is needed (for interlinks, and certain examples) when building the docs.

If the environment is OK, the correct version is checked out and built, the docs can be built:

cd doc
python make.py clean
python make.py html
python make.py zip_html
python make.py latex_forced

Upload the docs

Then upload the built docs (example for 0.15.0 docs). You both upload to 'stable' and to the specific version tag:

python make.py upload_stable
python make.py upload_stable_pdf
python make.py upload_previous 0.15.0

Depending on your access to the pydata server, you need to add --user=username.

Clone this wiki locally