Show More
@@ -140,18 +140,20 b' The built docs are stored in a separate repository. Through some github magic,' | |||
|
140 | 140 | they're automatically exposed as a website. It works like this: |
|
141 | 141 | |
|
142 | 142 | - You will need to have sphinx and latex installed. In Ubuntu, install |
|
143 |
` |
|
|
144 | `texlive-fonts-recommended`. | |
|
143 | ``texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended``. | |
|
144 | Install the latest version of sphinx from PyPI (``pip install sphinx``). | |
|
145 | 145 | - Ensure that the development version of IPython is the first in your system |
|
146 | 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 |
|
|
148 |
updated docs as html and pdf, check out the latest |
|
|
149 |
repository, copy the built docs into it, and commit your |
|
|
147 | - Switch into the docs directory, and run ``make gh-pages``. This will build | |
|
148 | your updated docs as html and pdf, then automatically check out the latest | |
|
149 | version of the docs repository, copy the built docs into it, and commit your | |
|
150 | changes. | |
|
150 | 151 | - 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 | |
|
152 | - (If rebuilding the docs for the development version, it may have duplicated | |
|
153 | the link to the development version in the homepage. Remove this from | |
|
154 | index.rst, then run ``python build_index.py`` to update index.html. Commit the | |
|
155 | change.) | |
|
156 | - Upload the docs with ``git push``. This only works if you have write access to | |
|
155 | 157 | the docs repository. |
|
156 | 158 | |
|
157 | 159 | .. [reStructuredText] reStructuredText. http://docutils.sourceforge.net/rst.html |
General Comments 0
You need to be logged in to leave comments.
Login now