##// END OF EJS Templates
Update docs/README.rst
Matthias Bussonnier -
Show More
@@ -1,64 +1,64 b''
1 1 IPython Documentation
2 2 ---------------------
3 3
4 4 This directory contains the majority of the documentation for IPython.
5 5
6 6
7 7 Deploy docs
8 8 -----------
9 9
10 10 Documentation is automatically deployed on ReadTheDocs on every push or merged
11 11 Pull requests.
12 12
13 13
14 14 Requirements
15 15 ------------
16 16
17 17 The documentation must be built using Python 3.
18 18
19 In addition to :ref:``devinstall``,
19 In addition to :ref:`devinstall`,
20 20 the following tools are needed to build the documentation:
21 21
22 22 - sphinx
23 23 - sphinx_rtd_theme
24 24 - docrepr
25 25
26 26 In a conda environment, or a Python 3 ``venv``, you should be able to run::
27 27
28 28 cd ipython
29 29 pip install -U -r docs/requirements.txt
30 30
31 31
32 32 Build Commands
33 33 --------------
34 34
35 35 The documentation gets built using ``make``, and comes in several flavors.
36 36
37 37 ``make html`` - build the API and narrative documentation web pages, this is
38 38 the default ``make`` target, so running just ``make`` is equivalent to ``make
39 39 html``.
40 40
41 41 ``make html_noapi`` - same as above, but without running the auto-generated API
42 42 docs. When you are working on the narrative documentation, the most time
43 43 consuming portion of the build process is the processing and rendering of the
44 44 API documentation. This build target skips that.
45 45
46 46 ``make pdf`` will compile a pdf from the documentation.
47 47
48 48 You can run ``make help`` to see information on all possible make targets.
49 49
50 50 To save time,
51 51 the make targets above only process the files that have been changed since the
52 52 previous docs build.
53 53 To remove the previous docs build you can use ``make clean``.
54 54 You can also combine ``clean`` with other `make` commands;
55 55 for example,
56 56 ``make clean html`` will do a complete rebuild of the docs or ``make clean pdf`` will do a complete build of the pdf.
57 57
58 58
59 59 Continuous Integration
60 60 ----------------------
61 61
62 62 Documentation builds are included in the Travis-CI continuous integration process,
63 63 so you can see the results of the docs build for any pull request at
64 64 https://travis-ci.org/ipython/ipython/pull_requests.
General Comments 0
You need to be logged in to leave comments. Login now