Show More
@@ -1,14 +1,32 b'' | |||||
1 | Current version information |
|
1 | IPython Documentation | |
2 |
--------------------- |
|
2 | --------------------- | |
3 |
|
3 | |||
4 | Please open manual.pdf for a PDF version of IPython's user manual, or go to |
|
4 | This directory contains the majority of the documentation for IPython. | |
5 | the manual/ directory for an HTML version. |
|
5 | ||
|
6 | Requirements | |||
|
7 | ------------ | |||
|
8 | The following tools are needed to build the documentation: | |||
|
9 | ||||
|
10 | sphinx | |||
|
11 | ||||
|
12 | On Debian-based systems, you should be able to run:: | |||
|
13 | ||||
|
14 | sudo apt-get install sphinx | |||
|
15 | ||||
|
16 | The documentation gets built using ``make``, and comes in several flavors. | |||
|
17 | ||||
|
18 | ``make html`` - build the API and narrative documentation web pages, this | |||
|
19 | is the the default ``make`` target, so running just ``make`` is equivalent to | |||
|
20 | ``make html``. | |||
|
21 | ||||
|
22 | ``make html_noapi`` - same as above, but without running the auto-generated | |||
|
23 | API docs. When you are working on the narrative documentation, the most time | |||
|
24 | consuming portion of the build process is the processing and rending of the | |||
|
25 | API documentation. This build target skips that. | |||
|
26 | ||||
|
27 | ``make pdf`` will compile a pdf from the documentation. | |||
|
28 | ||||
|
29 | You can run ``make help`` to see information on all possible make targets. | |||
6 |
|
30 | |||
7 |
|
31 | |||
8 | Bugs and future developments |
|
|||
9 | ---------------------------- |
|
|||
10 |
|
32 | |||
11 | The new_design.pdf document is a description of the goals for IPython's future |
|
|||
12 | development. It includes a TODO/bugs section listing all currently known bugs |
|
|||
13 | in IPython. Please report any bug you encounter if it is not already listed |
|
|||
14 | there. |
|
General Comments 0
You need to be logged in to leave comments.
Login now