Read the Docs build information
Build id: 486734
Project: iiasa-energy-program-message-ix
Version: latest
Commit: 538e1ef24f06790ca0c33516b79da970ae40a77b
Date: 2020-11-22T15:48:50.079008Z
State: finished
Success: True


[rtd-command-info] start-time: 2020-11-22T15:48:51.717508Z, end-time: 2020-11-22T15:48:52.697451Z, duration: 0, exit-code: 0
git clone --no-single-branch --depth 50 https://github.com/iiasa/message_ix.git .
Cloning into '.'...

[rtd-command-info] start-time: 2020-11-22T15:48:53.053085Z, end-time: 2020-11-22T15:48:53.142851Z, duration: 0, exit-code: 0
git checkout --force origin/master
Note: checking out 'origin/master'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by performing another checkout.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -b with the checkout command again. Example:

  git checkout -b <new-branch-name>

HEAD is now at 538e1ef Merge pull request #425 from iiasa/issue/424

[rtd-command-info] start-time: 2020-11-22T15:48:53.338944Z, end-time: 2020-11-22T15:48:53.393295Z, duration: 0, exit-code: 0
git clean -d -f -f


[rtd-command-info] start-time: 2020-11-22T15:48:54.663561Z, end-time: 2020-11-22T15:48:58.507824Z, duration: 3, exit-code: 0
python3.7 -mvirtualenv 
Using base prefix '/home/docs/.pyenv/versions/3.7.9'
New python executable in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/bin/python3.7
Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/bin/python
Installing setuptools, pip, wheel...
done.

[rtd-command-info] start-time: 2020-11-22T15:48:58.910356Z, end-time: 2020-11-22T15:48:59.576870Z, duration: 0, exit-code: 0
python -m pip install --upgrade --no-cache-dir pip
Requirement already up-to-date: pip in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/lib/python3.7/site-packages (20.2.4)

[rtd-command-info] start-time: 2020-11-22T15:48:59.689785Z, end-time: 2020-11-22T15:49:07.968095Z, duration: 8, exit-code: 0
python -m pip install --upgrade --no-cache-dir setuptools==41.0.1 docutils==0.14 mock==1.0.1 pillow==5.4.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.8.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<2.2
Collecting setuptools==41.0.1
  Downloading setuptools-41.0.1-py2.py3-none-any.whl (575 kB)
Collecting docutils==0.14
  Downloading docutils-0.14-py3-none-any.whl (543 kB)
Collecting mock==1.0.1
  Downloading mock-1.0.1.tar.gz (818 kB)
Collecting pillow==5.4.1
  Downloading Pillow-5.4.1-cp37-cp37m-manylinux1_x86_64.whl (2.0 MB)
Collecting alabaster!=0.7.5,<0.8,>=0.7
  Downloading alabaster-0.7.12-py2.py3-none-any.whl (14 kB)
Collecting commonmark==0.8.1
  Downloading commonmark-0.8.1-py2.py3-none-any.whl (47 kB)
Collecting recommonmark==0.5.0
  Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB)
Collecting sphinx<2
  Downloading Sphinx-1.8.5-py2.py3-none-any.whl (3.1 MB)
Collecting sphinx-rtd-theme<0.5
  Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB)
Collecting readthedocs-sphinx-ext<2.2
  Downloading readthedocs_sphinx_ext-2.1.1-py2.py3-none-any.whl (13 kB)
Collecting future
  Downloading future-0.18.2.tar.gz (829 kB)
Collecting imagesize
  Downloading imagesize-1.2.0-py2.py3-none-any.whl (4.8 kB)
Collecting Jinja2>=2.3
  Downloading Jinja2-2.11.2-py2.py3-none-any.whl (125 kB)
Collecting six>=1.5
  Downloading six-1.15.0-py2.py3-none-any.whl (10 kB)
Collecting babel!=2.0,>=1.3
  Downloading Babel-2.9.0-py2.py3-none-any.whl (8.8 MB)
Collecting snowballstemmer>=1.1
  Downloading snowballstemmer-2.0.0-py2.py3-none-any.whl (97 kB)
Collecting requests>=2.0.0
  Downloading requests-2.25.0-py2.py3-none-any.whl (61 kB)
Collecting sphinxcontrib-websupport
  Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB)
Collecting Pygments>=2.0
  Downloading Pygments-2.7.2-py3-none-any.whl (948 kB)
Collecting packaging
  Downloading packaging-20.4-py2.py3-none-any.whl (37 kB)
Collecting MarkupSafe>=0.23
  Downloading MarkupSafe-1.1.1-cp37-cp37m-manylinux1_x86_64.whl (27 kB)
