README.rst
35 lines
| 1.1 KiB
| text/x-rst
|
RstLexer
/ docs / README.rst
Paul Ivanov
|
r12939 | IPython Documentation | ||
| --------------------- | ||||
fperez
|
r0 | |||
|
Paul Ivanov
|
r12939 | This directory contains the majority of the documentation for IPython. | ||
| Requirements | ||||
| ------------ | ||||
| The following tools are needed to build the documentation: | ||||
Jonathan Frederic
|
r19503 | sphinx jsdoc | ||
|
Paul Ivanov
|
r12939 | |||
| On Debian-based systems, you should be able to run:: | ||||
|
Jonathan Frederic
|
r19504 | sudo apt-get install python-sphinx npm | ||
|
Jonathan Frederic
|
r19503 | sudo npm install -g jsdoc@"<=3.3.0" | ||
|
Paul Ivanov
|
r12939 | |||
| The documentation gets built using ``make``, and comes in several flavors. | ||||
|
Jonathan Frederic
|
r19504 | ``make html`` - build the API (both Javascript and Python) and narrative | ||
| documentation web pages, this is the the default ``make`` target, so | ||||
| running just ``make`` is equivalent to ``make html``. | ||||
|
Paul Ivanov
|
r12939 | |||
| ``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 | ||||
| API documentation. This build target skips that. | ||||
|
Jonathan Frederic
|
r19504 | ``make jsapi`` - build Javascript auto-generated API documents. | ||
|
Paul Ivanov
|
r12939 | ``make pdf`` will compile a pdf from the documentation. | ||
| You can run ``make help`` to see information on all possible make targets. | ||||
|
fperez
|
r0 | |||