Read the Docs build information Build id: 1597591 Project: northeastern-university-rc-public-documentation Version: latest Commit: c32529b5eb55fce5921a00de26cbdf5758c17369 Date: 2023-07-13T19:57:21.885372Z State: cancelled Success: False [rtd-command-info] start-time: 2023-07-13T20:02:27.319159Z, end-time: 2023-07-13T20:02:32.285280Z, duration: 4, exit-code: 0 git clone --no-single-branch --depth 50 https://github.com/northeastern-rc/rc-public-documentation . Cloning into '.'... [rtd-command-info] start-time: 2023-07-13T20:02:32.694654Z, end-time: 2023-07-13T20:02:33.516011Z, duration: 0, exit-code: 0 git checkout --force origin/master Note: switching to '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 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 c32529b Merge pull request #98 from northeastern-rc/joe/issues [rtd-command-info] start-time: 2023-07-13T20:02:33.734146Z, end-time: 2023-07-13T20:02:33.840614Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2023-07-13T20:02:37.614670Z, end-time: 2023-07-13T20:02:45.902004Z, duration: 8, 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/northeastern-university-rc-public-documentation/envs/latest/bin/python3.7 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2023-07-13T20:02:46.117580Z, end-time: 2023-07-13T20:02:48.110582Z, 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/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (23.1.2) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (68.0.0) [rtd-command-info] start-time: 2023-07-13T20:02:48.395005Z, end-time: 2023-07-13T20:03:00.188820Z, duration: 11, 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<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<2.3 jinja2<3.1.0 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 64.8 MB/s eta 0:00:00 Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 kB 122.6 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 92.0 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<2 Downloading Sphinx-1.8.6-py2.py3-none-any.whl (3.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.1/3.1 MB 37.5 MB/s eta 0:00:00 Collecting sphinx-rtd-theme<0.5 Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 6.4/6.4 MB 97.4 MB/s eta 0:00:00 Collecting readthedocs-sphinx-ext<2.3 Downloading readthedocs_sphinx_ext-2.2.2-py2.py3-none-any.whl (11 kB) Collecting jinja2<3.1.0 Downloading Jinja2-3.0.3-py3-none-any.whl (133 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.6/133.6 kB 107.3 MB/s eta 0:00:00 Collecting docutils>=0.11 (from recommonmark==0.5.0) Downloading docutils-0.20.1-py3-none-any.whl (572 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 572.7/572.7 kB 121.7 MB/s eta 0:00:00 Collecting six>=1.5 (from sphinx<2) Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Collecting Pygments>=2.0 (from sphinx<2) Downloading Pygments-2.15.1-py3-none-any.whl (1.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.1/1.1 MB 123.3 MB/s eta 0:00:00 Collecting docutils>=0.11 (from recommonmark==0.5.0) Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 575.5/575.5 kB 119.3 MB/s eta 0:00:00 Collecting snowballstemmer>=1.1 (from sphinx<2) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 103.6 MB/s eta 0:00:00 Collecting babel!=2.0,>=1.3 (from sphinx<2) Downloading Babel-2.12.1-py3-none-any.whl (10.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 10.1/10.1 MB 113.2 MB/s eta 0:00:00 Collecting imagesize (from sphinx<2) Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Collecting requests>=2.0.0 (from sphinx<2) Downloading requests-2.31.0-py3-none-any.whl (62 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.6/62.6 kB 78.8 MB/s eta 0:00:00 Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from sphinx<2) (68.0.0) Collecting packaging (from sphinx<2) Downloading packaging-23.1-py3-none-any.whl (48 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 48.9/48.9 kB 98.5 MB/s eta 0:00:00 Collecting sphinxcontrib-websupport (from sphinx<2) Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB) Collecting MarkupSafe>=2.0 (from jinja2<3.1.0) Downloading MarkupSafe-2.1.3-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB) Collecting pytz>=2015.7 (from babel!=2.0,>=1.3->sphinx<2) Downloading pytz-2023.3-py2.py3-none-any.whl (502 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 502.3/502.3 kB 116.7 MB/s eta 0:00:00 Collecting charset-normalizer<4,>=2 (from requests>=2.0.0->sphinx<2) Downloading charset_normalizer-3.2.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (175 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 175.8/175.8 kB 106.7 MB/s eta 0:00:00 Collecting idna<4,>=2.5 (from requests>=2.0.0->sphinx<2) Downloading idna-3.4-py3-none-any.whl (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.5/61.5 kB 94.7 MB/s eta 0:00:00 Collecting urllib3<3,>=1.21.1 (from requests>=2.0.0->sphinx<2) Downloading urllib3-2.0.3-py3-none-any.whl (123 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 123.6/123.6 kB 98.4 MB/s eta 0:00:00 Collecting certifi>=2017.4.17 (from requests>=2.0.0->sphinx<2) Downloading certifi-2023.5.7-py3-none-any.whl (156 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 157.0/157.0 kB 104.0 MB/s eta 0:00:00 Collecting sphinxcontrib-serializinghtml (from sphinxcontrib-websupport->sphinx<2) Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 94.0/94.0 kB 104.8 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=23753 sha256=dc55bd73476e50ad6819bf7a791eddf7ff73c0f9adbfd4a13a61dd2594128878 Stored in directory: /tmp/pip-ephem-wheel-cache-mk4dnfy6/wheels/7a/94/b1/0fdc5339a5bd487a5cc15421ec200d9ba3e2aa7190e4a727f1 Successfully built mock Installing collected packages: snowballstemmer, pytz, mock, commonmark, urllib3, sphinxcontrib-serializinghtml, six, Pygments, pillow, packaging, MarkupSafe, imagesize, idna, docutils, charset-normalizer, certifi, babel, alabaster, sphinxcontrib-websupport, requests, jinja2, sphinx, readthedocs-sphinx-ext, sphinx-rtd-theme, recommonmark Successfully installed MarkupSafe-2.1.3 Pygments-2.15.1 alabaster-0.7.13 babel-2.12.1 certifi-2023.5.7 charset-normalizer-3.2.0 commonmark-0.9.1 docutils-0.17.1 idna-3.4 imagesize-1.4.1 jinja2-3.0.3 mock-1.0.1 packaging-23.1 pillow-9.5.0 pytz-2023.3 readthedocs-sphinx-ext-2.2.2 recommonmark-0.5.0 requests-2.31.0 six-1.16.0 snowballstemmer-2.2.0 sphinx-1.8.6 sphinx-rtd-theme-0.4.3 sphinxcontrib-serializinghtml-1.1.5 sphinxcontrib-websupport-1.2.4 urllib3-2.0.3 [rtd-command-info] start-time: 2023-07-13T20:03:00.469434Z, end-time: 2023-07-13T20:03:27.483015Z, duration: 27, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r docs/requirements.txt Collecting jupyterlab-myst (from -r docs/requirements.txt (line 1)) Downloading jupyterlab_myst-1.2.0-py3-none-any.whl (2.6 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.6/2.6 MB 54.8 MB/s eta 0:00:00 Collecting myst-nb (from -r docs/requirements.txt (line 2)) Downloading myst_nb-0.17.2-py3-none-any.whl (78 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 78.6/78.6 kB 100.0 MB/s eta 0:00:00 Collecting myst-parser (from -r docs/requirements.txt (line 3)) Downloading myst_parser-1.0.0-py3-none-any.whl (77 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 77.3/77.3 kB 100.4 MB/s eta 0:00:00 Collecting sphinx-book-theme (from -r docs/requirements.txt (line 4)) Downloading sphinx_book_theme-1.0.1-py3-none-any.whl (396 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 396.9/396.9 kB 117.1 MB/s eta 0:00:00 Collecting sphinx-copybutton (from -r docs/requirements.txt (line 5)) Downloading sphinx_copybutton-0.5.2-py3-none-any.whl (13 kB) Collecting sphinx-tabs (from -r docs/requirements.txt (line 6)) Downloading sphinx_tabs-3.4.1-py3-none-any.whl (10.0 kB) Collecting sphinx-togglebutton (from -r docs/requirements.txt (line 7)) Downloading sphinx_togglebutton-0.3.2-py3-none-any.whl (8.2 kB) Collecting sphinx_design (from -r docs/requirements.txt (line 8)) Downloading sphinx_design-0.4.1-py3-none-any.whl (2.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 110.8 MB/s eta 0:00:00 Collecting sphinxcontrib-bibtex (from -r docs/requirements.txt (line 9)) Downloading sphinxcontrib_bibtex-2.5.0-py3-none-any.whl (39 kB) Collecting importlib_metadata (from myst-nb->-r docs/requirements.txt (line 2)) Downloading importlib_metadata-6.7.0-py3-none-any.whl (22 kB) Collecting ipython (from myst-nb->-r docs/requirements.txt (line 2)) Downloading ipython-7.34.0-py3-none-any.whl (793 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 793.8/793.8 kB 117.4 MB/s eta 0:00:00 Collecting jupyter-cache<0.7,>=0.5 (from myst-nb->-r docs/requirements.txt (line 2)) Downloading jupyter_cache-0.5.0-py3-none-any.whl (34 kB) Collecting nbclient (from myst-nb->-r docs/requirements.txt (line 2)) Downloading nbclient-0.7.4-py3-none-any.whl (73 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 73.1/73.1 kB 97.0 MB/s eta 0:00:00 Collecting myst-parser (from -r docs/requirements.txt (line 3)) Downloading myst_parser-0.18.1-py3-none-any.whl (58 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 58.2/58.2 kB 93.9 MB/s eta 0:00:00 Collecting nbformat~=5.0 (from myst-nb->-r docs/requirements.txt (line 2)) Downloading nbformat-5.8.0-py3-none-any.whl (77 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 77.4/77.4 kB 102.5 MB/s eta 0:00:00 Collecting pyyaml (from myst-nb->-r docs/requirements.txt (line 2)) Downloading PyYAML-6.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (596 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 596.3/596.3 kB 116.5 MB/s eta 0:00:00 Collecting sphinx<6,>=4 (from myst-nb->-r docs/requirements.txt (line 2)) Downloading sphinx-5.3.0-py3-none-any.whl (3.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.2/3.2 MB 116.8 MB/s eta 0:00:00 Collecting typing-extensions (from myst-nb->-r docs/requirements.txt (line 2)) Downloading typing_extensions-4.7.1-py3-none-any.whl (33 kB) Collecting ipykernel (from myst-nb->-r docs/requirements.txt (line 2)) Downloading ipykernel-6.16.2-py3-none-any.whl (138 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 138.5/138.5 kB 108.9 MB/s eta 0:00:00 Requirement already satisfied: docutils<0.20,>=0.15 in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from myst-parser->-r docs/requirements.txt (line 3)) (0.17.1) Requirement already satisfied: jinja2 in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from myst-parser->-r docs/requirements.txt (line 3)) (3.0.3) Collecting markdown-it-py<3.0.0,>=1.0.0 (from myst-parser->-r docs/requirements.txt (line 3)) Downloading markdown_it_py-2.2.0-py3-none-any.whl (84 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 84.5/84.5 kB 99.6 MB/s eta 0:00:00 Collecting mdit-py-plugins~=0.3.1 (from myst-parser->-r docs/requirements.txt (line 3)) Downloading mdit_py_plugins-0.3.5-py3-none-any.whl (52 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 52.1/52.1 kB 90.1 MB/s eta 0:00:00 Collecting pydata-sphinx-theme>=0.13.3 (from sphinx-book-theme->-r docs/requirements.txt (line 4)) Downloading pydata_sphinx_theme-0.13.3-py3-none-any.whl (2.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.0/2.0 MB 118.2 MB/s eta 0:00:00 Requirement already satisfied: pygments in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from sphinx-tabs->-r docs/requirements.txt (line 6)) (2.15.1) Collecting docutils<0.20,>=0.15 (from myst-parser->-r docs/requirements.txt (line 3)) Downloading docutils-0.18.1-py2.py3-none-any.whl (570 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 570.0/570.0 kB 118.2 MB/s eta 0:00:00 Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from sphinx-togglebutton->-r docs/requirements.txt (line 7)) (68.0.0) Requirement already satisfied: wheel in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from sphinx-togglebutton->-r docs/requirements.txt (line 7)) (0.40.0) Collecting pybtex>=0.24 (from sphinxcontrib-bibtex->-r docs/requirements.txt (line 9)) Downloading pybtex-0.24.0-py2.py3-none-any.whl (561 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 561.4/561.4 kB 116.7 MB/s eta 0:00:00 Collecting pybtex-docutils>=1.0.0 (from sphinxcontrib-bibtex->-r docs/requirements.txt (line 9)) Downloading pybtex_docutils-1.0.2-py3-none-any.whl (6.3 kB) Collecting zipp>=0.5 (from importlib_metadata->myst-nb->-r docs/requirements.txt (line 2)) Downloading zipp-3.15.0-py3-none-any.whl (6.8 kB) Collecting attrs (from jupyter-cache<0.7,>=0.5->myst-nb->-r docs/requirements.txt (line 2)) Downloading attrs-23.1.0-py3-none-any.whl (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.2/61.2 kB 101.9 MB/s eta 0:00:00 Collecting click (from jupyter-cache<0.7,>=0.5->myst-nb->-r docs/requirements.txt (line 2)) Downloading click-8.1.5-py3-none-any.whl (98 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 98.1/98.1 kB 107.5 MB/s eta 0:00:00 Collecting nbclient (from myst-nb->-r docs/requirements.txt (line 2)) Downloading nbclient-0.5.13-py3-none-any.whl (70 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 70.6/70.6 kB 103.7 MB/s eta 0:00:00 Collecting sqlalchemy<1.5,>=1.3.12 (from jupyter-cache<0.7,>=0.5->myst-nb->-r docs/requirements.txt (line 2)) Downloading SQLAlchemy-1.4.49-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.6 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.6/1.6 MB 116.0 MB/s eta 0:00:00 Collecting tabulate (from jupyter-cache<0.7,>=0.5->myst-nb->-r docs/requirements.txt (line 2)) Downloading tabulate-0.9.0-py3-none-any.whl (35 kB) Collecting mdurl~=0.1 (from markdown-it-py<3.0.0,>=1.0.0->myst-parser->-r docs/requirements.txt (line 3)) Downloading mdurl-0.1.2-py3-none-any.whl (10.0 kB) Collecting traitlets>=5.0.0 (from nbclient->myst-nb->-r docs/requirements.txt (line 2)) Downloading traitlets-5.9.0-py3-none-any.whl (117 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 117.4/117.4 kB 107.4 MB/s eta 0:00:00 Collecting jupyter-client>=6.1.5 (from nbclient->myst-nb->-r docs/requirements.txt (line 2)) Downloading jupyter_client-7.4.9-py3-none-any.whl (133 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.5/133.5 kB 106.8 MB/s eta 0:00:00 Collecting nest-asyncio (from nbclient->myst-nb->-r docs/requirements.txt (line 2)) Downloading nest_asyncio-1.5.6-py3-none-any.whl (5.2 kB) Collecting fastjsonschema (from nbformat~=5.0->myst-nb->-r docs/requirements.txt (line 2)) Downloading fastjsonschema-2.17.1-py3-none-any.whl (23 kB) Collecting jsonschema>=2.6 (from nbformat~=5.0->myst-nb->-r docs/requirements.txt (line 2)) Downloading jsonschema-4.17.3-py3-none-any.whl (90 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 90.4/90.4 kB 105.1 MB/s eta 0:00:00 Collecting jupyter-core (from nbformat~=5.0->myst-nb->-r docs/requirements.txt (line 2)) Downloading jupyter_core-4.12.0-py3-none-any.whl (89 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 89.9/89.9 kB 98.1 MB/s eta 0:00:00 Collecting latexcodec>=1.0.4 (from pybtex>=0.24->sphinxcontrib-bibtex->-r docs/requirements.txt (line 9)) Downloading latexcodec-2.0.1-py2.py3-none-any.whl (18 kB) Requirement already satisfied: six in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from pybtex>=0.24->sphinxcontrib-bibtex->-r docs/requirements.txt (line 9)) (1.16.0) Collecting beautifulsoup4 (from pydata-sphinx-theme>=0.13.3->sphinx-book-theme->-r docs/requirements.txt (line 4)) Downloading beautifulsoup4-4.12.2-py3-none-any.whl (142 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 143.0/143.0 kB 109.5 MB/s eta 0:00:00 Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from pydata-sphinx-theme>=0.13.3->sphinx-book-theme->-r docs/requirements.txt (line 4)) (23.1) Requirement already satisfied: Babel in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from pydata-sphinx-theme>=0.13.3->sphinx-book-theme->-r docs/requirements.txt (line 4)) (2.12.1) Collecting accessible-pygments (from pydata-sphinx-theme>=0.13.3->sphinx-book-theme->-r docs/requirements.txt (line 4)) Downloading accessible_pygments-0.0.4-py2.py3-none-any.whl (29 kB) Collecting sphinxcontrib-applehelp (from sphinx<6,>=4->myst-nb->-r docs/requirements.txt (line 2)) Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.2/121.2 kB 108.8 MB/s eta 0:00:00 Collecting sphinxcontrib-devhelp (from sphinx<6,>=4->myst-nb->-r docs/requirements.txt (line 2)) Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 84.7/84.7 kB 102.9 MB/s eta 0:00:00 Collecting sphinxcontrib-jsmath (from sphinx<6,>=4->myst-nb->-r docs/requirements.txt (line 2)) Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Collecting sphinxcontrib-htmlhelp>=2.0.0 (from sphinx<6,>=4->myst-nb->-r docs/requirements.txt (line 2)) Downloading sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl (100 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100.5/100.5 kB 101.4 MB/s eta 0:00:00 Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from sphinx<6,>=4->myst-nb->-r docs/requirements.txt (line 2)) (1.1.5) Collecting sphinxcontrib-qthelp (from sphinx<6,>=4->myst-nb->-r docs/requirements.txt (line 2)) Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 90.6/90.6 kB 108.7 MB/s eta 0:00:00 Requirement already satisfied: snowballstemmer>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from sphinx<6,>=4->myst-nb->-r docs/requirements.txt (line 2)) (2.2.0) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from sphinx<6,>=4->myst-nb->-r docs/requirements.txt (line 2)) (0.7.13) Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from sphinx<6,>=4->myst-nb->-r docs/requirements.txt (line 2)) (1.4.1) Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from sphinx<6,>=4->myst-nb->-r docs/requirements.txt (line 2)) (2.31.0) Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from jinja2->myst-parser->-r docs/requirements.txt (line 3)) (2.1.3) Collecting debugpy>=1.0 (from ipykernel->myst-nb->-r docs/requirements.txt (line 2)) Downloading debugpy-1.6.7-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.9 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.9/2.9 MB 115.7 MB/s eta 0:00:00 Collecting matplotlib-inline>=0.1 (from ipykernel->myst-nb->-r docs/requirements.txt (line 2)) Downloading matplotlib_inline-0.1.6-py3-none-any.whl (9.4 kB) Collecting psutil (from ipykernel->myst-nb->-r docs/requirements.txt (line 2)) Downloading psutil-5.9.5-cp36-abi3-manylinux_2_12_x86_64.manylinux2010_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (282 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 282.1/282.1 kB 112.6 MB/s eta 0:00:00 Collecting pyzmq>=17 (from ipykernel->myst-nb->-r docs/requirements.txt (line 2)) Downloading pyzmq-25.1.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.whl (1.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.1/1.1 MB 116.4 MB/s eta 0:00:00 Collecting tornado>=6.1 (from ipykernel->myst-nb->-r docs/requirements.txt (line 2)) Downloading tornado-6.2-cp37-abi3-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (423 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 424.0/424.0 kB 115.6 MB/s eta 0:00:00 Collecting jedi>=0.16 (from ipython->myst-nb->-r docs/requirements.txt (line 2)) Downloading jedi-0.18.2-py2.py3-none-any.whl (1.6 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.6/1.6 MB 115.7 MB/s eta 0:00:00 Collecting decorator (from ipython->myst-nb->-r docs/requirements.txt (line 2)) Downloading decorator-5.1.1-py3-none-any.whl (9.1 kB) Collecting pickleshare (from ipython->myst-nb->-r docs/requirements.txt (line 2)) Downloading pickleshare-0.7.5-py2.py3-none-any.whl (6.9 kB) Collecting prompt-toolkit!=3.0.0,!=3.0.1,<3.1.0,>=2.0.0 (from ipython->myst-nb->-r docs/requirements.txt (line 2)) Downloading prompt_toolkit-3.0.39-py3-none-any.whl (385 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 385.2/385.2 kB 109.9 MB/s eta 0:00:00 Collecting backcall (from ipython->myst-nb->-r docs/requirements.txt (line 2)) Downloading backcall-0.2.0-py2.py3-none-any.whl (11 kB) Collecting pexpect>4.3 (from ipython->myst-nb->-r docs/requirements.txt (line 2)) Downloading pexpect-4.8.0-py2.py3-none-any.whl (59 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 59.0/59.0 kB 78.2 MB/s eta 0:00:00 Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from Babel->pydata-sphinx-theme>=0.13.3->sphinx-book-theme->-r docs/requirements.txt (line 4)) (2023.3) Collecting parso<0.9.0,>=0.8.0 (from jedi>=0.16->ipython->myst-nb->-r docs/requirements.txt (line 2)) Downloading parso-0.8.3-py2.py3-none-any.whl (100 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100.8/100.8 kB 98.6 MB/s eta 0:00:00 Collecting importlib-resources>=1.4.0 (from jsonschema>=2.6->nbformat~=5.0->myst-nb->-r docs/requirements.txt (line 2)) Downloading importlib_resources-5.12.0-py3-none-any.whl (36 kB) Collecting pkgutil-resolve-name>=1.3.10 (from jsonschema>=2.6->nbformat~=5.0->myst-nb->-r docs/requirements.txt (line 2)) Downloading pkgutil_resolve_name-1.3.10-py3-none-any.whl (4.7 kB) Collecting pyrsistent!=0.17.0,!=0.17.1,!=0.17.2,>=0.14.0 (from jsonschema>=2.6->nbformat~=5.0->myst-nb->-r docs/requirements.txt (line 2)) Downloading pyrsistent-0.19.3-py3-none-any.whl (57 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 57.5/57.5 kB 91.4 MB/s eta 0:00:00 Collecting entrypoints (from jupyter-client>=6.1.5->nbclient->myst-nb->-r docs/requirements.txt (line 2)) Downloading entrypoints-0.4-py3-none-any.whl (5.3 kB) Collecting python-dateutil>=2.8.2 (from jupyter-client>=6.1.5->nbclient->myst-nb->-r docs/requirements.txt (line 2)) Downloading python_dateutil-2.8.2-py2.py3-none-any.whl (247 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 247.7/247.7 kB 112.9 MB/s eta 0:00:00 Collecting ptyprocess>=0.5 (from pexpect>4.3->ipython->myst-nb->-r docs/requirements.txt (line 2)) Downloading ptyprocess-0.7.0-py2.py3-none-any.whl (13 kB) Collecting wcwidth (from prompt-toolkit!=3.0.0,!=3.0.1,<3.1.0,>=2.0.0->ipython->myst-nb->-r docs/requirements.txt (line 2)) Downloading wcwidth-0.2.6-py2.py3-none-any.whl (29 kB) Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx<6,>=4->myst-nb->-r docs/requirements.txt (line 2)) (3.2.0) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx<6,>=4->myst-nb->-r docs/requirements.txt (line 2)) (3.4) Requirement already satisfied: urllib3<3,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx<6,>=4->myst-nb->-r docs/requirements.txt (line 2)) (2.0.3) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/northeastern-university-rc-public-documentation/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx<6,>=4->myst-nb->-r docs/requirements.txt (line 2)) (2023.5.7) Collecting greenlet!=0.4.17 (from sqlalchemy<1.5,>=1.3.12->jupyter-cache<0.7,>=0.5->myst-nb->-r docs/requirements.txt (line 2)) Downloading greenlet-2.0.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (566 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 566.1/566.1 kB 115.9 MB/s eta 0:00:00 Collecting soupsieve>1.2 (from beautifulsoup4->pydata-sphinx-theme>=0.13.3->sphinx-book-theme->-r docs/requirements.txt (line 4)) Downloading soupsieve-2.4.1-py3-none-any.whl (36 kB) Installing collected packages: wcwidth, ptyprocess, pickleshare, fastjsonschema, backcall, zipp, typing-extensions, traitlets, tornado, tabulate, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, soupsieve, pyzmq, pyyaml, python-dateutil, pyrsistent, psutil, prompt-toolkit, pkgutil-resolve-name, pexpect, parso, nest-asyncio, mdurl, latexcodec, jupyterlab-myst, greenlet, entrypoints, docutils, decorator, debugpy, accessible-pygments, pybtex, matplotlib-inline, markdown-it-py, jupyter-core, jedi, importlib-resources, importlib_metadata, beautifulsoup4, sqlalchemy, sphinx, pybtex-docutils, mdit-py-plugins, jupyter-client, ipython, click, attrs, sphinxcontrib-bibtex, sphinx-togglebutton, sphinx-tabs, sphinx_design, sphinx-copybutton, pydata-sphinx-theme, myst-parser, jsonschema, ipykernel, sphinx-book-theme, nbformat, nbclient, jupyter-cache, myst-nb 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.6 Uninstalling Sphinx-1.8.6: Successfully uninstalled Sphinx-1.8.6 Successfully installed accessible-pygments-0.0.4 attrs-23.1.0 backcall-0.2.0 beautifulsoup4-4.12.2 click-8.1.5 debugpy-1.6.7 decorator-5.1.1 docutils-0.18.1 entrypoints-0.4 fastjsonschema-2.17.1 greenlet-2.0.2 importlib-resources-5.12.0 importlib_metadata-6.7.0 ipykernel-6.16.2 ipython-7.34.0 jedi-0.18.2 jsonschema-4.17.3 jupyter-cache-0.5.0 jupyter-client-7.4.9 jupyter-core-4.12.0 jupyterlab-myst-1.2.0 latexcodec-2.0.1 markdown-it-py-2.2.0 matplotlib-inline-0.1.6 mdit-py-plugins-0.3.5 mdurl-0.1.2 myst-nb-0.17.2 myst-parser-0.18.1 nbclient-0.5.13 nbformat-5.8.0 nest-asyncio-1.5.6 parso-0.8.3 pexpect-4.8.0 pickleshare-0.7.5 pkgutil-resolve-name-1.3.10 prompt-toolkit-3.0.39 psutil-5.9.5 ptyprocess-0.7.0 pybtex-0.24.0 pybtex-docutils-1.0.2 pydata-sphinx-theme-0.13.3 pyrsistent-0.19.3 python-dateutil-2.8.2 pyyaml-6.0 pyzmq-25.1.0 soupsieve-2.4.1 sphinx-5.3.0 sphinx-book-theme-1.0.1 sphinx-copybutton-0.5.2 sphinx-tabs-3.4.1 sphinx-togglebutton-0.3.2 sphinx_design-0.4.1 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-bibtex-2.5.0 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-2.0.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 sqlalchemy-1.4.49 tabulate-0.9.0 tornado-6.2 traitlets-5.9.0 typing-extensions-4.7.1 wcwidth-0.2.6 zipp-3.15.0 [rtd-command-info] start-time: 2023-07-13T20:03:30.660108Z, end-time: 2023-07-13T20:03:30.737721Z, duration: 0, exit-code: 0 cat docs/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: # http://www.sphinx-doc.org/en/master/config # -- 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 = "HPC Documentation" logo = "_static/logo-square.png" copyright = "2023" author = "Research Computing, Northeastern University" # The full version, including alpha/beta/rc tags release = "2.0.0" # -- 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 = [ "myst_nb", "sphinx.ext.autodoc", "sphinx.ext.autosectionlabel", "sphinx.ext.intersphinx", "sphinx.ext.viewcode", "sphinx_copybutton", "sphinx_design", # https://pypi.org/project/sphinx_design/ "sphinx_tabs.tabs", "sphinx_togglebutton", # https://sphinx-togglebutton.readthedocs.io/en/latest/use.html # "sphinxcontrib.bibtex", # "sphinxext.opengraph", # For the kitchen sink "sphinx.ext.todo", 'sphinx.ext.autosectionlabel', ] # Prefix document path to section labels, to use: # `path/to/file:heading` instead of just `heading` autosectionlabel_prefix_document = True intersphinx_mapping = {"python": ("https://docs.python.org/3", None)} myst_enable_extensions = [ "colon_fence", "deflist", "dollarmath", ] # 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 = ["first_steps/cps_ood.md", "using-discovery/bash.md", "_snippets/*"] # -- 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_book_theme" # add logo to the upper left in the help system html_logo = "_static/logo-square.png" html_theme_options = { "show_toc_level": 2, "repository_url": "https://github.com/northeastern-rc/rc-public-documentation", "use_repository_button": True, "use_edit_page_button": False, "use_issues_button": True, } # custom css file html_css_files = ["../css/custom.css"] # If true, “(C) Copyright …” is shown in the HTML footer. Default is True. html_show_copyright = True # If true, “Created using Sphinx” is shown in the HTML footer. Default is True. html_show_sphinx = False # 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", "_static/video"] master_doc = "index" source_suffix = [".rst", ".md"] ########################################################################### # 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': [ ("latest", "/en/latest/"), ("2.0.0", "/en/2.0.0/"), ("1.2.0", "/en/1.2.0/"), ("v1.1.0", "/en/v1.1.0/"), ("spack-update", "/en/spack-update/"), ], 'downloads': [ ("pdf", "//rc-docs.northeastern.edu/_/downloads/en/latest/pdf/"), ("html", "//rc-docs.northeastern.edu/_/downloads/en/latest/htmlzip/"), ("epub", "//rc-docs.northeastern.edu/_/downloads/en/latest/epub/"), ], 'subprojects': [ ], 'slug': 'northeastern-university-rc-public-documentation', 'name': u'rc-public-documentation', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': '', 'analytics_code': 'UA-53190950-13', 'single_version': False, 'conf_py_path': '/docs/source/', 'api_host': 'https://readthedocs.com', 'github_user': 'northeastern-rc', 'proxied_api_host': '/_', 'github_repo': 'rc-public-documentation', '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-53190950-13', 'global_analytics_code': 'UA-17997319-2', 'commit': 'c32529b5', } # 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 'branch' == 'external': extensions.insert(1, "readthedocs_ext.external_version_warning") readthedocs_vcs_url = 'None' readthedocs_build_url = 'https://readthedocs.com/projects/northeastern-university-rc-public-documentation/builds/1597591/' 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'])