Collecting pytz>=2015.7
  Downloading pytz-2020.4-py2.py3-none-any.whl (509 kB)
Collecting urllib3<1.27,>=1.21.1
  Downloading urllib3-1.26.2-py2.py3-none-any.whl (136 kB)
Collecting chardet<4,>=3.0.2
  Downloading chardet-3.0.4-py2.py3-none-any.whl (133 kB)
Collecting idna<3,>=2.5
  Downloading idna-2.10-py2.py3-none-any.whl (58 kB)
Collecting certifi>=2017.4.17
  Downloading certifi-2020.11.8-py2.py3-none-any.whl (155 kB)
Collecting sphinxcontrib-serializinghtml
  Downloading sphinxcontrib_serializinghtml-1.1.4-py2.py3-none-any.whl (89 kB)
Collecting pyparsing>=2.0.2
  Downloading pyparsing-2.4.7-py2.py3-none-any.whl (67 kB)
Building wheels for collected packages: mock, future
  Building wheel for mock (setup.py): started
  Building wheel for mock (setup.py): finished with status 'done'
  Created wheel for mock: filename=mock-1.0.1-py3-none-any.whl size=23754 sha256=b8f7051ff24f71da71a7ec9bb6558b7756b097b234b077dc0fd0dc2ea0c24262
  Stored in directory: /tmp/pip-ephem-wheel-cache-h_wh2_ph/wheels/16/03/37/f0a64ab894c9102906f192db1a4071b7592292ad661563c69b
  Building wheel for future (setup.py): started
  Building wheel for future (setup.py): finished with status 'done'
  Created wheel for future: filename=future-0.18.2-py3-none-any.whl size=491059 sha256=a9850ab5aef4d64fe159887dfe8c02cb2a92bc6a117c038380b6d7133a834276
  Stored in directory: /tmp/pip-ephem-wheel-cache-h_wh2_ph/wheels/56/b0/fe/4410d17b32f1f0c3cf54cdfb2bc04d7b4b8f4ae377e2229ba0
Successfully built mock future
Installing collected packages: setuptools, docutils, mock, pillow, alabaster, future, commonmark, imagesize, MarkupSafe, Jinja2, six, pytz, babel, snowballstemmer, urllib3, chardet, idna, certifi, requests, sphinxcontrib-serializinghtml, sphinxcontrib-websupport, Pygments, pyparsing, packaging, sphinx, recommonmark, sphinx-rtd-theme, readthedocs-sphinx-ext
  Attempting uninstall: setuptools
    Found existing installation: setuptools 50.3.2
    Uninstalling setuptools-50.3.2:
      Successfully uninstalled setuptools-50.3.2
Successfully installed Jinja2-2.11.2 MarkupSafe-1.1.1 Pygments-2.7.2 alabaster-0.7.12 babel-2.9.0 certifi-2020.11.8 chardet-3.0.4 commonmark-0.8.1 docutils-0.14 future-0.18.2 idna-2.10 imagesize-1.2.0 mock-1.0.1 packaging-20.4 pillow-5.4.1 pyparsing-2.4.7 pytz-2020.4 readthedocs-sphinx-ext-2.1.1 recommonmark-0.5.0 requests-2.25.0 setuptools-41.0.1 six-1.15.0 snowballstemmer-2.0.0 sphinx-1.8.5 sphinx-rtd-theme-0.4.3 sphinxcontrib-serializinghtml-1.1.4 sphinxcontrib-websupport-1.2.4 urllib3-1.26.2

[rtd-command-info] start-time: 2020-11-22T15:49:08.119605Z, end-time: 2020-11-22T15:49:30.483351Z, duration: 22, exit-code: 0
python -m pip install --upgrade --upgrade-strategy eager --no-cache-dir .[docs]
Processing /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/checkouts/latest
Collecting click
  Downloading click-7.1.2-py2.py3-none-any.whl (82 kB)
Collecting ixmp>=3.1.0
  Downloading ixmp-3.1.0-py3-none-any.whl (16.7 MB)
Collecting numpy
  Downloading numpy-1.19.4-cp37-cp37m-manylinux2010_x86_64.whl (14.5 MB)
Collecting pandas
  Downloading pandas-1.1.4-cp37-cp37m-manylinux1_x86_64.whl (9.5 MB)
Collecting PyYAML
  Downloading PyYAML-5.3.1.tar.gz (269 kB)
Collecting xlrd
  Downloading xlrd-1.2.0-py2.py3-none-any.whl (103 kB)
Collecting numpydoc
  Downloading numpydoc-1.1.0-py3-none-any.whl (47 kB)
