Skip to content

Commit

Permalink
Various tweaks to documentation and formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
takluyver committed Feb 14, 2011
1 parent a1fc350 commit 1adf6b1
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions docs/source/development/doc_guide.txt
Expand Up @@ -140,18 +140,20 @@ The built docs are stored in a separate repository. Through some github magic,
they're automatically exposed as a website. It works like this:

- You will need to have sphinx and latex installed. In Ubuntu, install
`python-sphinx`, `texlive-latex-recommended`, `texlive-latex-extra`,
`texlive-fonts-recommended`.
``texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended``.
Install the latest version of sphinx from PyPI (``pip install sphinx``).
- Ensure that the development version of IPython is the first in your system
path. You can either use a virtualenv, or modify your PYTHONPATH.
- Switch into the docs directory, and run `make gh-pages`. This will build your
updated docs as html and pdf, check out the latest version of the docs
repository, copy the built docs into it, and commit your changes.
- Switch into the docs directory, and run ``make gh-pages``. This will build
your updated docs as html and pdf, then automatically check out the latest
version of the docs repository, copy the built docs into it, and commit your
changes.
- Open the built docs in a web browser, and check that they're as expected.
- (If rebuilding dev, a duplicate version may have been added to the index.
Remove this from index.rst, then run `python build_index.py` to update
index.html. Commit the change.)
- Upload the docs with `git push`. This only works if you have write access to
- (If rebuilding the docs for the development version, it may have duplicated
the link to the development version in the homepage. Remove this from
index.rst, then run ``python build_index.py`` to update index.html. Commit the
change.)
- Upload the docs with ``git push``. This only works if you have write access to
the docs repository.

.. [reStructuredText] reStructuredText. http://docutils.sourceforge.net/rst.html
Expand Down

0 comments on commit 1adf6b1

Please sign in to comment.