Read the Docs build information Build id: 2367142 Project: iiasa-energy-program-ece-docs Version: 12 Commit: 0d55a193b50cf0c29bc8b0859a18771e3cbdec24 Date: 2024-07-23T12:39:35.208955Z State: finished Success: True [rtd-command-info] start-time: 2024-07-23T12:42:44.470857Z, end-time: 2024-07-23T12:42:44.928451Z, duration: 0, exit-code: 0 git clone --depth 1 https://github.com/iiasa/ece-docs.git . Cloning into '.'... [rtd-command-info] start-time: 2024-07-23T12:42:45.001888Z, end-time: 2024-07-23T12:42:45.435067Z, duration: 0, exit-code: 0 git fetch origin --force --prune --prune-tags --depth 50 pull/12/head:external-12 From https://github.com/iiasa/ece-docs * [new ref] refs/pull/12/head -> external-12 [rtd-command-info] start-time: 2024-07-23T12:42:45.595144Z, end-time: 2024-07-23T12:42:45.658759Z, duration: 0, exit-code: 0 git checkout --force 0d55a193b50cf0c29bc8b0859a18771e3cbdec24 Note: switching to '0d55a193b50cf0c29bc8b0859a18771e3cbdec24'. 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 switching back to a branch. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -c with the switch command. Example: git switch -c Or undo this operation with: git switch - Turn off this advice by setting config variable advice.detachedHead to false HEAD is now at 0d55a19 Remove duplicate workflow file [rtd-command-info] start-time: 2024-07-23T12:42:45.731295Z, end-time: 2024-07-23T12:42:45.789485Z, duration: 0, exit-code: 0 cat .readthedocs.yaml # .readthedocs.yaml # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details # Required version: 2 # Set the version of Python and other tools you might need build: os: ubuntu-22.04 tools: python: "3.10" # You can also specify other tool versions: # nodejs: "19" # rust: "1.64" # golang: "1.19" # Build documentation in ? directory with Sphinx sphinx: builder: html configuration: conf.py # If using Sphinx, optionally build your docs in additional formats such as PDF formats: - pdf - epub # Optionally declare the Python requirements required to build your docs python: install: - requirements: requirements.txt [rtd-command-info] start-time: 2024-07-23T12:42:50.791687Z, end-time: 2024-07-23T12:42:50.872380Z, duration: 0, exit-code: 0 asdf global python 3.10.14 [rtd-command-info] start-time: 2024-07-23T12:42:51.292681Z, end-time: 2024-07-23T12:42:52.654735Z, duration: 1, exit-code: 0 python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH created virtual environment CPython3.10.14.final.0-64 in 795ms creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12, clear=False, no_vcs_ignore=False, global=False) seeder FromAppData(download=False, pip=bundle, setuptools=bundle, wheel=bundle, via=copy, app_data_dir=/home/docs/.local/share/virtualenv) added seed packages: pip==23.1, setuptools==67.6.1, wheel==0.40.0 activators BashActivator,CShellActivator,FishActivator,NushellActivator,PowerShellActivator,PythonActivator [rtd-command-info] start-time: 2024-07-23T12:42:52.725658Z, end-time: 2024-07-23T12:43:07.788224Z, duration: 15, 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-ece-docs/envs/12/lib/python3.10/site-packages (23.1) Collecting pip Downloading pip-24.1.2-py3-none-any.whl (1.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.8/1.8 MB 9.9 MB/s eta 0:00:00 Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (67.6.1) Collecting setuptools Downloading setuptools-71.1.0-py3-none-any.whl (2.3 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.3/2.3 MB 21.9 MB/s eta 0:00:00 Installing collected packages: setuptools, pip Attempting uninstall: setuptools Found existing installation: setuptools 67.6.1 Uninstalling setuptools-67.6.1: Successfully uninstalled setuptools-67.6.1 Attempting uninstall: pip Found existing installation: pip 23.1 Uninstalling pip-23.1: Successfully uninstalled pip-23.1 Successfully installed pip-24.1.2 setuptools-71.1.0 [rtd-command-info] start-time: 2024-07-23T12:43:07.870815Z, end-time: 2024-07-23T12:43:18.287645Z, duration: 10, exit-code: 0 python -m pip install --upgrade --no-cache-dir sphinx readthedocs-sphinx-ext Collecting sphinx Downloading sphinx-7.4.7-py3-none-any.whl.metadata (6.1 kB) Collecting readthedocs-sphinx-ext Downloading readthedocs_sphinx_ext-2.2.5-py2.py3-none-any.whl.metadata (1.5 kB) Collecting sphinxcontrib-applehelp (from sphinx) Downloading sphinxcontrib_applehelp-1.0.8-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-devhelp (from sphinx) Downloading sphinxcontrib_devhelp-1.0.6-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-jsmath (from sphinx) Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl.metadata (1.4 kB) Collecting sphinxcontrib-htmlhelp>=2.0.0 (from sphinx) Downloading sphinxcontrib_htmlhelp-2.0.6-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-serializinghtml>=1.1.9 (from sphinx) Downloading sphinxcontrib_serializinghtml-1.1.10-py3-none-any.whl.metadata (2.4 kB) Collecting sphinxcontrib-qthelp (from sphinx) Downloading sphinxcontrib_qthelp-1.0.8-py3-none-any.whl.metadata (2.3 kB) Collecting Jinja2>=3.1 (from sphinx) Downloading jinja2-3.1.4-py3-none-any.whl.metadata (2.6 kB) Collecting Pygments>=2.17 (from sphinx) Downloading pygments-2.18.0-py3-none-any.whl.metadata (2.5 kB) Collecting docutils<0.22,>=0.20 (from sphinx) Downloading docutils-0.21.2-py3-none-any.whl.metadata (2.8 kB) Collecting snowballstemmer>=2.2 (from sphinx) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl.metadata (6.5 kB) Collecting babel>=2.13 (from sphinx) Downloading Babel-2.15.0-py3-none-any.whl.metadata (1.5 kB) Collecting alabaster~=0.7.14 (from sphinx) Downloading alabaster-0.7.16-py3-none-any.whl.metadata (2.9 kB) Collecting imagesize>=1.3 (from sphinx) Downloading imagesize-1.4.1-py2.py3-none-any.whl.metadata (1.5 kB) Collecting requests>=2.30.0 (from sphinx) Downloading requests-2.32.3-py3-none-any.whl.metadata (4.6 kB) Collecting packaging>=23.0 (from sphinx) Downloading packaging-24.1-py3-none-any.whl.metadata (3.2 kB) Collecting tomli>=2 (from sphinx) Downloading tomli-2.0.1-py3-none-any.whl.metadata (8.9 kB) Collecting MarkupSafe>=2.0 (from Jinja2>=3.1->sphinx) Downloading MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (3.0 kB) Collecting charset-normalizer<4,>=2 (from requests>=2.30.0->sphinx) Downloading charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (33 kB) Collecting idna<4,>=2.5 (from requests>=2.30.0->sphinx) Downloading idna-3.7-py3-none-any.whl.metadata (9.9 kB) Collecting urllib3<3,>=1.21.1 (from requests>=2.30.0->sphinx) Downloading urllib3-2.2.2-py3-none-any.whl.metadata (6.4 kB) Collecting certifi>=2017.4.17 (from requests>=2.30.0->sphinx) Downloading certifi-2024.7.4-py3-none-any.whl.metadata (2.2 kB) Downloading sphinx-7.4.7-py3-none-any.whl (3.4 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.4/3.4 MB 19.4 MB/s eta 0:00:00 Downloading readthedocs_sphinx_ext-2.2.5-py2.py3-none-any.whl (11 kB) Downloading alabaster-0.7.16-py3-none-any.whl (13 kB) Downloading Babel-2.15.0-py3-none-any.whl (9.6 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 9.6/9.6 MB 43.7 MB/s eta 0:00:00 Downloading docutils-0.21.2-py3-none-any.whl (587 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 587.4/587.4 kB 164.4 MB/s eta 0:00:00 Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Downloading jinja2-3.1.4-py3-none-any.whl (133 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.3/133.3 kB 154.3 MB/s eta 0:00:00 Downloading packaging-24.1-py3-none-any.whl (53 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 54.0/54.0 kB 144.7 MB/s eta 0:00:00 Downloading pygments-2.18.0-py3-none-any.whl (1.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 160.2 MB/s eta 0:00:00 Downloading requests-2.32.3-py3-none-any.whl (64 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 64.9/64.9 kB 142.8 MB/s eta 0:00:00 Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 148.3 MB/s eta 0:00:00 Downloading sphinxcontrib_htmlhelp-2.0.6-py3-none-any.whl (99 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 99.2/99.2 kB 157.1 MB/s eta 0:00:00 Downloading sphinxcontrib_serializinghtml-1.1.10-py3-none-any.whl (92 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 92.7/92.7 kB 143.2 MB/s eta 0:00:00 Downloading tomli-2.0.1-py3-none-any.whl (12 kB) Downloading sphinxcontrib_applehelp-1.0.8-py3-none-any.whl (120 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 120.0/120.0 kB 168.6 MB/s eta 0:00:00 Downloading sphinxcontrib_devhelp-1.0.6-py3-none-any.whl (83 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 83.5/83.5 kB 156.3 MB/s eta 0:00:00 Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Downloading sphinxcontrib_qthelp-1.0.8-py3-none-any.whl (89 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 89.5/89.5 kB 162.5 MB/s eta 0:00:00 Downloading certifi-2024.7.4-py3-none-any.whl (162 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 163.0/163.0 kB 167.0 MB/s eta 0:00:00 Downloading charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (142 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 142.1/142.1 kB 171.2 MB/s eta 0:00:00 Downloading idna-3.7-py3-none-any.whl (66 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 66.8/66.8 kB 138.0 MB/s eta 0:00:00 Downloading MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB) Downloading urllib3-2.2.2-py3-none-any.whl (121 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.4/121.4 kB 155.0 MB/s eta 0:00:00 Installing collected packages: snowballstemmer, urllib3, tomli, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, Pygments, packaging, MarkupSafe, imagesize, idna, docutils, charset-normalizer, certifi, babel, alabaster, requests, Jinja2, sphinx, readthedocs-sphinx-ext Successfully installed Jinja2-3.1.4 MarkupSafe-2.1.5 Pygments-2.18.0 alabaster-0.7.16 babel-2.15.0 certifi-2024.7.4 charset-normalizer-3.3.2 docutils-0.21.2 idna-3.7 imagesize-1.4.1 packaging-24.1 readthedocs-sphinx-ext-2.2.5 requests-2.32.3 snowballstemmer-2.2.0 sphinx-7.4.7 sphinxcontrib-applehelp-1.0.8 sphinxcontrib-devhelp-1.0.6 sphinxcontrib-htmlhelp-2.0.6 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.8 sphinxcontrib-serializinghtml-1.1.10 tomli-2.0.1 urllib3-2.2.2 [rtd-command-info] start-time: 2024-07-23T12:43:18.355437Z, end-time: 2024-07-23T12:43:20.814258Z, duration: 2, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r requirements.txt Requirement already satisfied: sphinx>=2.4 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from -r requirements.txt (line 1)) (7.4.7) Collecting sphinx_rtd_theme (from -r requirements.txt (line 2)) Downloading sphinx_rtd_theme-2.0.0-py2.py3-none-any.whl.metadata (4.4 kB) Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (1.0.8) Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (1.0.6) Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (1.0.1) Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (2.0.6) Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.9 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (1.1.10) Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (1.0.8) Requirement already satisfied: Jinja2>=3.1 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (3.1.4) Requirement already satisfied: Pygments>=2.17 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (2.18.0) Requirement already satisfied: docutils<0.22,>=0.20 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (0.21.2) Requirement already satisfied: snowballstemmer>=2.2 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (2.2.0) Requirement already satisfied: babel>=2.13 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (2.15.0) Requirement already satisfied: alabaster~=0.7.14 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (0.7.16) Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (1.4.1) Requirement already satisfied: requests>=2.30.0 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (2.32.3) Requirement already satisfied: packaging>=23.0 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (24.1) Requirement already satisfied: tomli>=2 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (2.0.1) Collecting docutils<0.22,>=0.20 (from sphinx>=2.4->-r requirements.txt (line 1)) Downloading docutils-0.20.1-py3-none-any.whl.metadata (2.8 kB) Collecting sphinxcontrib-jquery<5,>=4 (from sphinx_rtd_theme->-r requirements.txt (line 2)) Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl.metadata (2.6 kB) Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from Jinja2>=3.1->sphinx>=2.4->-r requirements.txt (line 1)) (2.1.5) Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from requests>=2.30.0->sphinx>=2.4->-r requirements.txt (line 1)) (3.3.2) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from requests>=2.30.0->sphinx>=2.4->-r requirements.txt (line 1)) (3.7) Requirement already satisfied: urllib3<3,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from requests>=2.30.0->sphinx>=2.4->-r requirements.txt (line 1)) (2.2.2) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/12/lib/python3.10/site-packages (from requests>=2.30.0->sphinx>=2.4->-r requirements.txt (line 1)) (2024.7.4) Downloading sphinx_rtd_theme-2.0.0-py2.py3-none-any.whl (2.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.8/2.8 MB 30.5 MB/s eta 0:00:00 Downloading docutils-0.20.1-py3-none-any.whl (572 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 572.7/572.7 kB 146.3 MB/s eta 0:00:00 Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.1/121.1 kB 154.1 MB/s eta 0:00:00 Installing collected packages: docutils, sphinxcontrib-jquery, sphinx_rtd_theme Attempting uninstall: docutils Found existing installation: docutils 0.21.2 Uninstalling docutils-0.21.2: Successfully uninstalled docutils-0.21.2 Successfully installed docutils-0.20.1 sphinx_rtd_theme-2.0.0 sphinxcontrib-jquery-4.1 [rtd-command-info] start-time: 2024-07-23T12:43:21.475918Z, end-time: 2024-07-23T12:43:21.565816Z, duration: 0, exit-code: 0 cat 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 sys # sys.path.insert(0, os.path.abspath('.')) import datetime import os # -- Project information ----------------------------------------------------- project = "ece-docs" copyright = f"2023-{datetime.datetime.now().year} IIASA" author = "IIASA ECE Scenario Services Team" # -- 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.intersphinx", ] # 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: list[str] = [] # -- Intersphinx ------------------------------------------------------------- # Intersphinx configuration. intersphinx_mapping = { "pyam": ("https://pyam-iamc.readthedocs.io/en/stable/", None), } # -- 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" # The name of an image file (relative to this directory) to place at the top # of the sidebar. html_logo = "_static/iiasa_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"] # These paths are either relative to html_static_path # or fully qualified paths (eg. https://...) html_css_files = [ "iiasa.css", ] # Define the canonical URL if you are using a custom domain on Read the Docs html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "") # Tell Jinja2 templates the build is running on Read the Docs if os.environ.get("READTHEDOCS", "") == "True": if "html_context" not in globals(): html_context = {} html_context["READTHEDOCS"] = True # prolog for all rst files rst_prolog = """ .. |br| raw:: html
""" ########################################################################### # 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/main/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl # # Note: this file shouldn't rely on extra dependencies. 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') # Define this variable in case it's not defined by the user. # It defaults to `alabaster` which is the default from Sphinx. # https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_theme html_theme = globals().get('html_theme', 'alabaster') #Add project information to the template context. context = { 'html_theme': html_theme, 'current_version': "12", 'version_slug': "12", 'MEDIA_URL': "https://media.readthedocs.com/media/", 'STATIC_URL': "https://assets.readthedocs.com/", 'PRODUCTION_DOMAIN': "readthedocs.com", 'proxied_static_path': "/_/static/", 'versions': [ ("latest", "/en/latest/"), ], 'downloads': [ ], 'subprojects': [ ("iiasa-energy-program-ece-docs-ixmp4", "https://docs.ece.iiasa.ac.at/projects/ixmp4/en/latest/"), ], 'slug': 'iiasa-energy-program-ece-docs', 'name': u'ece-docs', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': '', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/', 'api_host': 'https://readthedocs.com', 'github_user': 'iiasa', 'proxied_api_host': '/_', 'github_repo': 'ece-docs', 'github_version': '0d55a193b50cf0c29bc8b0859a18771e3cbdec24', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': '0d55a193b50cf0c29bc8b0859a18771e3cbdec24', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': '0d55a193b50cf0c29bc8b0859a18771e3cbdec24', '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': '', 'global_analytics_code': 'UA-17997319-2', 'commit': '0d55a193', } # 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(): for key in context: if key not in html_context: html_context[key] = context[key] 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 'external' == 'external': extensions.insert(1, "readthedocs_ext.external_version_warning") readthedocs_vcs_url = 'https://github.com/iiasa/ece-docs/pull/12' readthedocs_build_url = 'https://readthedocs.com/projects/iiasa-energy-program-ece-docs/builds/2367142/' 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: 2024-07-23T12:43:21.679236Z, end-time: 2024-07-23T12:43:23.541765Z, duration: 1, exit-code: 0 python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html Running Sphinx v7.4.7 loading translations [en]... done making output directory... done loading intersphinx inventory 'pyam' from https://pyam-iamc.readthedocs.io/en/stable/objects.inv... building [mo]: targets for 0 po files that are out of date writing output... building [html]: targets for 6 source files that are out of date updating environment: [new config] 6 added, 0 changed, 0 removed reading sources... [ 17%] iamc reading sources... [ 33%] iamc/region reading sources... [ 50%] iamc/variable reading sources... [ 67%] index reading sources... [ 83%] scenario-databases reading sources... [100%] software looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done copying assets... copying static files... done copying extra files... done copying assets: done writing output... [ 17%] iamc writing output... [ 33%] iamc/region writing output... [ 50%] iamc/variable writing output... [ 67%] index writing output... [ 83%] scenario-databases writing output... [100%] software generating indices... genindex done writing additional pages... search done copying images... [ 33%] _static/iamc-logo.png copying images... [ 67%] _static/iamc-example.png copying images... [100%] _static/ece-manager-screenshot.png dumping search index in English (code: en)... done dumping object inventory... done Updating searchtools for Read the Docs search... build succeeded. The HTML pages are in _readthedocs/html.