Collecting sphinx>=3.0
  Downloading Sphinx-3.3.1-py3-none-any.whl (2.9 MB)
Collecting sphinx_rtd_theme
  Downloading sphinx_rtd_theme-0.5.0-py2.py3-none-any.whl (10.8 MB)
Collecting sphinxcontrib-bibtex
  Downloading sphinxcontrib_bibtex-1.0.0-py3-none-any.whl (14 kB)
Collecting pint
  Downloading Pint-0.16.1-py2.py3-none-any.whl (205 kB)
Collecting xarray
  Downloading xarray-0.16.1-py3-none-any.whl (720 kB)
Collecting graphviz
  Downloading graphviz-0.15-py2.py3-none-any.whl (18 kB)
Collecting sparse>=0.10
  Downloading sparse-0.11.2-py2.py3-none-any.whl (73 kB)
Collecting xlsxwriter
  Downloading XlsxWriter-1.3.7-py2.py3-none-any.whl (144 kB)
Collecting dask[array]>=2.14
  Downloading dask-2.30.0-py3-none-any.whl (848 kB)
Collecting JPype1>=0.7.5
  Downloading JPype1-1.1.2-cp37-cp37m-manylinux2010_x86_64.whl (450 kB)
Collecting python-dateutil>=2.7.3
  Downloading python_dateutil-2.8.1-py2.py3-none-any.whl (227 kB)
Requirement already up-to-date: pytz>=2017.2 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/lib/python3.7/site-packages (from pandas->message-ix==3.1.1.dev15+g538e1ef) (2020.4)
Requirement already up-to-date: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/lib/python3.7/site-packages (from numpydoc->message-ix==3.1.1.dev15+g538e1ef) (2.11.2)
Requirement already up-to-date: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/lib/python3.7/site-packages (from sphinx>=3.0->message-ix==3.1.1.dev15+g538e1ef) (1.2.0)
Requirement already up-to-date: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/lib/python3.7/site-packages (from sphinx>=3.0->message-ix==3.1.1.dev15+g538e1ef) (0.7.12)
Collecting sphinxcontrib-jsmath
  Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB)
Requirement already up-to-date: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/lib/python3.7/site-packages (from sphinx>=3.0->message-ix==3.1.1.dev15+g538e1ef) (2.7.2)
Requirement already up-to-date: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/lib/python3.7/site-packages (from sphinx>=3.0->message-ix==3.1.1.dev15+g538e1ef) (2.25.0)
Requirement already up-to-date: sphinxcontrib-serializinghtml in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/lib/python3.7/site-packages (from sphinx>=3.0->message-ix==3.1.1.dev15+g538e1ef) (1.1.4)
Collecting setuptools
  Downloading setuptools-50.3.2-py3-none-any.whl (785 kB)
Requirement already up-to-date: babel>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/lib/python3.7/site-packages (from sphinx>=3.0->message-ix==3.1.1.dev15+g538e1ef) (2.9.0)
Collecting docutils>=0.12
  Downloading docutils-0.16-py2.py3-none-any.whl (548 kB)
Requirement already up-to-date: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/lib/python3.7/site-packages (from sphinx>=3.0->message-ix==3.1.1.dev15+g538e1ef) (2.0.0)
Collecting sphinxcontrib-applehelp
  Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB)
Collecting sphinxcontrib-devhelp
  Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB)
Collecting sphinxcontrib-htmlhelp
  Downloading sphinxcontrib_htmlhelp-1.0.3-py2.py3-none-any.whl (96 kB)
Requirement already up-to-date: packaging in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/lib/python3.7/site-packages (from sphinx>=3.0->message-ix==3.1.1.dev15+g538e1ef) (20.4)
Collecting sphinxcontrib-qthelp
  Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB)
Collecting oset>=0.1.3
  Downloading oset-0.1.3.tar.gz (7.3 kB)
Collecting pybtex>=0.20
  Downloading pybtex-0.23.0-py2.py3-none-any.whl (279 kB)
Collecting pybtex-docutils>=0.2.0
  Downloading pybtex_docutils-0.2.2-py2.py3-none-any.whl (4.6 kB)
Collecting importlib-metadata; python_version < "3.8"
  Downloading importlib_metadata-2.0.0-py2.py3-none-any.whl (31 kB)
Collecting numba>=0.49
  Downloading numba-0.51.2-cp37-cp37m-manylinux2014_x86_64.whl (3.1 MB)
Collecting scipy>=0.19
  Downloading scipy-1.5.4-cp37-cp37m-manylinux1_x86_64.whl (25.9 MB)
