##// END OF EJS Templates
Use * for bullets instead of -
Thomas Kluyver -
Show More
@@ -139,21 +139,21 b' Building and uploading'
139 The built docs are stored in a separate repository. Through some github magic,
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:
140 they're automatically exposed as a website. It works like this:
141
141
142 - You will need to have sphinx and latex installed. In Ubuntu, install
142 * You will need to have sphinx and latex installed. In Ubuntu, install
143 ``texlive-latex-recommended texlive-latex-extra 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``).
144 Install the latest version of sphinx from PyPI (``pip install sphinx``).
145 - Ensure that the development version of IPython is the first in your system
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.
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
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
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
149 version of the docs repository, copy the built docs into it, and commit your
150 changes.
150 changes.
151 - Open the built docs in a web browser, and check that they're as expected.
151 * Open the built docs in a web browser, and check that they're as expected.
152 - (If rebuilding the docs for the development version, it may have duplicated
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
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
154 index.rst, then run ``python build_index.py`` to update index.html. Commit the
155 change.)
155 change.)
156 - Upload the docs with ``git push``. This only works if you have write access to
156 * Upload the docs with ``git push``. This only works if you have write access to
157 the docs repository.
157 the docs repository.
158
158
159 .. [reStructuredText] reStructuredText. http://docutils.sourceforge.net/rst.html
159 .. [reStructuredText] reStructuredText. http://docutils.sourceforge.net/rst.html
General Comments 0
You need to be logged in to leave comments. Login now