##// END OF EJS Templates
Improve local docs building docs to ensure all dependencies are installed.
Doug Latornell -
Show More
@@ -1,69 +1,64 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 In additions to :ref:`devinstall`,
20 the following tools are needed to build the documentation:
20
21
21 - sphinx
22 - sphinx
22 - sphinx_rtd_theme
23 - sphinx_rtd_theme
24 - docrepr
23
25
24 On Debian-based systems, you should be able to run::
26 In a conda environment, or a Python 3 ``venv``, you should be able to run::
25
27
26 sudo apt-get install python3-sphinx python3-sphinx-rtd-theme
28 cd ipython
27
29 pip install -U -r docs/requirements.txt
28 In a conda environment, you can use::
29
30 conda install sphinx sphinx_rtd_theme
31
32 In a Python 3 ``venv``, you should be able to run::
33
34 pip install -U sphinx sphinx_rtd_theme
35
30
36
31
37 Build Commands
32 Build Commands
38 --------------
33 --------------
39
34
40 The documentation gets built using ``make``, and comes in several flavors.
35 The documentation gets built using ``make``, and comes in several flavors.
41
36
42 ``make html`` - build the API and narrative documentation web pages, this is
37 ``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
38 the default ``make`` target, so running just ``make`` is equivalent to ``make
44 html``.
39 html``.
45
40
46 ``make html_noapi`` - same as above, but without running the auto-generated API
41 ``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
42 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
43 consuming portion of the build process is the processing and rending of the
49 API documentation. This build target skips that.
44 API documentation. This build target skips that.
50
45
51 ``make pdf`` will compile a pdf from the documentation.
46 ``make pdf`` will compile a pdf from the documentation.
52
47
53 You can run ``make help`` to see information on all possible make targets.
48 You can run ``make help`` to see information on all possible make targets.
54
49
55 To save time,
50 To save time,
56 the make targets above only proceess the files that have been changed since the
51 the make targets above only proceess the files that have been changed since the
57 previous docs build.
52 previous docs build.
58 To remove the previous docs build you can use ``make clean``.
53 To remove the previous docs build you can use ``make clean``.
59 You can also combine ``clean`` with other `make` commands;
54 You can also combine ``clean`` with other `make` commands;
60 for example,
55 for example,
61 ``make clean html`` will do a complete rebuild of the docs or `make clean pdf` will do a complete build of the pdf.
56 ``make clean html`` will do a complete rebuild of the docs or `make clean pdf` will do a complete build of the pdf.
62
57
63
58
64 Continuous Integration
59 Continuous Integration
65 ----------------------
60 ----------------------
66
61
67 Documentation builds are included in the Travis-CI continuous integration process,
62 Documentation builds are included in the Travis-CI continuous integration process,
68 so you can see the results of the docs build for any pull request at
63 so you can see the results of the docs build for any pull request at
69 https://travis-ci.org/ipython/ipython/pull_requests.
64 https://travis-ci.org/ipython/ipython/pull_requests.
General Comments 0
You need to be logged in to leave comments. Login now