Read the Docs build information Build id: 1985625 Project: mpgperegrine-rtd-peregrine Version: latest Commit: 125da377eeeee8f6f7e9b1392beb00734d05bcd7 Date: 2024-01-31T18:01:36.506651Z State: finished Success: True [rtd-command-info] start-time: 2024-01-31T18:02:35.238279Z, end-time: 2024-01-31T18:02:36.438592Z, duration: 1, exit-code: 0 git clone --depth 1 git@github.com:MindPointGroup/rtd-peregrine.git . Cloning into '.'... Warning: Permanently added 'github.com' (ED25519) to the list of known hosts. [rtd-command-info] start-time: 2024-01-31T18:02:36.510447Z, end-time: 2024-01-31T18:02:37.781329Z, duration: 1, exit-code: 0 git fetch origin --force --prune --prune-tags --depth 50 refs/heads/main:refs/remotes/origin/main Warning: Permanently added 'github.com' (ED25519) to the list of known hosts. [rtd-command-info] start-time: 2024-01-31T18:02:37.912248Z, end-time: 2024-01-31T18:02:37.967524Z, 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 125da37 Create peregrine-v2.5.1.rst [rtd-command-info] start-time: 2024-01-31T18:02:38.052810Z, end-time: 2024-01-31T18:02:38.110522Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2024-01-31T18:02:38.194276Z, end-time: 2024-01-31T18:02:38.253145Z, 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 version: "2" build: os: "ubuntu-22.04" tools: python: "3.10" golang: "1.19" python: install: - requirements: docs/requirements.txt sphinx: configuration: docs/source/conf.py # Optionally build your docs in additional formats such as PDF and ePub # formats: # - pdf # - epub # Optional but recommended, declare the Python requirements required # to build your documentation # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html # python: # install: # - requirements: docs/requirements.txt [rtd-command-info] start-time: 2024-01-31T18:02:43.958317Z, end-time: 2024-01-31T18:02:44.035169Z, duration: 0, exit-code: 0 asdf global python 3.10.13 [rtd-command-info] start-time: 2024-01-31T18:02:51.056688Z, end-time: 2024-01-31T18:02:51.137277Z, duration: 0, exit-code: 0 asdf global golang 1.19.10 [rtd-command-info] start-time: 2024-01-31T18:02:51.373879Z, end-time: 2024-01-31T18:02:52.691338Z, duration: 1, exit-code: 0 python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH created virtual environment CPython3.10.13.final.0-64 in 806ms creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest, 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-01-31T18:02:52.765075Z, end-time: 2024-01-31T18:03:02.421099Z, duration: 9, 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/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (23.1) Collecting pip Downloading pip-23.3.2-py3-none-any.whl (2.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.1/2.1 MB 10.9 MB/s eta 0:00:00 Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (67.6.1) Collecting setuptools Downloading setuptools-69.0.3-py3-none-any.whl (819 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 819.5/819.5 kB 22.0 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-23.3.2 setuptools-69.0.3 [rtd-command-info] start-time: 2024-01-31T18:03:02.500046Z, end-time: 2024-01-31T18:03:08.546538Z, duration: 6, exit-code: 0 python -m pip install --upgrade --no-cache-dir sphinx readthedocs-sphinx-ext Collecting sphinx Downloading sphinx-7.2.6-py3-none-any.whl.metadata (5.9 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 (5.1 kB) Collecting sphinxcontrib-htmlhelp>=2.0.0 (from sphinx) Downloading sphinxcontrib_htmlhelp-2.0.5-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.7-py3-none-any.whl.metadata (2.2 kB) Collecting Jinja2>=3.0 (from sphinx) Downloading Jinja2-3.1.3-py3-none-any.whl.metadata (3.3 kB) Collecting Pygments>=2.14 (from sphinx) Downloading pygments-2.17.2-py3-none-any.whl.metadata (2.6 kB) Collecting docutils<0.21,>=0.18.1 (from sphinx) Downloading docutils-0.20.1-py3-none-any.whl.metadata (2.8 kB) Collecting snowballstemmer>=2.0 (from sphinx) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 6.3 MB/s eta 0:00:00 Collecting babel>=2.9 (from sphinx) Downloading Babel-2.14.0-py3-none-any.whl.metadata (1.6 kB) Collecting alabaster<0.8,>=0.7 (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 (8.8 kB) Collecting requests>=2.25.0 (from sphinx) Downloading requests-2.31.0-py3-none-any.whl.metadata (4.6 kB) Collecting packaging>=21.0 (from sphinx) Downloading packaging-23.2-py3-none-any.whl.metadata (3.2 kB) Collecting MarkupSafe>=2.0 (from Jinja2>=3.0->sphinx) Downloading MarkupSafe-2.1.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (3.0 kB) Collecting charset-normalizer<4,>=2 (from requests>=2.25.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.25.0->sphinx) Downloading idna-3.6-py3-none-any.whl.metadata (9.9 kB) Collecting urllib3<3,>=1.21.1 (from requests>=2.25.0->sphinx) Downloading urllib3-2.2.0-py3-none-any.whl.metadata (6.4 kB) Collecting certifi>=2017.4.17 (from requests>=2.25.0->sphinx) Downloading certifi-2023.11.17-py3-none-any.whl.metadata (2.2 kB) Downloading sphinx-7.2.6-py3-none-any.whl (3.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.2/3.2 MB 87.6 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.14.0-py3-none-any.whl (11.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 11.0/11.0 MB 205.1 MB/s eta 0:00:00 Downloading docutils-0.20.1-py3-none-any.whl (572 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 572.7/572.7 kB 288.4 MB/s eta 0:00:00 Downloading Jinja2-3.1.3-py3-none-any.whl (133 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.2/133.2 kB 249.9 MB/s eta 0:00:00 Downloading packaging-23.2-py3-none-any.whl (53 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 53.0/53.0 kB 234.0 MB/s eta 0:00:00 Downloading pygments-2.17.2-py3-none-any.whl (1.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 291.5 MB/s eta 0:00:00 Downloading requests-2.31.0-py3-none-any.whl (62 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.6/62.6 kB 247.2 MB/s eta 0:00:00 Downloading sphinxcontrib_htmlhelp-2.0.5-py3-none-any.whl (99 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 99.2/99.2 kB 263.1 MB/s eta 0:00:00 Downloading sphinxcontrib_serializinghtml-1.1.10-py3-none-any.whl (92 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 92.7/92.7 kB 255.3 MB/s eta 0:00:00 Downloading sphinxcontrib_applehelp-1.0.8-py3-none-any.whl (120 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 120.0/120.0 kB 271.6 MB/s eta 0:00:00 Downloading sphinxcontrib_devhelp-1.0.6-py3-none-any.whl (83 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 83.5/83.5 kB 238.0 MB/s eta 0:00:00 Downloading sphinxcontrib_qthelp-1.0.7-py3-none-any.whl (89 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 89.4/89.4 kB 261.9 MB/s eta 0:00:00 Downloading certifi-2023.11.17-py3-none-any.whl (162 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 162.5/162.5 kB 284.4 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 274.7 MB/s eta 0:00:00 Downloading idna-3.6-py3-none-any.whl (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.6/61.6 kB 238.1 MB/s eta 0:00:00 Downloading MarkupSafe-2.1.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB) Downloading urllib3-2.2.0-py3-none-any.whl (120 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 120.9/120.9 kB 266.6 MB/s eta 0:00:00 Installing collected packages: snowballstemmer, urllib3, 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.3 MarkupSafe-2.1.4 Pygments-2.17.2 alabaster-0.7.16 babel-2.14.0 certifi-2023.11.17 charset-normalizer-3.3.2 docutils-0.20.1 idna-3.6 imagesize-1.4.1 packaging-23.2 readthedocs-sphinx-ext-2.2.5 requests-2.31.0 snowballstemmer-2.2.0 sphinx-7.2.6 sphinxcontrib-applehelp-1.0.8 sphinxcontrib-devhelp-1.0.6 sphinxcontrib-htmlhelp-2.0.5 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.7 sphinxcontrib-serializinghtml-1.1.10 urllib3-2.2.0 [rtd-command-info] start-time: 2024-01-31T18:03:08.624698Z, end-time: 2024-01-31T18:03:11.765103Z, duration: 3, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r docs/requirements.txt Collecting sphinx==7.1.2 (from -r docs/requirements.txt (line 1)) Downloading sphinx-7.1.2-py3-none-any.whl.metadata (5.8 kB) Collecting sphinx-rtd-theme==1.3.0rc1 (from -r docs/requirements.txt (line 2)) Downloading sphinx_rtd_theme-1.3.0rc1-py2.py3-none-any.whl.metadata (4.5 kB) Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from sphinx==7.1.2->-r docs/requirements.txt (line 1)) (1.0.8) Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from sphinx==7.1.2->-r docs/requirements.txt (line 1)) (1.0.6) Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from sphinx==7.1.2->-r docs/requirements.txt (line 1)) (1.0.1) Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from sphinx==7.1.2->-r docs/requirements.txt (line 1)) (2.0.5) Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from sphinx==7.1.2->-r docs/requirements.txt (line 1)) (1.1.10) Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from sphinx==7.1.2->-r docs/requirements.txt (line 1)) (1.0.7) Requirement already satisfied: Jinja2>=3.0 in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from sphinx==7.1.2->-r docs/requirements.txt (line 1)) (3.1.3) Requirement already satisfied: Pygments>=2.13 in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from sphinx==7.1.2->-r docs/requirements.txt (line 1)) (2.17.2) Requirement already satisfied: docutils<0.21,>=0.18.1 in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from sphinx==7.1.2->-r docs/requirements.txt (line 1)) (0.20.1) Requirement already satisfied: snowballstemmer>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from sphinx==7.1.2->-r docs/requirements.txt (line 1)) (2.2.0) Requirement already satisfied: babel>=2.9 in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from sphinx==7.1.2->-r docs/requirements.txt (line 1)) (2.14.0) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from sphinx==7.1.2->-r docs/requirements.txt (line 1)) (0.7.16) Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from sphinx==7.1.2->-r docs/requirements.txt (line 1)) (1.4.1) Requirement already satisfied: requests>=2.25.0 in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from sphinx==7.1.2->-r docs/requirements.txt (line 1)) (2.31.0) Requirement already satisfied: packaging>=21.0 in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from sphinx==7.1.2->-r docs/requirements.txt (line 1)) (23.2) Collecting docutils<0.21,>=0.18.1 (from sphinx==7.1.2->-r docs/requirements.txt (line 1)) Downloading docutils-0.18.1-py2.py3-none-any.whl (570 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 570.0/570.0 kB 10.4 MB/s eta 0:00:00 Collecting sphinxcontrib-jquery<5,>=4 (from sphinx-rtd-theme==1.3.0rc1->-r docs/requirements.txt (line 2)) Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.1/121.1 kB 30.6 MB/s eta 0:00:00 Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from Jinja2>=3.0->sphinx==7.1.2->-r docs/requirements.txt (line 1)) (2.1.4) Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from requests>=2.25.0->sphinx==7.1.2->-r docs/requirements.txt (line 1)) (3.3.2) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from requests>=2.25.0->sphinx==7.1.2->-r docs/requirements.txt (line 1)) (3.6) Requirement already satisfied: urllib3<3,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from requests>=2.25.0->sphinx==7.1.2->-r docs/requirements.txt (line 1)) (2.2.0) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/envs/latest/lib/python3.10/site-packages (from requests>=2.25.0->sphinx==7.1.2->-r docs/requirements.txt (line 1)) (2023.11.17) Downloading sphinx-7.1.2-py3-none-any.whl (3.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.2/3.2 MB 21.9 MB/s eta 0:00:00 Downloading sphinx_rtd_theme-1.3.0rc1-py2.py3-none-any.whl (2.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.8/2.8 MB 38.7 MB/s eta 0:00:00 Installing collected packages: docutils, sphinx, sphinxcontrib-jquery, sphinx-rtd-theme Attempting uninstall: docutils Found existing installation: docutils 0.20.1 Uninstalling docutils-0.20.1: Successfully uninstalled docutils-0.20.1 Attempting uninstall: sphinx Found existing installation: Sphinx 7.2.6 Uninstalling Sphinx-7.2.6: Successfully uninstalled Sphinx-7.2.6 Successfully installed docutils-0.18.1 sphinx-7.1.2 sphinx-rtd-theme-1.3.0rc1 sphinxcontrib-jquery-4.1 [rtd-command-info] start-time: 2024-01-31T18:03:12.316375Z, end-time: 2024-01-31T18:03:12.361919Z, duration: 0, exit-code: 0 cat docs/source/conf.py # Configuration file for the Sphinx documentation builder. # -- Project information project = 'MPGPeregrine' copyright = '2023, MPG' author = 'MPG' release = '0.1' version = '0.1.0' # -- General configuration extensions = [ 'sphinx.ext.duration', 'sphinx.ext.doctest', 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.intersphinx', ] intersphinx_mapping = { 'python': ('https://docs.python.org/3/', None), 'sphinx': ('https://www.sphinx-doc.org/en/master/', None), } intersphinx_disabled_domains = ['std'] templates_path = ['_templates'] # -- Options for HTML output html_theme = 'sphinx_rtd_theme' # -- Options for EPUB output epub_show_urls = 'footnote' ########################################################################### # 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': "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': 'mpgperegrine-rtd-peregrine', 'name': u'rtd-peregrine', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': '', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/docs/source/', 'api_host': 'https://readthedocs.com', 'github_user': 'MindPointGroup', 'proxied_api_host': '/_', 'github_repo': 'rtd-peregrine', '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': '125da377', } # 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/mpgperegrine-rtd-peregrine/builds/1985625/' 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-01-31T18:03:12.435497Z, end-time: 2024-01-31T18:03:13.971840Z, duration: 1, exit-code: 0 python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html Running Sphinx v7.1.2 making output directory... done [autosummary] generating autosummary for: api.rst, index.rst, menu.rst, releases/peregrine-v2.5.1.rst, releases/peregrine-v2.5.2.rst, releases/peregrine-v2.6.rst, usage.rst loading intersphinx inventory from https://docs.python.org/3/objects.inv... loading intersphinx inventory from https://www.sphinx-doc.org/en/master/objects.inv... building [mo]: targets for 0 po files that are out of date writing output... building [html]: targets for 7 source files that are out of date updating environment: [new config] 7 added, 0 changed, 0 removed reading sources... [ 14%] api reading sources... [ 29%] index reading sources... [ 43%] menu reading sources... [ 57%] releases/peregrine-v2.5.1 reading sources... [ 71%] releases/peregrine-v2.5.2 reading sources... [ 86%] releases/peregrine-v2.6 reading sources... [100%] usage /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/index.rst:2: WARNING: Title underline too short. Welcome to MPG Peregrine documentation =================================== /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/index.rst:20: WARNING: toctree contains reference to nonexisting document 'releases/peregrine-v2.5.0' /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/menu.rst:2: WARNING: Title underline too short. Peregrine Menu overview ===================== /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/menu.rst:18: ERROR: Unexpected indentation. /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/menu.rst:22: ERROR: Unexpected indentation. /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/menu.rst:26: ERROR: Unexpected indentation. /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/menu.rst:29: ERROR: Unexpected indentation. /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/menu.rst:33: ERROR: Unexpected indentation. /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/menu.rst:38: ERROR: Unexpected indentation. /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/menu.rst:43: ERROR: Unexpected indentation. /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:2: WARNING: Title underline too short. Peregrine v2.5.1 Release Notes ============================ /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:10: WARNING: Title underline too short. Member CID Fixes and Improvements: ------------------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:28: WARNING: Title underline too short. Client Configuration Manager: --------------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:28: WARNING: Title underline too short. Client Configuration Manager: --------------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:44: WARNING: Title underline too short. Activation Screen: ----------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:44: WARNING: Title underline too short. Activation Screen: ----------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:55: WARNING: Title underline too short. RTR (Real Time Response) Manager: ------------------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:55: WARNING: Title underline too short. RTR (Real Time Response) Manager: ------------------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:63: WARNING: Title underline too short. Authenticate Client: ------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:63: WARNING: Title underline too short. Authenticate Client: ------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:68: WARNING: Title underline too short. Host Explorer: ------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:68: WARNING: Title underline too short. Host Explorer: ------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:74: WARNING: Title underline too short. Zero Trust: --------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:74: WARNING: Title underline too short. Zero Trust: --------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:81: WARNING: Title underline too short. Cloud File Explorer: ----------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:81: WARNING: Title underline too short. Cloud File Explorer: ----------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:85: WARNING: Title underline too short. CrowdStrike Detection: -------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:85: WARNING: Title underline too short. CrowdStrike Detection: -------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:90: WARNING: Title underline too short. Configuration File{.env): ---------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:90: WARNING: Title underline too short. Configuration File{.env): ---------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:95: WARNING: Title underline too short. Dependencies: ----------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:95: WARNING: Title underline too short. Dependencies: ----------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:100: WARNING: Title underline too short. Code Review: ---------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:100: WARNING: Title underline too short. Code Review: ---------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:110: WARNING: Title underline too short. Environment Configuration: ------------------------ /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:110: WARNING: Title underline too short. Environment Configuration: ------------------------ /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:115: WARNING: Title underline too short. Online Status: ------------ /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.1.rst:115: WARNING: Title underline too short. Online Status: ------------ /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:2: WARNING: Title underline too short. Release Notes Peregrine v2.5.2 ======================== /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:10: WARNING: Title underline too short. Member CID: --------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:24: WARNING: Title underline too short. Client Configuration Manager: --------------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:24: WARNING: Title underline too short. Client Configuration Manager: --------------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:36: WARNING: Title underline too short. Task Manager: ----------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:36: WARNING: Title underline too short. Task Manager: ----------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:45: WARNING: Title underline too short. Remote File Explorer: ----------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:45: WARNING: Title underline too short. Remote File Explorer: ----------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:62: WARNING: Title underline too short. Ipconfig Batch: ------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:62: WARNING: Title underline too short. Ipconfig Batch: ------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:68: WARNING: Title underline too short. Activation Login: ---------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:68: WARNING: Title underline too short. Activation Login: ---------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:74: WARNING: Title underline too short. CrowdStrike Detection: -------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:74: WARNING: Title underline too short. CrowdStrike Detection: -------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:79: WARNING: Title underline too short. Environment Configuration: ------------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:79: WARNING: Title underline too short. Environment Configuration: ------------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:85: WARNING: Title underline too short. Debug Status: ------------ /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:85: WARNING: Title underline too short. Debug Status: ------------ /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:102: WARNING: Title underline too short. Code Review: ----------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.5.2.rst:102: WARNING: Title underline too short. Code Review: ----------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.6.rst:2: WARNING: Title underline too short. Release Notes Peregrine v2.6 ======================== /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.6.rst:37: WARNING: Title underline too short. CODE REVIEW/CODE CLEAN -------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/releases/peregrine-v2.6.rst:37: WARNING: Title underline too short. CODE REVIEW/CODE CLEAN -------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/usage.rst:23: WARNING: Title underline too short. Activating Peregrine for your organization --------------------------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/usage.rst:23: WARNING: Title underline too short. Activating Peregrine for your organization --------------------------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/usage.rst:52: WARNING: Title underline too short. Activating Peregrine for individual seats in your organization ----------------------------------------------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/usage.rst:52: WARNING: Title underline too short. Activating Peregrine for individual seats in your organization ----------------------------------------------------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/usage.rst:58: WARNING: Enumerated list ends without a blank line; unexpected unindent. /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/usage.rst:60: ERROR: Unexpected indentation. /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/usage.rst:61: WARNING: Block quote ends without a blank line; unexpected unindent. /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/usage.rst:65: WARNING: Title underline too short. Set up the Client ---------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/usage.rst:65: WARNING: Title underline too short. Set up the Client ---------------- /home/docs/checkouts/readthedocs.org/user_builds/mpgperegrine-rtd-peregrine/checkouts/latest/docs/source/usage.rst:81: WARNING: Enumerated list ends without a blank line; unexpected unindent. 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 done writing output... [ 14%] api writing output... [ 29%] index writing output... [ 43%] menu writing output... [ 57%] releases/peregrine-v2.5.1 writing output... [ 71%] releases/peregrine-v2.5.2 writing output... [ 86%] releases/peregrine-v2.6 writing output... [100%] usage generating indices... genindex done writing additional pages... search done dumping search index in English (code: en)... done dumping object inventory... done Updating searchtools for Read the Docs search... ====================== slowest reading durations ======================= 0.037 releases/peregrine-v2.5.1 0.032 releases/peregrine-v2.5.2 0.031 usage 0.026 api 0.015 releases/peregrine-v2.6 build succeeded, 71 warnings. The HTML pages are in ../../_readthedocs/html.