We use Sphinx and restructured text (rst) for building the documentation pages. Detailed documentation of the package is built from mark-up docstrings in the source code.
To install the pyam package and all dependencies, run the following (in the top-level directory of this repository).
pip install --editable .[docs,tutorials]
There are a number of guides to get started, for example on sourceforge.
On *nix, from the command line, run::
make html
On Windows, from the command line, run::
./make.bat
The rendered html pages will be located in doc/build/html/index.html.