1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
====================
Nipy Documentation
====================
This is the top level build directory for the nipy documentation. All
of the documentation is written using Sphinx_, a python documentation
system built on top of reST_.
Dependencies
============
In order to build the documentation,
you must have:
* Sphinx 1.0 or greater
* nipy and all its dependencies so that nipy can import
* matplotlib
* latex (for the PNG mathematics graphics)
* graphviz (for the inheritance diagrams)
For the Python dependencies, do::
pip install -r ../doc-requirements.txt
Files and directories
=====================
This directory contains:
* Makefile - the build script to build the HTML or PDF docs. Type
``make help`` for a list of options.
* users - the user documentation.
* devel - documentation for developers.
* faq - frequently asked questions
* api - placeholders to automatically generate the api documentation
* www - source files for website only reST documentss which should not
go in the generated PDF documentation.
* links_names.txt - reST document with hyperlink targets for common
links used throughout the documentation
* .rst files - some top-level documentation source files
* conf.py - the sphinx configuration.
* sphinxext - some extensions to sphinx to handle math, ipython syntax
highlighting, numpy_ docstring
parsing, and autodocs.
* _static - used by the sphinx build system.
* _templates - used by the sphinx build system.
Building the documentation
--------------------------
Instructions for building the documentation are in the file:
``devel/guidelines/howto_document.rst``
.. Since this README.txt is not processed by Sphinx during the
.. documentation build, I've included the links directly so it is at
.. least a valid reST doc.
.. _Sphinx: http://sphinx.pocoo.org/
.. _reST: http://docutils.sourceforge.net/rst.html
.. _numpy: http://www.scipy.org/NumPy
.. vim: ft=rst
|
