Read the Docs build information Build id: 1427765 Project: iiasa-energy-program-ece-docs Version: latest Commit: d6222a816f9eab60ef9d15dbf1494c8a752217c8 Date: 2023-04-21T11:09:45.773396Z State: finished Success: True [rtd-command-info] start-time: 2023-04-21T11:09:51.944808Z, end-time: 2023-04-21T11:09:58.768794Z, duration: 6, exit-code: 0 git clone --no-single-branch --depth 50 https://github.com/iiasa/ece-docs.git . Cloning into '.'... [rtd-command-info] start-time: 2023-04-21T11:09:59.024214Z, end-time: 2023-04-21T11:09:59.107086Z, duration: 0, exit-code: 0 git checkout --force origin/main Note: switching to 'origin/main'. 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 d6222a8 Fix the formatting of the readme [rtd-command-info] start-time: 2023-04-21T11:09:59.393616Z, end-time: 2023-04-21T11:09:59.457579Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2023-04-21T11:10:00.673480Z, end-time: 2023-04-21T11:10:19.593033Z, duration: 18, exit-code: 0 python3.7 -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH Using base prefix '/home/docs/.pyenv/versions/3.7.9' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/bin/python3.7 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2023-04-21T11:10:19.789988Z, end-time: 2023-04-21T11:10:21.850915Z, duration: 2, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip setuptools<58.3.0 Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (23.1) Collecting setuptools<58.3.0 Downloading setuptools-58.2.0-py3-none-any.whl (946 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 946.1/946.1 kB 29.8 MB/s eta 0:00:00 Installing collected packages: setuptools Attempting uninstall: setuptools Found existing installation: setuptools 67.7.1 Uninstalling setuptools-67.7.1: Successfully uninstalled setuptools-67.7.1 Successfully installed setuptools-58.2.0 [rtd-command-info] start-time: 2023-04-21T11:10:22.049086Z, end-time: 2023-04-21T11:10:30.237408Z, duration: 8, exit-code: 0 python -m pip install --upgrade --no-cache-dir pillow mock==1.0.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.9.1 recommonmark==0.5.0 sphinx sphinx-rtd-theme readthedocs-sphinx-ext<2.3 Collecting pillow Downloading Pillow-9.5.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.3 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.3/3.3 MB 54.2 MB/s eta 0:00:00 Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 kB 256.8 MB/s eta 0:00:00 Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting alabaster!=0.7.5,<0.8,>=0.7 Downloading alabaster-0.7.13-py3-none-any.whl (13 kB) Collecting commonmark==0.9.1 Downloading commonmark-0.9.1-py2.py3-none-any.whl (51 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 51.1/51.1 kB 192.8 MB/s eta 0:00:00 Collecting recommonmark==0.5.0 Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Collecting sphinx Downloading sphinx-5.3.0-py3-none-any.whl (3.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.2/3.2 MB 189.9 MB/s eta 0:00:00 Collecting sphinx-rtd-theme Downloading sphinx_rtd_theme-1.2.0-py2.py3-none-any.whl (2.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.8/2.8 MB 181.6 MB/s eta 0:00:00 Collecting readthedocs-sphinx-ext<2.3 Downloading readthedocs_sphinx_ext-2.2.0-py2.py3-none-any.whl (11 kB) Collecting docutils>=0.11 (from recommonmark==0.5.0) Downloading docutils-0.19-py3-none-any.whl (570 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 570.5/570.5 kB 254.0 MB/s eta 0:00:00 Collecting sphinxcontrib-applehelp (from sphinx) Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.2/121.2 kB 230.7 MB/s eta 0:00:00 Collecting sphinxcontrib-devhelp (from sphinx) Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 84.7/84.7 kB 214.6 MB/s eta 0:00:00 Collecting sphinxcontrib-jsmath (from sphinx) Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Collecting sphinxcontrib-htmlhelp>=2.0.0 (from sphinx) Downloading sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl (100 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100.5/100.5 kB 222.6 MB/s eta 0:00:00 Collecting sphinxcontrib-serializinghtml>=1.1.5 (from sphinx) Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 94.0/94.0 kB 209.7 MB/s eta 0:00:00 Collecting sphinxcontrib-qthelp (from sphinx) Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 90.6/90.6 kB 220.6 MB/s eta 0:00:00 Collecting Jinja2>=3.0 (from sphinx) Downloading Jinja2-3.1.2-py3-none-any.whl (133 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.1/133.1 kB 234.9 MB/s eta 0:00:00 Collecting Pygments>=2.12 (from sphinx) Downloading Pygments-2.15.1-py3-none-any.whl (1.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.1/1.1 MB 259.1 MB/s eta 0:00:00 Collecting snowballstemmer>=2.0 (from sphinx) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 218.0 MB/s eta 0:00:00 Collecting babel>=2.9 (from sphinx) Downloading Babel-2.12.1-py3-none-any.whl (10.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 10.1/10.1 MB 174.6 MB/s eta 0:00:00 Collecting imagesize>=1.3 (from sphinx) Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Collecting requests>=2.5.0 (from sphinx) Downloading requests-2.28.2-py3-none-any.whl (62 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.8/62.8 kB 187.6 MB/s eta 0:00:00 Collecting packaging>=21.0 (from sphinx) Downloading packaging-23.1-py3-none-any.whl (48 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 48.9/48.9 kB 193.6 MB/s eta 0:00:00 Collecting importlib-metadata>=4.8 (from sphinx) Downloading importlib_metadata-6.5.0-py3-none-any.whl (22 kB) Collecting docutils>=0.11 (from recommonmark==0.5.0) Downloading docutils-0.18.1-py2.py3-none-any.whl (570 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 570.0/570.0 kB 248.9 MB/s eta 0:00:00 Collecting sphinxcontrib-jquery!=3.0.0,>=2.0.0 (from sphinx-rtd-theme) Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.1/121.1 kB 218.7 MB/s eta 0:00:00 Collecting pytz>=2015.7 (from babel>=2.9->sphinx) Downloading pytz-2023.3-py2.py3-none-any.whl (502 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 502.3/502.3 kB 249.4 MB/s eta 0:00:00 Collecting zipp>=0.5 (from importlib-metadata>=4.8->sphinx) Downloading zipp-3.15.0-py3-none-any.whl (6.8 kB) Collecting typing-extensions>=3.6.4 (from importlib-metadata>=4.8->sphinx) Downloading typing_extensions-4.5.0-py3-none-any.whl (27 kB) Collecting MarkupSafe>=2.0 (from Jinja2>=3.0->sphinx) Downloading MarkupSafe-2.1.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB) Collecting charset-normalizer<4,>=2 (from requests>=2.5.0->sphinx) Downloading charset_normalizer-3.1.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (171 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 171.0/171.0 kB 222.8 MB/s eta 0:00:00 Collecting idna<4,>=2.5 (from requests>=2.5.0->sphinx) Downloading idna-3.4-py3-none-any.whl (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.5/61.5 kB 190.5 MB/s eta 0:00:00 Collecting urllib3<1.27,>=1.21.1 (from requests>=2.5.0->sphinx) Downloading urllib3-1.26.15-py2.py3-none-any.whl (140 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 140.9/140.9 kB 234.2 MB/s eta 0:00:00 Collecting certifi>=2017.4.17 (from requests>=2.5.0->sphinx) Downloading certifi-2022.12.7-py3-none-any.whl (155 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 155.3/155.3 kB 234.7 MB/s eta 0:00:00 Building wheels for collected packages: mock 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=9eaf7728bcbc83bdc2e6808ea7babaa7bfba7c41b3e5a7c81b7bba56134e8510 Stored in directory: /tmp/pip-ephem-wheel-cache-xmsdk3df/wheels/7a/94/b1/0fdc5339a5bd487a5cc15421ec200d9ba3e2aa7190e4a727f1 Successfully built mock Installing collected packages: snowballstemmer, pytz, mock, commonmark, zipp, urllib3, typing-extensions, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, Pygments, pillow, packaging, MarkupSafe, imagesize, idna, docutils, charset-normalizer, certifi, babel, alabaster, requests, Jinja2, importlib-metadata, sphinx, readthedocs-sphinx-ext, sphinxcontrib-jquery, recommonmark, sphinx-rtd-theme Successfully installed Jinja2-3.1.2 MarkupSafe-2.1.2 Pygments-2.15.1 alabaster-0.7.13 babel-2.12.1 certifi-2022.12.7 charset-normalizer-3.1.0 commonmark-0.9.1 docutils-0.18.1 idna-3.4 imagesize-1.4.1 importlib-metadata-6.5.0 mock-1.0.1 packaging-23.1 pillow-9.5.0 pytz-2023.3 readthedocs-sphinx-ext-2.2.0 recommonmark-0.5.0 requests-2.28.2 snowballstemmer-2.2.0 sphinx-5.3.0 sphinx-rtd-theme-1.2.0 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-2.0.0 sphinxcontrib-jquery-4.1 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 sphinxcontrib-serializinghtml-1.1.5 typing-extensions-4.5.0 urllib3-1.26.15 zipp-3.15.0 [rtd-command-info] start-time: 2023-04-21T11:10:30.455651Z, end-time: 2023-04-21T11:10:31.394906Z, duration: 0, 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/latest/lib/python3.7/site-packages (from -r requirements.txt (line 1)) (5.3.0) Requirement already satisfied: sphinx_rtd_theme in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from -r requirements.txt (line 2)) (1.2.0) Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (1.0.2) Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (1.0.2) Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/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/latest/lib/python3.7/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (2.0.0) Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (1.1.5) Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (1.0.3) Requirement already satisfied: Jinja2>=3.0 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (3.1.2) Requirement already satisfied: Pygments>=2.12 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (2.15.1) Requirement already satisfied: docutils<0.20,>=0.14 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (0.18.1) Requirement already satisfied: snowballstemmer>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (2.2.0) Requirement already satisfied: babel>=2.9 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (2.12.1) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (0.7.13) Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (1.4.1) Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (2.28.2) Requirement already satisfied: packaging>=21.0 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (23.1) Requirement already satisfied: importlib-metadata>=4.8 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from sphinx>=2.4->-r requirements.txt (line 1)) (6.5.0) Requirement already satisfied: sphinxcontrib-jquery!=3.0.0,>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from sphinx_rtd_theme->-r requirements.txt (line 2)) (4.1) Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from babel>=2.9->sphinx>=2.4->-r requirements.txt (line 1)) (2023.3) Requirement already satisfied: zipp>=0.5 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from importlib-metadata>=4.8->sphinx>=2.4->-r requirements.txt (line 1)) (3.15.0) Requirement already satisfied: typing-extensions>=3.6.4 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from importlib-metadata>=4.8->sphinx>=2.4->-r requirements.txt (line 1)) (4.5.0) Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from Jinja2>=3.0->sphinx>=2.4->-r requirements.txt (line 1)) (2.1.2) Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx>=2.4->-r requirements.txt (line 1)) (3.1.0) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx>=2.4->-r requirements.txt (line 1)) (3.4) Requirement already satisfied: urllib3<1.27,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx>=2.4->-r requirements.txt (line 1)) (1.26.15) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/iiasa-energy-program-ece-docs/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx>=2.4->-r requirements.txt (line 1)) (2022.12.7) [rtd-command-info] start-time: 2023-04-21T11:10:32.935913Z, end-time: 2023-04-21T11:10:33.021297Z, 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 os # import sys # sys.path.insert(0, os.path.abspath('.')) # -- Project information ----------------------------------------------------- project = "ece-docs" copyright = "2023 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 = [] # 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 = [] # -- 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", ] ########################################################################### # 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') # 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: html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} # This following legacy behavior will gradually be sliced out until its deprecated and removed. # Skipped for Sphinx 6+ # Skipped by internal Feature flag SKIP_SPHINX_HTML_THEME_PATH # Skipped by all new projects since SKIP_SPHINX_HTML_THEME_PATH's introduction (jan 2023) if ( using_rtd_theme and version_info < (6,0) and not False ): theme = importlib.import_module('sphinx_rtd_theme') if 'html_theme_path' in globals(): html_theme_path.append(theme.get_html_theme_path()) else: html_theme_path = [theme.get_html_theme_path()] # Define websupport2_base_url and websupport2_static_url 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", 'proxied_static_path': "/_/static/", 'versions': [ ], 'downloads': [ ], 'subprojects': [ ], 'slug': 'iiasa-energy-program-ece-docs', 'name': u'ece-docs', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': 'https://iiasa-energy-program-ece-docs.readthedocs-hosted.com/en/latest/', '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': 'main', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'main', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': 'main', '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': 'd6222a81', } # 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-ece-docs/builds/1427765/' 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: 2023-04-21T11:10:33.220110Z, end-time: 2023-04-21T11:10:34.275739Z, duration: 1, exit-code: 0 python -m sphinx -T -E -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html Running Sphinx v5.3.0 making output directory... done building [mo]: targets for 0 po files that are out of date building [html]: targets for 1 source files that are out of date updating environment: [new config] 1 added, 0 changed, 0 removed reading sources... [100%] index looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [100%] index generating indices... genindex done writing additional pages... search done copying static files... done copying extra files... done 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. [rtd-command-info] start-time: 2023-04-21T11:10:34.510320Z, end-time: 2023-04-21T11:10:35.218090Z, duration: 0, exit-code: 0 python -m sphinx -T -E -b readthedocssinglehtmllocalmedia -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/htmlzip Running Sphinx v5.3.0 making output directory... done building [mo]: targets for 0 po files that are out of date building [readthedocssinglehtmllocalmedia]: all documents updating environment: [new config] 1 added, 0 changed, 0 removed reading sources... [100%] index looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done assembling single document... done writing... done writing additional files... done copying static files... done copying extra files... done dumping object inventory... done Updating searchtools for Read the Docs search... build succeeded. The HTML page is in _readthedocs/htmlzip.