behnam-zakeri / message_doc

Documentation for the MESSAGEix-GLOBIOM model

MESSAGE Ecosystem Documentation

Dependencies

1. Sphinx v1.1.2 or higher
2. sphinxcontrib-bibtex

Writing in Restructed Text

There are a number of guides out there, e.g.

• sphinx
• docutils

Adding Citations

The main citation file is bibs/main.bib. To learn how to cite those references, you can read the appropriate documentation.

Adding Packages for Latex

Sometimes building latex requires the addition of usepackage{} statements. These can be added at the [preamble line](https://github.com/iiasa/message_doc/blob/master/source/conf.py#L223) in source/conf.py.

Building the Site

On *nix, from the command line, run:

make html

On Windows, from the command line, run:

./make.bat html

View the Site Locally

On *nix, from the command line, run:

make serve

On Windows, from the command line, run:

./make.bat serve

You can then view the site by pointing your browser at http://localhost:8000/

Automatically Update Website after Changing Files

If you have sphinx-autobuild installed, you make get an auto-updating local website by

make livehtml

or

./make.bat livehtml

Again, point your browser to http://localhost:8000/