Collecting toolz>=0.8.2; extra == "array"
  Downloading toolz-0.11.1-py3-none-any.whl (55 kB)
Collecting typing-extensions; python_version < "3.8"
  Downloading typing_extensions-3.7.4.3-py3-none-any.whl (22 kB)
Requirement already up-to-date: six>=1.5 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/lib/python3.7/site-packages (from python-dateutil>=2.7.3->pandas->message-ix==3.1.1.dev15+g538e1ef) (1.15.0)
Requirement already up-to-date: MarkupSafe>=0.23 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/lib/python3.7/site-packages (from Jinja2>=2.3->numpydoc->message-ix==3.1.1.dev15+g538e1ef) (1.1.1)
Requirement already up-to-date: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx>=3.0->message-ix==3.1.1.dev15+g538e1ef) (2020.11.8)
Requirement already up-to-date: chardet<4,>=3.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx>=3.0->message-ix==3.1.1.dev15+g538e1ef) (3.0.4)
Requirement already up-to-date: urllib3<1.27,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx>=3.0->message-ix==3.1.1.dev15+g538e1ef) (1.26.2)
Requirement already up-to-date: idna<3,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx>=3.0->message-ix==3.1.1.dev15+g538e1ef) (2.10)
Requirement already up-to-date: pyparsing>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/latest/lib/python3.7/site-packages (from packaging->sphinx>=3.0->message-ix==3.1.1.dev15+g538e1ef) (2.4.7)
Collecting latexcodec>=1.0.4
  Downloading latexcodec-2.0.1-py2.py3-none-any.whl (18 kB)
Collecting zipp>=0.5
  Downloading zipp-3.4.0-py3-none-any.whl (5.2 kB)
Collecting llvmlite<0.35,>=0.34.0.dev0
  Downloading llvmlite-0.34.0-cp37-cp37m-manylinux2010_x86_64.whl (24.6 MB)
Building wheels for collected packages: message-ix, PyYAML, oset
  Building wheel for message-ix (setup.py): started
  Building wheel for message-ix (setup.py): finished with status 'done'
  Created wheel for message-ix: filename=message_ix-3.1.1.dev15+g538e1ef-py3-none-any.whl size=221221 sha256=1be2605725291875c6fa6f511b5f88ad6072330f4be6f184a830e42ada2bb647
  Stored in directory: /tmp/pip-ephem-wheel-cache-9ritxmaq/wheels/d0/db/a2/e255e2e896accb1a909485f26133cec7f8bf1a3d84907b4081
  Building wheel for PyYAML (setup.py): started
  Building wheel for PyYAML (setup.py): finished with status 'done'
  Created wheel for PyYAML: filename=PyYAML-5.3.1-cp37-cp37m-linux_x86_64.whl size=44619 sha256=67032bf5ef3f08e1e6d985a862162e17fffd95adf5dd1f9cda00b21bbb068b2a
  Stored in directory: /tmp/pip-ephem-wheel-cache-9ritxmaq/wheels/5e/03/1e/e1e954795d6f35dfc7b637fe2277bff021303bd9570ecea653
  Building wheel for oset (setup.py): started
  Building wheel for oset (setup.py): finished with status 'done'
  Created wheel for oset: filename=oset-0.1.3-py3-none-any.whl size=9660 sha256=7bff4d96553e661e8882ad567a4a9d724882ca73191705bda29fa7c58f09fa5a
  Stored in directory: /tmp/pip-ephem-wheel-cache-9ritxmaq/wheels/d3/97/cf/cfafe0bedac445a9492baca15b27f8afb4693182b00a975ac7
Successfully built message-ix PyYAML oset
Installing collected packages: click, numpy, python-dateutil, pandas, PyYAML, zipp, importlib-metadata, pint, setuptools, xarray, xlrd, graphviz, llvmlite, numba, scipy, sparse, xlsxwriter, toolz, dask, typing-extensions, JPype1, ixmp, sphinxcontrib-jsmath, docutils, sphinxcontrib-applehelp, sphinxcontrib-devhelp, sphinxcontrib-htmlhelp, sphinxcontrib-qthelp, sphinx, numpydoc, sphinx-rtd-theme, oset, latexcodec, pybtex, pybtex-docutils, sphinxcontrib-bibtex, message-ix
  Attempting uninstall: setuptools
    Found existing installation: setuptools 41.0.1
    Uninstalling setuptools-41.0.1:
      Successfully uninstalled setuptools-41.0.1
  Attempting uninstall: docutils
    Found existing installation: docutils 0.14
    Uninstalling docutils-0.14:
      Successfully uninstalled docutils-0.14
  Attempting uninstall: sphinx
    Found existing installation: Sphinx 1.8.5
    Uninstalling Sphinx-1.8.5:
      Successfully uninstalled Sphinx-1.8.5
  Attempting uninstall: sphinx-rtd-theme
    Found existing installation: sphinx-rtd-theme 0.4.3
    Uninstalling sphinx-rtd-theme-0.4.3:
      Successfully uninstalled sphinx-rtd-theme-0.4.3
