From b78f0ad973bbe1ac306e987fafe997907f2eee2c 2015-03-26 18:20:07 From: Thomas Kluyver Date: 2015-03-26 18:20:07 Subject: [PATCH] Merge pull request #8155 from Carreau/doc-doc more docs on building docs --- diff --git a/docs/Makefile b/docs/Makefile index cae3a1d..e64b2e8 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -28,6 +28,7 @@ help: @echo " info Texinfo files and run them through makeinfo" @echo " changes an overview over all changed/added/deprecated items" @echo " linkcheck check all external links for integrity (takes a long time)" + @echo " gh-pages clone IPython docs in ./gh-pages/ , build doc, autocommit" @echo @echo "Compound utility targets:" @echo "pdf latex and then runs the PDF generation" diff --git a/docs/README.rst b/docs/README.rst index 0cfe596..4fb8fb7 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -3,6 +3,14 @@ IPython Documentation This directory contains the majority of the documentation for IPython. +Deploy docs +----------- + +Run ``make gh-pages``, and follow instruction, that is to say: +cd into ``gh-pages``, check that everything is alright and push. + + + Requirements ------------ The following tools are needed to build the documentation: