##// END OF EJS Templates
Add note about docs build inclusion in Travis-CI builds.
Doug Latornell -
Show More
@@ -1,53 +1,61 b''
1 IPython Documentation
1 IPython Documentation
2 ---------------------
2 ---------------------
3
3
4 This directory contains the majority of the documentation for IPython.
4 This directory contains the majority of the documentation for IPython.
5
5
6
6
7 Deploy docs
7 Deploy docs
8 -----------
8 -----------
9
9
10 Documentation is automatically deployed on ReadTheDocs on every push or merged
10 Documentation is automatically deployed on ReadTheDocs on every push or merged
11 Pull requests.
11 Pull requests.
12
12
13
13
14 Requirements
14 Requirements
15 ------------
15 ------------
16
16
17 The documentation must be built using Python 3.
17 The documentation must be built using Python 3.
18
18
19 The following tools are needed to build the documentation:
19 The following tools are needed to build the documentation:
20
20
21 - sphinx
21 - sphinx
22 - sphinx_rtd_theme
22 - sphinx_rtd_theme
23
23
24 On Debian-based systems, you should be able to run::
24 On Debian-based systems, you should be able to run::
25
25
26 sudo apt-get install python3-sphinx python3-sphinx-rtd-theme
26 sudo apt-get install python3-sphinx python3-sphinx-rtd-theme
27
27
28 In a conda environment, you can use::
28 In a conda environment, you can use::
29
29
30 conda install sphinx sphinx_rtd_theme
30 conda install sphinx sphinx_rtd_theme
31
31
32 In a Python 3 ``venv``, you should be able to run::
32 In a Python 3 ``venv``, you should be able to run::
33
33
34 pip install -U sphinx sphinx_rtd_theme
34 pip install -U sphinx sphinx_rtd_theme
35
35
36
36
37 Build Commands
37 Build Commands
38 --------------
38 --------------
39
39
40 The documentation gets built using ``make``, and comes in several flavors.
40 The documentation gets built using ``make``, and comes in several flavors.
41
41
42 ``make html`` - build the API and narrative documentation web pages, this is
42 ``make html`` - build the API and narrative documentation web pages, this is
43 the default ``make`` target, so running just ``make`` is equivalent to ``make
43 the default ``make`` target, so running just ``make`` is equivalent to ``make
44 html``.
44 html``.
45
45
46 ``make html_noapi`` - same as above, but without running the auto-generated API
46 ``make html_noapi`` - same as above, but without running the auto-generated API
47 docs. When you are working on the narrative documentation, the most time
47 docs. When you are working on the narrative documentation, the most time
48 consuming portion of the build process is the processing and rending of the
48 consuming portion of the build process is the processing and rending of the
49 API documentation. This build target skips that.
49 API documentation. This build target skips that.
50
50
51 ``make pdf`` will compile a pdf from the documentation.
51 ``make pdf`` will compile a pdf from the documentation.
52
52
53 You can run ``make help`` to see information on all possible make targets.
53 You can run ``make help`` to see information on all possible make targets.
54
55
56 Continuous Integration
57 ----------------------
58
59 Documentation builds are included in the Travis-CI continuous integration process,
60 so you can see the results of the docs build for any pull request at
61 https://travis-ci.org/ipython/ipython/pull_requests.
General Comments 0
You need to be logged in to leave comments. Login now