Successfully installed JPype1-1.1.2 PyYAML-5.3.1 click-7.1.2 dask-2.30.0 docutils-0.16 graphviz-0.15 importlib-metadata-2.0.0 ixmp-3.1.0 latexcodec-2.0.1 llvmlite-0.34.0 message-ix-3.1.1.dev15+g538e1ef numba-0.51.2 numpy-1.19.4 numpydoc-1.1.0 oset-0.1.3 pandas-1.1.4 pint-0.16.1 pybtex-0.23.0 pybtex-docutils-0.2.2 python-dateutil-2.8.1 scipy-1.5.4 setuptools-50.3.2 sparse-0.11.2 sphinx-3.3.1 sphinx-rtd-theme-0.5.0 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-bibtex-1.0.0 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-1.0.3 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 toolz-0.11.1 typing-extensions-3.7.4.3 xarray-0.16.1 xlrd-1.2.0 xlsxwriter-1.3.7 zipp-3.4.0

[rtd-command-info] start-time: 2020-11-22T15:49:32.060500Z, end-time: 2020-11-22T15:49:32.135267Z, duration: 0, exit-code: 0
cat doc/source/conf.py
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.

import os
from pathlib import Path
import sys

from pkg_resources import get_distribution

sys.path.insert(0, os.path.abspath('..'))


# -- Project information -----------------------------------------------------

project = 'MESSAGEix'
copyright = '2020, IIASA Energy Program'
author = 'MESSAGEix Developers'

# The major project version, used as the replacement for |version|.
version = get_distribution("message_ix").version
# The full project version, used as the replacement for |release| and e.g. in
# the HTML templates.
release = version


