##// END OF EJS Templates
Initial docs section on building and uploading docs. Haven't yet checked rst formatting.
Thomas Kluyver -
Show More
@@ -133,6 +133,26 b' docutils (the machinery to process reStructuredText):'
133 In the past IPython used epydoc so currently many docstrings still use
133 In the past IPython used epydoc so currently many docstrings still use
134 epydoc conventions. We will update them as we go, but all new code should
134 epydoc conventions. We will update them as we go, but all new code should
135 be documented using the NumPy standard.
135 be documented using the NumPy standard.
136
137 Building and uploading
138 ======================
139 The built docs are stored in a separate repository. Through some github magic,
140 they're automatically exposed as a website. It works like this:
141
142 - You will need to have sphinx and latex installed. In Ubuntu, install
143 `python-sphinx`, `texlive-latex-recommended`, `texlive-latex-extra`,
144 `texlive-fonts-recommended`.
145 - Ensure that the development version of IPython is the first in your system
146 path. You can either use a virtualenv, or modify your PYTHONPATH.
147 - Switch into the docs directory, and run `make gh-pages`. This will build your
148 updated docs as html and pdf, check out the latest version of the docs
149 repository, copy the built docs into it, and commit your changes.
150 - Open the built docs in a web browser, and check that they're as expected.
151 - (If rebuilding dev, a duplicate version may have been added to the index.
152 Remove this from index.rst, then run `python build_index.py` to update
153 index.html. Commit the change.)
154 - Upload the docs with `git push`. This only works if you have write access to
155 the docs repository.
136
156
137 .. [reStructuredText] reStructuredText. http://docutils.sourceforge.net/rst.html
157 .. [reStructuredText] reStructuredText. http://docutils.sourceforge.net/rst.html
138 .. [Sphinx] Sphinx. http://sphinx.pocoo.org/
158 .. [Sphinx] Sphinx. http://sphinx.pocoo.org/
General Comments 0
You need to be logged in to leave comments. Login now