The documentation for AMUSE is generated from ReStructured Text using the Sphinx documentation generation tool.
Itβs easiest to install the required packages using Conda:
conda install jupyter sphinx make numpy sphinx_rtd_theme matplotlib rst2pdf
The documentation sources are found in the doc/ directory in the trunk.
To build the AMUSE documentation in html format, cd into doc/ and
do:
make html
You can also pass a pdflatex flag to make to build a pdf, or pass no
arguments to show help information.
The output produced by Sphinx can be configured by editing the conf.py
file located in the doc/.
The actual ReStructured Text files are kept in doc/install,
doc/developing, doc/tutorial and doc/interactive_tutorial. The
main entry point is doc/index.rst. The documentation suite is built as a single
document in order to make the most effective use of cross referencing, we want to make
navigating the AMUSE documentation as easy as possible.
Additional files can be added to the various sections by including their base file name (the .rst extension is not necessary) in the table of contents.