Read the Docs build information Build id: 643181 Project: iiasa-energy-program-message-ix Version: stable Commit: 11057176e422791b07f4d92c4e0ced92025b2385 Date: 2021-05-28T10:17:46.160151Z State: finished Success: False [rtd-command-info] start-time: 2021-05-28T10:17:47.672234Z, end-time: 2021-05-28T10:17:49.117612Z, duration: 1, exit-code: 0 git clone --no-single-branch --depth 50 https://github.com/iiasa/message_ix.git . Cloning into '.'... [rtd-command-info] start-time: 2021-05-28T10:17:49.252534Z, end-time: 2021-05-28T10:17:49.373834Z, duration: 0, exit-code: 0 git checkout --force 11057176e422791b07f4d92c4e0ced92025b2385 Note: checking out '11057176e422791b07f4d92c4e0ced92025b2385'. 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 HEAD is now at 1105717 Release v3.2.0 [rtd-command-info] start-time: 2021-05-28T10:17:49.482628Z, end-time: 2021-05-28T10:17:49.550560Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2021-05-28T10:17:50.503587Z, end-time: 2021-05-28T10:17:54.607986Z, duration: 4, 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/stable/bin/python3.7 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2021-05-28T10:17:54.725524Z, end-time: 2021-05-28T10:17:55.839268Z, duration: 1, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip setuptools Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (21.1.2) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (57.0.0) [rtd-command-info] start-time: 2021-05-28T10:17:55.951460Z, end-time: 2021-05-28T10:18:04.241353Z, duration: 8, exit-code: 0 python -m pip install --upgrade --no-cache-dir 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 mock==1.0.1 Downloading mock-1.0.1.zip (861 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.4-py2.py3-none-any.whl (29 kB) Collecting future Downloading future-0.18.2.tar.gz (829 kB) Collecting docutils>=0.11 Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB) Collecting imagesize Downloading imagesize-1.2.0-py2.py3-none-any.whl (4.8 kB) Collecting six>=1.5 Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from sphinx<2) (57.0.0) Collecting Pygments>=2.0 Downloading Pygments-2.9.0-py3-none-any.whl (1.0 MB) Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.1.0-py2.py3-none-any.whl (93 kB) Collecting Jinja2>=2.3 Downloading Jinja2-3.0.1-py3-none-any.whl (133 kB) Collecting babel!=2.0,>=1.3 Downloading Babel-2.9.1-py2.py3-none-any.whl (8.8 MB) Collecting sphinxcontrib-websupport Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB) Collecting packaging Downloading packaging-20.9-py2.py3-none-any.whl (40 kB) Collecting requests>=2.0.0 Downloading requests-2.25.1-py2.py3-none-any.whl (61 kB) Collecting pytz>=2015.7 Downloading pytz-2021.1-py2.py3-none-any.whl (510 kB) Collecting MarkupSafe>=2.0 Downloading MarkupSafe-2.0.1-cp37-cp37m-manylinux2010_x86_64.whl (31 kB) Collecting certifi>=2017.4.17 Downloading certifi-2020.12.5-py2.py3-none-any.whl (147 kB) Collecting chardet<5,>=3.0.2 Downloading chardet-4.0.0-py2.py3-none-any.whl (178 kB) Collecting urllib3<1.27,>=1.21.1 Downloading urllib3-1.26.5-py2.py3-none-any.whl (138 kB) Collecting idna<3,>=2.5 Downloading idna-2.10-py2.py3-none-any.whl (58 kB) Collecting pyparsing>=2.0.2 Downloading pyparsing-2.4.7-py2.py3-none-any.whl (67 kB) Collecting sphinxcontrib-serializinghtml Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 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=23772 sha256=af98d142851abb3ca542bc211274024db27796aa3ed9516a9a46664f6c613153 Stored in directory: /tmp/pip-ephem-wheel-cache-w17y3x8u/wheels/7a/94/b1/0fdc5339a5bd487a5cc15421ec200d9ba3e2aa7190e4a727f1 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=491070 sha256=6003024c367604970bc33ce327deb0c59e4243c88510f094af01dea378de94b1 Stored in directory: /tmp/pip-ephem-wheel-cache-w17y3x8u/wheels/56/b0/fe/4410d17b32f1f0c3cf54cdfb2bc04d7b4b8f4ae377e2229ba0 Successfully built mock future Installing collected packages: urllib3, sphinxcontrib-serializinghtml, pytz, pyparsing, MarkupSafe, idna, chardet, certifi, sphinxcontrib-websupport, snowballstemmer, six, requests, Pygments, packaging, Jinja2, imagesize, future, docutils, babel, alabaster, sphinx, commonmark, sphinx-rtd-theme, recommonmark, readthedocs-sphinx-ext, pillow, mock Successfully installed Jinja2-3.0.1 MarkupSafe-2.0.1 Pygments-2.9.0 alabaster-0.7.12 babel-2.9.1 certifi-2020.12.5 chardet-4.0.0 commonmark-0.8.1 docutils-0.17.1 future-0.18.2 idna-2.10 imagesize-1.2.0 mock-1.0.1 packaging-20.9 pillow-5.4.1 pyparsing-2.4.7 pytz-2021.1 readthedocs-sphinx-ext-2.1.4 recommonmark-0.5.0 requests-2.25.1 six-1.16.0 snowballstemmer-2.1.0 sphinx-1.8.5 sphinx-rtd-theme-0.4.3 sphinxcontrib-serializinghtml-1.1.5 sphinxcontrib-websupport-1.2.4 urllib3-1.26.5 [rtd-command-info] start-time: 2021-05-28T10:18:04.360465Z, end-time: 2021-05-28T10:18:39.469530Z, duration: 35, 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/stable DEPRECATION: A future pip version will change local packages to be built in-place without first copying to a temporary directory. We recommend you use --use-feature=in-tree-build to test your packages with this new behavior before it becomes the default. pip 21.3 will remove support for this functionality. You can find discussion regarding this at https://github.com/pypa/pip/issues/7555. Collecting click Downloading click-8.0.1-py3-none-any.whl (97 kB) Collecting ixmp>=3.2.0 Downloading ixmp-3.3.0-py3-none-any.whl (17.5 MB) Collecting numpy Downloading numpy-1.20.3-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl (15.3 MB) Collecting pandas Downloading pandas-1.2.4-cp37-cp37m-manylinux1_x86_64.whl (9.9 MB) Collecting PyYAML Downloading PyYAML-5.4.1-cp37-cp37m-manylinux1_x86_64.whl (636 kB) Requirement already satisfied: setuptools>=41 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from message-ix==3.2.0) (57.0.0) Collecting pint Downloading Pint-0.17-py2.py3-none-any.whl (204 kB) Collecting pyam-iamc>=0.6 Downloading pyam_iamc-0.11.0-py2.py3-none-any.whl (80 kB) Collecting numpydoc Downloading numpydoc-1.1.0-py3-none-any.whl (47 kB) Collecting sphinx>=3.0 Downloading Sphinx-4.0.2-py3-none-any.whl (2.9 MB) Requirement already satisfied: sphinx_rtd_theme in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from message-ix==3.2.0) (0.4.3) Collecting sphinx_rtd_theme Downloading sphinx_rtd_theme-0.5.2-py2.py3-none-any.whl (9.1 MB) Collecting sphinxcontrib-bibtex Downloading sphinxcontrib_bibtex-2.2.1-py3-none-any.whl (31 kB) Collecting xarray Downloading xarray-0.18.2-py3-none-any.whl (807 kB) Collecting openpyxl Downloading openpyxl-3.0.7-py2.py3-none-any.whl (243 kB) Collecting genno>=1.3.0 Downloading genno-1.4.0-py3-none-any.whl (89 kB) Collecting JPype1>=1.2.1 Downloading JPype1-1.2.1-cp37-cp37m-manylinux2010_x86_64.whl (457 kB) Collecting dask[array]>=2.14 Downloading dask-2021.5.0-py3-none-any.whl (960 kB) Collecting sparse>=0.12 Downloading sparse-0.12.0-py2.py3-none-any.whl (76 kB) Collecting partd>=0.3.10 Downloading partd-1.2.0-py3-none-any.whl (19 kB) Collecting toolz>=0.8.2 Downloading toolz-0.11.1-py3-none-any.whl (55 kB) Collecting cloudpickle>=1.1.1 Downloading cloudpickle-1.6.0-py3-none-any.whl (23 kB) Collecting fsspec>=0.6.0 Downloading fsspec-2021.5.0-py3-none-any.whl (111 kB) Collecting typing-extensions Downloading typing_extensions-3.10.0.0-py3-none-any.whl (26 kB) Requirement already satisfied: pytz>=2017.3 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from pandas->message-ix==3.2.0) (2021.1) Collecting python-dateutil>=2.7.3 Downloading python_dateutil-2.8.1-py2.py3-none-any.whl (227 kB) Collecting locket Downloading locket-0.2.1-py2.py3-none-any.whl (4.1 kB) Collecting argparse Downloading argparse-1.4.0-py2.py3-none-any.whl (23 kB) Collecting plotly Downloading plotly-4.14.3-py2.py3-none-any.whl (13.2 MB) Collecting iam-units>=2020.4.12 Downloading iam_units-2021.3.22-py3-none-any.whl (29 kB) Collecting xlrd<2.0 Downloading xlrd-1.2.0-py2.py3-none-any.whl (103 kB) Collecting seaborn Downloading seaborn-0.11.1-py3-none-any.whl (285 kB) Requirement already satisfied: six in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from pyam-iamc>=0.6->message-ix==3.2.0) (1.16.0) Requirement already satisfied: requests in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from pyam-iamc>=0.6->message-ix==3.2.0) (2.25.1) Collecting matplotlib Downloading matplotlib-3.4.2-cp37-cp37m-manylinux1_x86_64.whl (10.3 MB) Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from pint->message-ix==3.2.0) (20.9) Collecting importlib-metadata Downloading importlib_metadata-4.3.0-py3-none-any.whl (16 kB) Collecting numba>=0.49 Downloading numba-0.53.1-cp37-cp37m-manylinux2014_x86_64.whl (3.4 MB) Collecting scipy>=0.19 Downloading scipy-1.6.3-cp37-cp37m-manylinux1_x86_64.whl (27.4 MB) Collecting llvmlite<0.37,>=0.36.0rc1 Downloading llvmlite-0.36.0-cp37-cp37m-manylinux2010_x86_64.whl (25.3 MB) Requirement already satisfied: docutils<0.18,>=0.14 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from sphinx>=3.0->message-ix==3.2.0) (0.17.1) Collecting sphinxcontrib-applehelp Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) Collecting sphinxcontrib-jsmath Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from sphinx>=3.0->message-ix==3.2.0) (3.0.1) Requirement already satisfied: babel>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from sphinx>=3.0->message-ix==3.2.0) (2.9.1) Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from sphinx>=3.0->message-ix==3.2.0) (1.2.0) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from sphinx>=3.0->message-ix==3.2.0) (0.7.12) Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from sphinx>=3.0->message-ix==3.2.0) (2.9.0) Collecting sphinxcontrib-qthelp Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) Collecting sphinxcontrib-htmlhelp Downloading sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl (100 kB) Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from sphinx>=3.0->message-ix==3.2.0) (2.1.0) Requirement already satisfied: sphinxcontrib-serializinghtml in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from sphinx>=3.0->message-ix==3.2.0) (1.1.5) Collecting sphinxcontrib-devhelp Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from Jinja2>=2.3->sphinx>=3.0->message-ix==3.2.0) (2.0.1) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from requests->pyam-iamc>=0.6->message-ix==3.2.0) (2020.12.5) Requirement already satisfied: idna<3,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from requests->pyam-iamc>=0.6->message-ix==3.2.0) (2.10) Requirement already satisfied: chardet<5,>=3.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from requests->pyam-iamc>=0.6->message-ix==3.2.0) (4.0.0) Requirement already satisfied: urllib3<1.27,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from requests->pyam-iamc>=0.6->message-ix==3.2.0) (1.26.5) Collecting zipp>=0.5 Downloading zipp-3.4.1-py3-none-any.whl (5.2 kB) Requirement already satisfied: pyparsing>=2.2.1 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages (from matplotlib->pyam-iamc>=0.6->message-ix==3.2.0) (2.4.7) Collecting pillow>=6.2.0 Downloading Pillow-8.2.0-cp37-cp37m-manylinux1_x86_64.whl (3.0 MB) Collecting kiwisolver>=1.0.1 Downloading kiwisolver-1.3.1-cp37-cp37m-manylinux1_x86_64.whl (1.1 MB) Collecting cycler>=0.10 Downloading cycler-0.10.0-py2.py3-none-any.whl (6.5 kB) Collecting et-xmlfile Downloading et_xmlfile-1.1.0-py3-none-any.whl (4.7 kB) Collecting retrying>=1.3.3 Downloading retrying-1.3.3.tar.gz (10 kB) Collecting docutils<0.18,>=0.14 Downloading docutils-0.16-py2.py3-none-any.whl (548 kB) Collecting pybtex-docutils>=1.0.0 Downloading pybtex_docutils-1.0.0-py3-none-any.whl (4.7 kB) Collecting pybtex>=0.20 Downloading pybtex-0.24.0-py2.py3-none-any.whl (561 kB) Collecting latexcodec>=1.0.4 Downloading latexcodec-2.0.1-py2.py3-none-any.whl (18 kB) Building wheels for collected packages: message-ix, retrying 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.2.0-py3-none-any.whl size=234474 sha256=aaccebaf3eb75bc4de4e42a752eda1f98dda65ef21c5f6f5e70dbff367cbdb94 Stored in directory: /tmp/pip-ephem-wheel-cache-smouabh8/wheels/9c/33/37/c28f33a3db182a0256cbb34959ac41a591111b3b5b102a3da6 Building wheel for retrying (setup.py): started Building wheel for retrying (setup.py): finished with status 'done' Created wheel for retrying: filename=retrying-1.3.3-py3-none-any.whl size=11448 sha256=4f6fcb67f5a333857489d08c32d0a2ecb623df469e11817cc80ef4ae769ad6e2 Stored in directory: /tmp/pip-ephem-wheel-cache-smouabh8/wheels/f9/8d/8d/f6af3f7f9eea3553bc2fe6d53e4b287dad18b06a861ac56ddf Successfully built message-ix retrying Installing collected packages: toolz, locket, zipp, typing-extensions, PyYAML, python-dateutil, partd, numpy, llvmlite, fsspec, cloudpickle, scipy, pandas, numba, importlib-metadata, dask, xarray, sparse, pint, pillow, latexcodec, kiwisolver, et-xmlfile, cycler, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, retrying, pybtex, openpyxl, matplotlib, JPype1, genno, docutils, click, xlrd, sphinx, seaborn, pybtex-docutils, plotly, ixmp, iam-units, argparse, sphinxcontrib-bibtex, sphinx-rtd-theme, pyam-iamc, numpydoc, message-ix Attempting uninstall: pillow Found existing installation: Pillow 5.4.1 Uninstalling Pillow-5.4.1: Successfully uninstalled Pillow-5.4.1 Attempting uninstall: docutils Found existing installation: docutils 0.17.1 Uninstalling docutils-0.17.1: Successfully uninstalled docutils-0.17.1 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.2.1 PyYAML-5.4.1 argparse-1.4.0 click-8.0.1 cloudpickle-1.6.0 cycler-0.10.0 dask-2021.5.0 docutils-0.16 et-xmlfile-1.1.0 fsspec-2021.5.0 genno-1.4.0 iam-units-2021.3.22 importlib-metadata-4.3.0 ixmp-3.3.0 kiwisolver-1.3.1 latexcodec-2.0.1 llvmlite-0.36.0 locket-0.2.1 matplotlib-3.4.2 message-ix-3.2.0 numba-0.53.1 numpy-1.20.3 numpydoc-1.1.0 openpyxl-3.0.7 pandas-1.2.4 partd-1.2.0 pillow-8.2.0 pint-0.17 plotly-4.14.3 pyam-iamc-0.11.0 pybtex-0.24.0 pybtex-docutils-1.0.0 python-dateutil-2.8.1 retrying-1.3.3 scipy-1.6.3 seaborn-0.11.1 sparse-0.12.0 sphinx-4.0.2 sphinx-rtd-theme-0.5.2 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-bibtex-2.2.1 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-2.0.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 toolz-0.11.1 typing-extensions-3.10.0.0 xarray-0.18.2 xlrd-1.2.0 zipp-3.4.1 [rtd-command-info] start-time: 2021-05-28T10:18:40.696122Z, end-time: 2021-05-28T10:18:40.792788Z, duration: 0, exit-code: 0 cat doc/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. from pathlib import Path from pkg_resources import get_distribution # -- Project information ----------------------------------------------------- project = "MESSAGEix" copyright = "2021, IIASA Energy, Climate, and Environment (ECE) 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", "message_ix.util.sphinx_gams", ] # 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. # This pattern also affects html_static_path and html_extra_path. exclude_patterns = ["_build", "README.rst"] # 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 IIASA .. 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 sphinxcontrib.bibtex ----------------------------------------- bibtex_bibfiles = ["references.bib"] # -- Options for message_ix.util.sphinx_gams ------------------------------------------- gams_source_dir = Path(__file__).parents[1].joinpath("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 # # Note: this file should't rely on extra depencies. import importlib import sys import os.path # Borrowed from six. PY3 = sys.version_info[0] == 3 string_types = str if PY3 else basestring 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': "stable", 'version_slug': "stable", '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.2.0", "/en/v3.2.0/"), ("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/"), ("rtd-build", "/en/rtd-build/"), ("main", "/en/main/"), ], '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/"), ("iiasa-energy-program-message-ix-models", "https://docs.messageix.org/projects/models2/en/latest/"), ], '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/', 'api_host': 'https://readthedocs.com', 'github_user': 'iiasa', 'proxied_api_host': '/_', 'github_repo': 'message_ix', 'github_version': '11057176e422791b07f4d92c4e0ced92025b2385', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': '11057176e422791b07f4d92c4e0ced92025b2385', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': '11057176e422791b07f4d92c4e0ced92025b2385', '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': '11057176', } # For sphinx >=1.8 we can use html_baseurl to set the canonical URL. # https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl if version_info >= (1, 8): if not globals().get('html_baseurl'): html_baseurl = context['canonical_url'] context['canonical_url'] = None 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") readthedocs_vcs_url = 'None' readthedocs_build_url = 'https://readthedocs.com/projects/iiasa-energy-program-message-ix/builds/643181/' 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: 2021-05-28T10:18:40.911447Z, end-time: 2021-05-28T10:18:42.856943Z, duration: 1, exit-code: 2 python -m sphinx -T -b html -d _build/doctrees -D language=en . _build/html Running Sphinx v4.0.2 loading translations [en]... done Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages/sphinx/registry.py", line 420, in load_extension mod = import_module(extname) File "/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/importlib/__init__.py", line 127, in import_module return _bootstrap._gcd_import(name[level:], package, level) File "", line 1006, in _gcd_import File "", line 983, in _find_and_load File "", line 953, in _find_and_load_unlocked File "", line 219, in _call_with_frames_removed File "", line 1006, in _gcd_import File "", line 983, in _find_and_load File "", line 953, in _find_and_load_unlocked File "", line 219, in _call_with_frames_removed File "", line 1006, in _gcd_import File "", line 983, in _find_and_load File "", line 967, in _find_and_load_unlocked File "", line 677, in _load_unlocked File "", line 728, in exec_module File "", line 219, in _call_with_frames_removed File "/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages/message_ix/__init__.py", line 10, in from .reporting import Reporter File "/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages/message_ix/reporting/__init__.py", line 8, in from . import computations File "/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages/message_ix/reporting/computations.py", line 5, in from ixmp.reporting.computations import add, product ImportError: cannot import name 'add' from 'ixmp.reporting.computations' (/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages/ixmp/reporting/computations.py) The above exception was the direct cause of the following exception: Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages/sphinx/cmd/build.py", line 279, in build_main args.tags, args.verbosity, args.jobs, args.keep_going) File "/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages/sphinx/application.py", line 243, in __init__ self.setup_extension(extension) File "/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages/sphinx/application.py", line 400, in setup_extension self.registry.load_extension(self, extname) File "/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages/sphinx/registry.py", line 424, in load_extension err) from err sphinx.errors.ExtensionError: Could not import extension message_ix.util.sphinx_gams (exception: cannot import name 'add' from 'ixmp.reporting.computations' (/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages/ixmp/reporting/computations.py)) Extension error: Could not import extension message_ix.util.sphinx_gams (exception: cannot import name 'add' from 'ixmp.reporting.computations' (/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-message-ix/envs/stable/lib/python3.7/site-packages/ixmp/reporting/computations.py))