diff --git a/docs/README.rst b/docs/README.rst index 6a6745a..f0391fc 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -1,14 +1,32 @@ -Current version information ---------------------------- +IPython Documentation +--------------------- -Please open manual.pdf for a PDF version of IPython's user manual, or go to -the manual/ directory for an HTML version. +This directory contains the majority of the documentation for IPython. + +Requirements +------------ +The following tools are needed to build the documentation: + +sphinx + +On Debian-based systems, you should be able to run:: + + sudo apt-get install sphinx + +The documentation gets built using ``make``, and comes in several flavors. + +``make html`` - build the API and narrative documentation web pages, this +is the the default ``make`` target, so running just ``make`` is equivalent to +``make html``. + +``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. + +``make pdf`` will compile a pdf from the documentation. + +You can run ``make help`` to see information on all possible make targets. -Bugs and future developments ----------------------------- -The new_design.pdf document is a description of the goals for IPython's future -development. It includes a TODO/bugs section listing all currently known bugs -in IPython. Please report any bug you encounter if it is not already listed -there.