Show More
@@ -110,7 +110,10 b" if __name__ == '__main__':" | |||||
110 | try: |
|
110 | try: | |
111 | tag = sys.argv[1] |
|
111 | tag = sys.argv[1] | |
112 | except IndexError: |
|
112 | except IndexError: | |
113 | tag = sh2('git describe') |
|
113 | try: | |
|
114 | tag = sh2('git describe') | |||
|
115 | except CalledProcessError: | |||
|
116 | tag = "dev" # Fallback | |||
114 |
|
117 | |||
115 | try: |
|
118 | try: | |
116 | desc = sys.argv[2] |
|
119 | desc = sys.argv[2] |
@@ -133,6 +133,28 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 | ``texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended``. | |||
|
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 | |||
|
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 | 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. | |||
|
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 | |||
|
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 | |||
|
157 | the docs repository. | |||
136 |
|
158 | |||
137 | .. [reStructuredText] reStructuredText. http://docutils.sourceforge.net/rst.html |
|
159 | .. [reStructuredText] reStructuredText. http://docutils.sourceforge.net/rst.html | |
138 | .. [Sphinx] Sphinx. http://sphinx.pocoo.org/ |
|
160 | .. [Sphinx] Sphinx. http://sphinx.pocoo.org/ |
General Comments 0
You need to be logged in to leave comments.
Login now