summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRalf Gommers <ralf.gommers@gmail.com>2015-10-18 14:24:00 +0200
committerRalf Gommers <ralf.gommers@gmail.com>2015-10-18 16:27:21 +0200
commit0b83a90f5e6157ced66792c3de6f68436ee96e05 (patch)
tree5e9095dc7c8b17b0229728f48fe6149691d335f9 /doc
parentc9dcd91ed1e21c4b6a2c22cd4b633ac9d4eb0a9e (diff)
downloadnumpy-0b83a90f5e6157ced66792c3de6f68436ee96e05.tar.gz
REL: add "make upload" command for built docs, update "make dist".
Changes to "make dist" for building docs: - remove .chm related line, we don't distribute those on docs.scipy.org - only include needed pdf files in dist.tar.gz [ci skip]
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile21
1 files changed, 19 insertions, 2 deletions
diff --git a/doc/Makefile b/doc/Makefile
index d8c1ab918..b52933e14 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -32,6 +32,7 @@ help:
@echo " linkcheck to check all external links for integrity"
@echo " dist PYVER=... to make a distribution-ready tree"
@echo " gitwash-update GITWASH=path/to/gitwash update gitwash developer docs"
+ @echo " upload USERNAME=... RELEASE=... to upload built docs to docs.scipy.org"
clean:
-rm -rf build/* source/reference/generated
@@ -59,6 +60,7 @@ gitwash-update:
INSTALL_DIR = $(CURDIR)/build/inst-dist/
INSTALL_PPH = $(INSTALL_DIR)/lib/python$(PYVER)/site-packages:$(INSTALL_DIR)/local/lib/python$(PYVER)/site-packages:$(INSTALL_DIR)/lib/python$(PYVER)/dist-packages:$(INSTALL_DIR)/local/lib/python$(PYVER)/dist-packages
+UPLOAD_DIR=/srv/docs_scipy_org/doc/numpy-$(RELEASE)
DIST_VARS=SPHINXBUILD="LANG=C PYTHONPATH=$(INSTALL_PPH) python$(PYVER) `which sphinx-build`" PYTHON="PYTHONPATH=$(INSTALL_PPH) python$(PYVER)" SPHINXOPTS="$(SPHINXOPTS)"
@@ -72,8 +74,8 @@ real-dist: dist-build html html-scipyorg
-rm -rf build/dist
cp -r build/html-scipyorg build/dist
cd build/html && zip -9r ../dist/numpy-html.zip .
- cp build/latex/numpy-*.pdf build/dist
- -zip build/dist/numpy-chm.zip build/htmlhelp/numpy.chm
+ cp build/latex/numpy-ref.pdf build/dist
+ cp build/latex/numpy-user.pdf build/dist
cd build/dist && tar czf ../dist.tar.gz *
chmod ug=rwX,o=rX -R build/dist
find build/dist -type d -print0 | xargs -0r chmod g+s
@@ -84,6 +86,21 @@ dist-build:
install -d $(subst :, ,$(INSTALL_PPH))
$(PYTHON) `which easy_install` --prefix=$(INSTALL_DIR) ../dist/*.egg
+upload:
+ # SSH must be correctly configured for this to work.
+ # Assumes that ``make dist`` was already run
+ # Example usage: ``make upload USERNAME=rgommers RELEASE=1.10.1``
+ ssh $(USERNAME)@new.scipy.org mkdir $(UPLOAD_DIR)
+ scp build/dist.tar.gz $(USERNAME)@new.scipy.org:$(UPLOAD_DIR)
+ ssh $(USERNAME)@new.scipy.org tar xvC $(UPLOAD_DIR) \
+ -zf $(UPLOAD_DIR)/dist.tar.gz
+ ssh $(USERNAME)@new.scipy.org mv $(UPLOAD_DIR)/numpy-ref.pdf \
+ $(UPLOAD_DIR)/numpy-ref-$(RELEASE).pdf
+ ssh $(USERNAME)@new.scipy.org mv $(UPLOAD_DIR)/numpy-user.pdf \
+ $(UPLOAD_DIR)/numpy-user-$(RELEASE).pdf
+ ssh $(USERNAME)@new.scipy.org mv $(UPLOAD_DIR)/numpy-html.zip \
+ $(UPLOAD_DIR)/numpy-html-$(RELEASE).zip
+ ssh $(USERNAME)@new.scipy.org /srv/bin/fixperm-scipy_org.sh
#------------------------------------------------------------------------------
# Basic Sphinx generation rules for different formats