upstream/ipython Commit - r26052:bdf42864

16

17

The documentation must be built using Python 3.

17

The documentation must be built using Python 3.

18

19

In additions to :ref:`devinstall`,

19

In addition to :ref:``devinstall``,

20

the following tools are needed to build the documentation:

20

the following tools are needed to build the documentation:

21

22

- sphinx

22

- sphinx

40

41

``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

42

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

43

consuming portion of the build process is the processing and rending of the

43

consuming portion of the build process is the processing and rendering of the

44

API documentation. This build target skips that.

44

API documentation. This build target skips that.

45

46

``make pdf`` will compile a pdf from the documentation.

46

``make pdf`` will compile a pdf from the documentation.

53

To remove the previous docs build you can use ``make clean``.

53

To remove the previous docs build you can use ``make clean``.

54

You can also combine ``clean`` with other `make` commands;

54

You can also combine ``clean`` with other `make` commands;

55

for example,

55

for example,

56

``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.

57

58

59

Continuous Integration

59

Continuous Integration

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

             The documentation must be built using Python 3.
-            In additions to :ref:`devinstall`,
+            In addition to :ref:``devinstall``,
             the following tools are needed to build the documentation:
              - sphinx
             ``make html_noapi`` - same as above, but without running the auto-generated API
             docs. When you are working on the narrative documentation, the most time
-            consuming portion  of the build process is the processing and rending of the
+            consuming portion  of the build process is the processing and rendering of the
             API documentation. This build target skips that.
             ``make pdf`` will compile a pdf from the documentation.
             To remove the previous docs build you can use ``make clean``.
             You can also combine ``clean`` with other `make` commands;
             for example,
-            ``make clean html`` will do a complete rebuild of the docs or `make clean pdf` will do a complete build of the pdf.
+            ``make clean html`` will do a complete rebuild of the docs or ``make clean pdf`` will do a complete build of the pdf.
             Continuous Integration