Read the Docs build information Build id: 2045292 Project: menmice-micetro-by-menmice Version: 10.5 Commit: dfad2c09a5f180573491f35ee6286c3150d73cf1 Date: 2024-02-27T13:46:34.254184Z State: finished Success: False [rtd-command-info] start-time: 2024-02-27T13:46:35.394977Z, end-time: 2024-02-27T13:46:38.560473Z, duration: 3, exit-code: 0 git clone --depth 1 https://github.com/menandmice/micetro_docs.git . Cloning into '.'... [rtd-command-info] start-time: 2024-02-27T13:46:38.642281Z, end-time: 2024-02-27T13:46:39.368428Z, duration: 0, exit-code: 0 git fetch origin --force --prune --prune-tags --depth 50 refs/heads/10.5:refs/remotes/origin/10.5 From https://github.com/menandmice/micetro_docs * [new branch] 10.5 -> origin/10.5 [rtd-command-info] start-time: 2024-02-27T13:46:39.511476Z, end-time: 2024-02-27T13:46:40.074159Z, duration: 0, exit-code: 0 git checkout --force origin/10.5 Note: switching to 'origin/10.5'. 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 dfad2c0 Update external_auth.rst [rtd-command-info] start-time: 2024-02-27T13:46:40.146212Z, end-time: 2024-02-27T13:46:40.207446Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2024-02-27T13:46:40.290813Z, end-time: 2024-02-27T13:46:40.349747Z, duration: 0, exit-code: 0 cat .readthedocs.yaml # Read the Docs configuration file for Sphinx projects # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details # Required version: 2 # Set the OS, Python version and other tools you might need build: os: ubuntu-22.04 tools: python: "3.11" # You can also specify other tool versions: # nodejs: "20" # rust: "1.70" # golang: "1.20" # Build documentation in the "docs/" directory with Sphinx sphinx: configuration: conf.py # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs builder: "dirhtml" # Fail on all warnings to avoid broken references # fail_on_warning: true # 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: requirements.txt [rtd-command-info] start-time: 2024-02-27T13:46:46.608116Z, end-time: 2024-02-27T13:46:46.689289Z, duration: 0, exit-code: 0 asdf global python 3.11.6 [rtd-command-info] start-time: 2024-02-27T13:46:47.101584Z, end-time: 2024-02-27T13:46:48.244546Z, duration: 1, exit-code: 0 python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH created virtual environment CPython3.11.6.final.0-64 in 836ms creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5, 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-02-27T13:46:48.317910Z, end-time: 2024-02-27T13:47:00.992787Z, duration: 12, 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/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (23.1) Collecting pip Downloading pip-24.0-py3-none-any.whl (2.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.1/2.1 MB 9.7 MB/s eta 0:00:00 Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (67.6.1) Collecting setuptools Downloading setuptools-69.1.1-py3-none-any.whl (819 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 819.3/819.3 kB 21.9 MB/s eta 0:00:00 Installing collected packages: setuptools, pip Attempting uninstall: setuptools Found existing installation: setuptools 67.6.1 Uninstalling setuptools-67.6.1: Successfully uninstalled setuptools-67.6.1 Attempting uninstall: pip Found existing installation: pip 23.1 Uninstalling pip-23.1: Successfully uninstalled pip-23.1 Successfully installed pip-24.0 setuptools-69.1.1 [rtd-command-info] start-time: 2024-02-27T13:47:01.084275Z, end-time: 2024-02-27T13:47:08.654256Z, duration: 7, 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.metadata (6.5 kB) 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.metadata (1.5 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.5-cp311-cp311-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-cp311-cp311-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.1-py3-none-any.whl.metadata (6.4 kB) Collecting certifi>=2017.4.17 (from requests>=2.25.0->sphinx) Downloading certifi-2024.2.2-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 68.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 167.2 MB/s eta 0:00:00 Downloading docutils-0.20.1-py3-none-any.whl (572 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 572.7/572.7 kB 170.4 MB/s eta 0:00:00 Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Downloading Jinja2-3.1.3-py3-none-any.whl (133 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.2/133.2 kB 152.6 MB/s eta 0:00:00 Downloading packaging-23.2-py3-none-any.whl (53 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 53.0/53.0 kB 143.1 MB/s eta 0:00:00 Downloading pygments-2.17.2-py3-none-any.whl (1.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 176.6 MB/s eta 0:00:00 Downloading requests-2.31.0-py3-none-any.whl (62 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.6/62.6 kB 148.9 MB/s eta 0:00:00 Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 152.6 MB/s eta 0:00:00 Downloading sphinxcontrib_htmlhelp-2.0.5-py3-none-any.whl (99 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 99.2/99.2 kB 147.4 MB/s eta 0:00:00 Downloading sphinxcontrib_serializinghtml-1.1.10-py3-none-any.whl (92 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 92.7/92.7 kB 155.2 MB/s eta 0:00:00 Downloading sphinxcontrib_applehelp-1.0.8-py3-none-any.whl (120 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 120.0/120.0 kB 167.7 MB/s eta 0:00:00 Downloading sphinxcontrib_devhelp-1.0.6-py3-none-any.whl (83 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 83.5/83.5 kB 144.2 MB/s eta 0:00:00 Downloading sphinxcontrib_qthelp-1.0.7-py3-none-any.whl (89 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 89.4/89.4 kB 161.6 MB/s eta 0:00:00 Downloading certifi-2024.2.2-py3-none-any.whl (163 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 163.8/163.8 kB 172.2 MB/s eta 0:00:00 Downloading charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (140 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 140.3/140.3 kB 159.2 MB/s eta 0:00:00 Downloading idna-3.6-py3-none-any.whl (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.6/61.6 kB 145.8 MB/s eta 0:00:00 Downloading MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (28 kB) Downloading urllib3-2.2.1-py3-none-any.whl (121 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.1/121.1 kB 163.8 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.5 Pygments-2.17.2 alabaster-0.7.16 babel-2.14.0 certifi-2024.2.2 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.1 [rtd-command-info] start-time: 2024-02-27T13:47:08.738642Z, end-time: 2024-02-27T13:47:11.932436Z, duration: 3, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r requirements.txt Collecting pillow (from -r requirements.txt (line 1)) Downloading pillow-10.2.0-cp311-cp311-manylinux_2_28_x86_64.whl.metadata (9.7 kB) Collecting mock==1.0.1 (from -r requirements.txt (line 2)) Downloading mock-1.0.1.zip (861 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 kB 9.4 MB/s eta 0:00:00 Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Requirement already satisfied: alabaster!=0.7.5,<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from -r requirements.txt (line 3)) (0.7.16) Collecting commonmark==0.9.1 (from -r requirements.txt (line 4)) Downloading commonmark-0.9.1-py2.py3-none-any.whl (51 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 51.1/51.1 kB 106.6 MB/s eta 0:00:00 Collecting recommonmark==0.5.0 (from -r requirements.txt (line 5)) Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Requirement already satisfied: sphinx in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from -r requirements.txt (line 6)) (7.2.6) Collecting sphinx-rtd-theme (from -r requirements.txt (line 7)) Downloading sphinx_rtd_theme-2.0.0-py2.py3-none-any.whl.metadata (4.4 kB) Requirement already satisfied: readthedocs-sphinx-ext<2.3 in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from -r requirements.txt (line 8)) (2.2.5) Requirement already satisfied: docutils>=0.11 in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from recommonmark==0.5.0->-r requirements.txt (line 5)) (0.20.1) Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from sphinx->-r requirements.txt (line 6)) (1.0.8) Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from sphinx->-r requirements.txt (line 6)) (1.0.6) Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from sphinx->-r requirements.txt (line 6)) (1.0.1) Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from sphinx->-r requirements.txt (line 6)) (2.0.5) Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.9 in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from sphinx->-r requirements.txt (line 6)) (1.1.10) Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from sphinx->-r requirements.txt (line 6)) (1.0.7) Requirement already satisfied: Jinja2>=3.0 in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from sphinx->-r requirements.txt (line 6)) (3.1.3) Requirement already satisfied: Pygments>=2.14 in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from sphinx->-r requirements.txt (line 6)) (2.17.2) Requirement already satisfied: snowballstemmer>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from sphinx->-r requirements.txt (line 6)) (2.2.0) Requirement already satisfied: babel>=2.9 in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from sphinx->-r requirements.txt (line 6)) (2.14.0) Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from sphinx->-r requirements.txt (line 6)) (1.4.1) Requirement already satisfied: requests>=2.25.0 in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from sphinx->-r requirements.txt (line 6)) (2.31.0) Requirement already satisfied: packaging>=21.0 in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from sphinx->-r requirements.txt (line 6)) (23.2) Collecting sphinxcontrib-jquery<5,>=4 (from sphinx-rtd-theme->-r requirements.txt (line 7)) Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl.metadata (2.6 kB) Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from Jinja2>=3.0->sphinx->-r requirements.txt (line 6)) (2.1.5) Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from requests>=2.25.0->sphinx->-r requirements.txt (line 6)) (3.3.2) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from requests>=2.25.0->sphinx->-r requirements.txt (line 6)) (3.6) Requirement already satisfied: urllib3<3,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from requests>=2.25.0->sphinx->-r requirements.txt (line 6)) (2.2.1) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/menmice-micetro-by-menmice/envs/10.5/lib/python3.11/site-packages (from requests>=2.25.0->sphinx->-r requirements.txt (line 6)) (2024.2.2) Downloading pillow-10.2.0-cp311-cp311-manylinux_2_28_x86_64.whl (4.5 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 4.5/4.5 MB 26.0 MB/s eta 0:00:00 Downloading sphinx_rtd_theme-2.0.0-py2.py3-none-any.whl (2.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.8/2.8 MB 53.7 MB/s eta 0:00:00 Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.1/121.1 kB 270.4 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=a67d5add3f29f0a571233eaea196a6334fc6bdc6df8a12795c47a3ca327c9826 Stored in directory: /tmp/pip-ephem-wheel-cache-nl1be4hj/wheels/80/c2/c8/630c9eb889f0be0202cb11bf30b47aa54bf7588e8d50b70005 Successfully built mock Installing collected packages: mock, commonmark, pillow, sphinxcontrib-jquery, recommonmark, sphinx-rtd-theme Successfully installed commonmark-0.9.1 mock-1.0.1 pillow-10.2.0 recommonmark-0.5.0 sphinx-rtd-theme-2.0.0 sphinxcontrib-jquery-4.1 [rtd-command-info] start-time: 2024-02-27T13:47:12.499801Z, end-time: 2024-02-27T13:47:12.565947Z, 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 = "Micetro by Men&Mice - 10.5" copyright = "2023, Men&Mice" author = "Men&Mice" # -- General configuration --------------------------------------------------- # -- General configuration extensions = [ "sphinx.ext.duration", "sphinx.ext.doctest", "sphinx.ext.autodoc", "sphinx.ext.autosummary", "sphinx.ext.intersphinx", ] intersphinx_mapping = { "rtd": ("https://docs.readthedocs.io/en/stable/", None), "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 EPUB output epub_show_urls = "footnote" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # -- 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" # 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"] ########################################################################### # 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': "10.5", 'version_slug': "10.5", '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/"), ("10.5", "/en/10.5/"), ("10.3", "/en/10.3/"), ("10.2", "/en/10.2/"), ("10.1", "/en/10.1/"), ("10.0", "/en/10.0/"), ("9.3", "/en/9.3/"), ], 'downloads': [ ], 'subprojects': [ ("menmice-micetro-knowledge-base", "https://docs.menandmice.com/projects/knowledge-base/en/latest/"), ], 'slug': 'menmice-micetro-by-menmice', 'name': u'Micetro by Men&Mice', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': '', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/', 'api_host': 'https://readthedocs.com', 'github_user': 'menandmice', 'proxied_api_host': '/_', 'github_repo': 'micetro_docs', 'github_version': '10.5', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': '10.5', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': '10.5', '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': 'dfad2c09', } # 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/menmice-micetro-by-menmice/builds/2045292/' 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'])