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
|
##########################
Transforms3d documentation
##########################
This is the top level build directory for the transforms3d documentation. All
of the documentation is written using Sphinx_, a Python documentation system
built on top of reST_. In order to build the documentation, you must have
Sphinx v1.0 or greater installed.
This directory contains:
* Makefile - the build script to build the HTML or PDF docs. Type
``make help`` for a list of options.
* links_names.inc - reST document with hyperlink targets for common links used
throughout the documentation
* conf.py - the sphinx configuration.
* _static - used by the sphinx build system.
* _templates - used by the sphinx build system.
Building the documentation
--------------------------
You should first install the documentation dependencies. From this directory::
pip install -r ../doc-requirements.txt
Then::
make html
.. 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
|