# -- General configuration ----------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.doctest',
    'sphinx.ext.extlinks',
    'sphinx.ext.intersphinx',
    'sphinx.ext.todo',
    'sphinx.ext.coverage',
    'sphinx.ext.mathjax',
    'sphinxcontrib.bibtex',
    'sphinx.ext.autosummary',
    'sphinx.ext.napoleon',
    'grab_gams_doc'
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_themes/*']


# A string of reStructuredText that will be included at the beginning of every
# source file that is read.
rst_prolog = r"""
.. |MESSAGEix| replace:: MESSAGE\ :emphasis:`ix`

.. |ixmp| replace:: :emphasis:`ix` modeling platform

.. |IIASA| raw:: html

   <abbr title="International Institute for Applied Systems Analysis">IIASA</abbr>

.. role:: strike

.. role:: underline

"""  # noqa: E501

# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
html_theme = 'sphinx_rtd_theme'

# A list of CSS files.
html_css_files = ["custom.css"]

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = '_static/logo_white.png'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# -- Options for LaTeX output -------------------------------------------------

# The LaTeX engine to build the docs.
latex_engine = 'lualatex'


# -- Options for sphinx.ext.extlinks ------------------------------------------

extlinks = {
    'pull': ("https://github.com/iiasa/message_ix/pull/%s", 'PR #'),
}


# -- Options for sphinx.ext.intersphinx ---------------------------------------

intersphinx_mapping = {
    'dask': ('https://docs.dask.org/en/stable/', None),
    'ixmp': ('https://docs.messageix.org/projects/ixmp/en/latest/', None),
    # For a local build, uncomment and use the following line with a path to
    # the directory containing built HTML documentation for ixmp:
    # 'ixmp': ('/home/user/path-to-ixmp/doc/build/html', None),
    'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
    'pint': ('https://pint.readthedocs.io/en/stable/', None),
    'pyam': ('https://pyam-iamc.readthedocs.io/en/stable/', None),
    'python': ('https://docs.python.org/3/', None),
}


# -- Options for sphinx.ext.todo ----------------------------------------------

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True


# -- Options for grab_gams_doc ------------------------------------------------

gams_source_dir = Path(__file__).parents[2] / 'message_ix' / 'model'
gams_target_dir = 'model'




###########################################################################
#          auto-created readthedocs.org specific configuration            #
###########################################################################


#
# The following code was added during an automated build on readthedocs.org
# It is auto created and injected for every build. The result is based on the
# conf.py.tmpl file found in the readthedocs.org codebase:
# https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl
#


import importlib
import sys
import os.path
from six import string_types

from sphinx import version_info

# Get suffix for proper linking to GitHub
# This is deprecated in Sphinx 1.3+,
# as each page can have its own suffix
if globals().get('source_suffix', False):
    if isinstance(source_suffix, string_types):
        SUFFIX = source_suffix
    elif isinstance(source_suffix, (list, tuple)):
        # Sphinx >= 1.3 supports list/tuple to define multiple suffixes
        SUFFIX = source_suffix[0]
    elif isinstance(source_suffix, dict):
        # Sphinx >= 1.8 supports a mapping dictionary for multiple suffixes
        SUFFIX = list(source_suffix.keys())[0]  # make a ``list()`` for py2/py3 compatibility
    else:
        # default to .rst
        SUFFIX = '.rst'
else:
    SUFFIX = '.rst'

# Add RTD Static Path. Add to the end because it overwrites previous files.
if not 'html_static_path' in globals():
    html_static_path = []
if os.path.exists('_static'):
    html_static_path.append('_static')

# Add RTD Theme only if they aren't overriding it already
using_rtd_theme = (
    (
        'html_theme' in globals() and
        html_theme in ['default'] and
        # Allow people to bail with a hack of having an html_style
        'html_style' not in globals()
    ) or 'html_theme' not in globals()
)
if using_rtd_theme:
    theme = importlib.import_module('sphinx_rtd_theme')
    html_theme = 'sphinx_rtd_theme'
    html_style = None
    html_theme_options = {}
    if 'html_theme_path' in globals():
        html_theme_path.append(theme.get_html_theme_path())
    else:
        html_theme_path = [theme.get_html_theme_path()]

if globals().get('websupport2_base_url', False):
    websupport2_base_url = 'https://readthedocs.com/websupport'
    websupport2_static_url = 'https://assets.readthedocs.com/'


#Add project information to the template context.
context = {
    'using_theme': using_rtd_theme,
    'html_theme': html_theme,
    'current_version': "latest",
    'version_slug': "latest",
    'MEDIA_URL': "https://media.readthedocs.com/media/",
    'STATIC_URL': "https://assets.readthedocs.com/",
    'PRODUCTION_DOMAIN': "readthedocs.com",
    'versions': [
    ("master", "/en/master/"),
    ("latest", "/en/latest/"),
    ("stable", "/en/stable/"),
    ("v3.1.0", "/en/v3.1.0/"),
    ("v3.0.1", "/en/v3.0.1/"),
    ("v3.0.0", "/en/v3.0.0/"),
    ("v2.0.0", "/en/v2.0.0/"),
    ("v1.2.0", "/en/v1.2.0/"),
    ("v1.1.0", "/en/v1.1.0/"),
    ],
    'downloads': [ 
    ],
    'subprojects': [ 
        ("iiasa-energy-program-ixmp", "https://docs.messageix.org/projects/ixmp/en/stable/"),
        ("iiasa-energy-program-message-doc", "https://docs.messageix.org/projects/global/en/latest/"),
        ("iiasa-energy-program-message-data", "https://docs.messageix.org/projects/models/en/master/"),
    ],
    'slug': 'iiasa-energy-program-message-ix',
    'name': u'message_ix',
    'rtd_language': u'en',
    'programming_language': u'words',
    'canonical_url': 'https://docs.messageix.org/en/stable/',
    'analytics_code': 'UA-134631150-1',
    'single_version': False,
    'conf_py_path': '/doc/source/',
    'api_host': 'https://readthedocs.com',
    'github_user': 'iiasa',
    'proxied_api_host': '/_',
    'github_repo': 'message_ix',
    'github_version': 'master',
    'display_github': True,
    'bitbucket_user': 'None',
    'bitbucket_repo': 'None',
    'bitbucket_version': 'master',
    'display_bitbucket': False,
    'gitlab_user': 'None',
    'gitlab_repo': 'None',
    'gitlab_version': 'master',
    'display_gitlab': False,
    'READTHEDOCS': True,
    'using_theme': (html_theme == "default"),
    'new_theme': (html_theme == "sphinx_rtd_theme"),
    'source_suffix': SUFFIX,
    'ad_free': False,
    'docsearch_disabled': False,
    'user_analytics_code': 'UA-134631150-1',
    'global_analytics_code': 'UA-17997319-2',
    'commit': '538e1ef2',
}




if 'html_context' in globals():
    
    html_context.update(context)
    
else:
    html_context = context

# Add custom RTD extension
if 'extensions' in globals():
    # Insert at the beginning because it can interfere
    # with other extensions.
    # See https://github.com/rtfd/readthedocs.org/pull/4054
    extensions.insert(0, "readthedocs_ext.readthedocs")
else:
    extensions = ["readthedocs_ext.readthedocs"]

# Add External version warning banner to the external version documentation
if 'branch' == 'external':
    extensions.insert(1, "readthedocs_ext.external_version_warning")

project_language = 'en'

# User's Sphinx configurations
language_user = globals().get('language', None)
latex_engine_user = globals().get('latex_engine', None)
latex_elements_user = globals().get('latex_elements', None)

# Remove this once xindy gets installed in Docker image and XINDYOPS
# env variable is supported
# https://github.com/rtfd/readthedocs-docker-images/pull/98
latex_use_xindy = False

chinese = any([
    language_user in ('zh_CN', 'zh_TW'),
    project_language in ('zh_CN', 'zh_TW'),
])

japanese = any([
    language_user == 'ja',
    project_language == 'ja',
])

if chinese:
    latex_engine = latex_engine_user or 'xelatex'

    latex_elements_rtd = {
        'preamble': '\\usepackage[UTF8]{ctex}\n',
    }
    latex_elements = latex_elements_user or latex_elements_rtd
elif japanese:
    latex_engine = latex_engine_user or 'platex'

# Make sure our build directory is always excluded
exclude_patterns = globals().get('exclude_patterns', [])
exclude_patterns.extend(['_build'])

[rtd-command-info] start-time: 2020-11-22T15:49:32.274742Z, end-time: 2020-11-22T15:49:40.810020Z, duration: 8, exit-code: 0
python sphinx-build -T -E -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html
Running Sphinx v3.3.1
loading translations [en]... done
making output directory... done
generating GAMS sources... [  4%] MACRO_run
generating GAMS sources... [  8%] MESSAGE-MACRO_run
generating GAMS sources... [ 13%] MESSAGE_master
generating GAMS sources... [ 17%] version
generating GAMS sources... [ 21%] MESSAGE_run
generating GAMS sources... [ 26%] includes/aux_computation_time
generating GAMS sources... [ 30%] includes/period_parameter_assignment
generating GAMS sources... [ 34%] MACRO/macro_data_load
generating GAMS sources... [ 39%] MACRO/macro_calibration
generating GAMS sources... [ 43%] MACRO/macro_solve
generating GAMS sources... [ 47%] MACRO/macro_core
generating GAMS sources... [ 52%] MACRO/macro_reporting
generating GAMS sources... [ 56%] MESSAGE/sets_maps_def
generating GAMS sources... [ 60%] MESSAGE/model_solve
generating GAMS sources... [ 65%] MESSAGE/version_check
generating GAMS sources... [ 69%] MESSAGE/scaling_investment_costs
generating GAMS sources... [ 73%] MESSAGE/auxiliary_settings
generating GAMS sources... [ 78%] MESSAGE/data_load
generating GAMS sources... [ 82%] MESSAGE/reporting_for_MACRO
generating GAMS sources... [ 86%] MESSAGE/model_core
generating GAMS sources... [ 91%] MESSAGE/reporting
generating GAMS sources... [ 95%] MESSAGE/parameter_def
generating GAMS sources... [100%] MESSAGE/model_setup

loading intersphinx inventory from https://docs.dask.org/en/stable/objects.inv...
loading intersphinx inventory from https://docs.messageix.org/projects/ixmp/en/latest/objects.inv...
loading intersphinx inventory from https://pandas.pydata.org/pandas-docs/stable/objects.inv...
loading intersphinx inventory from https://pint.readthedocs.io/en/stable/objects.inv...
loading intersphinx inventory from https://pyam-iamc.readthedocs.io/en/stable/objects.inv...
loading intersphinx inventory from https://docs.python.org/3/objects.inv...
building [mo]: targets for 0 po files that are out of date
building [readthedocs]: targets for 27 source files that are out of date
updating environment: [new config] 27 added, 0 changed, 0 removed
reading sources... [  3%] api
reading sources... [  7%] bibliography
checking for /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/checkouts/latest/doc/source/bibs/main.bib in bibtex cache... not found
parsing bibtex file /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/checkouts/latest/doc/source/bibs/main.bib... parsed 6 entries
reading sources... [ 11%] contributing
reading sources... [ 14%] debugging
reading sources... [ 18%] efficiency
reading sources... [ 22%] faq
reading sources... [ 25%] framework
reading sources... [ 29%] index
reading sources... [ 33%] install
reading sources... [ 37%] macro
reading sources... [ 40%] model/MACRO/macro_core
reading sources... [ 44%] model/MESSAGE-MACRO_run
reading sources... [ 48%] model/MESSAGE/model_core
reading sources... [ 51%] model/MESSAGE/model_solve
reading sources... [ 55%] model/MESSAGE/parameter_def
reading sources... [ 59%] model/MESSAGE/reporting
reading sources... [ 62%] model/MESSAGE/scaling_investment_costs
reading sources... [ 66%] model/MESSAGE/sets_maps_def
reading sources... [ 70%] model/MESSAGE_run
reading sources... [ 74%] notice
reading sources... [ 77%] prereqs
reading sources... [ 81%] reporting
reading sources... [ 85%] rmessageix
reading sources... [ 88%] time
reading sources... [ 92%] tools/add_year
reading sources... [ 96%] tutorials
reading sources... [100%] whatsnew

/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/checkouts/latest/doc/source/api.rst.rst:24: WARNING: autosummary: failed to import ixmp.testing.make_dantzig
WARNING: autodoc: failed to import module 'reporting' from module 'message_ix'; the following exception was raised:
No module named 'pyam'
/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/checkouts/latest/doc/source/reporting.rst.rst:99: WARNING: autosummary: failed to import message_ix.reporting.Reporter
/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/checkouts/latest/doc/source/reporting.rst.rst:154: WARNING: autosummary: failed to import PRODUCTS
/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/checkouts/latest/doc/source/reporting.rst.rst:154: WARNING: autosummary: failed to import DERIVED
/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/checkouts/latest/doc/source/reporting.rst.rst:154: WARNING: autosummary: failed to import MAPPING_SETS
/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/checkouts/latest/doc/source/reporting.rst.rst:154: WARNING: autosummary: failed to import PYAM_CONVERT
/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/checkouts/latest/doc/source/reporting.rst.rst:154: WARNING: autosummary: failed to import REPORTS
WARNING: autodoc: failed to import class 'reporting.Reporter' from module 'message_ix'; the following exception was raised:
No module named 'pyam'
WARNING: autodoc: failed to import module 'reporting.computations' from module 'message_ix'; the following exception was raised:
No module named 'pyam'
WARNING: autodoc: failed to import data 'reporting.PRODUCTS' from module 'message_ix'; the following exception was raised:
No module named 'pyam'
WARNING: autodoc: failed to import data 'reporting.DERIVED' from module 'message_ix'; the following exception was raised:
No module named 'pyam'
WARNING: autodoc: failed to import data 'reporting.PYAM_CONVERT' from module 'message_ix'; the following exception was raised:
No module named 'pyam'
WARNING: autodoc: failed to import data 'reporting.REPORTS' from module 'message_ix'; the following exception was raised:
No module named 'pyam'
WARNING: autodoc: failed to import data 'reporting.MAPPING_SETS' from module 'message_ix'; the following exception was raised:
No module named 'pyam'
WARNING: autodoc: failed to import module 'reporting.pyam' from module 'message_ix'; the following exception was raised:
No module named 'pyam'
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [  3%] api
writing output... [  7%] bibliography
writing output... [ 11%] contributing
writing output... [ 14%] debugging
writing output... [ 18%] efficiency
writing output... [ 22%] faq
writing output... [ 25%] framework
writing output... [ 29%] index
writing output... [ 33%] install
writing output... [ 37%] macro
writing output... [ 40%] model/MACRO/macro_core
writing output... [ 44%] model/MESSAGE-MACRO_run
writing output... [ 48%] model/MESSAGE/model_core
writing output... [ 51%] model/MESSAGE/model_solve
writing output... [ 55%] model/MESSAGE/parameter_def
writing output... [ 59%] model/MESSAGE/reporting
writing output... [ 62%] model/MESSAGE/scaling_investment_costs
writing output... [ 66%] model/MESSAGE/sets_maps_def
writing output... [ 70%] model/MESSAGE_run
writing output... [ 74%] notice
writing output... [ 77%] prereqs
writing output... [ 81%] reporting
writing output... [ 85%] rmessageix
writing output... [ 88%] time
writing output... [ 92%] tools/add_year
writing output... [ 96%] tutorials
writing output... [100%] whatsnew

generating indices... genindex py-modindex done
writing additional pages... search done
copying images... [ 33%] _static/ix_components.png
copying images... [ 66%] _static/ix_features.png
copying images... [100%] model/MESSAGE/../../_static/storage.png

copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 16 warnings.

The HTML pages are in _build/html.
Updating searchtools for Read the Docs search...