Read the Docs build information Build id: 27683 Project: epix-documentation Version: latest Commit: 5edebe80d784d8f85087e52f76531603522e8392 Date: 2024-03-04T11:00:46.592088Z State: finished Success: False [rtd-command-info] start-time: 2024-03-04T11:00:47.769502Z, end-time: 2024-03-04T11:00:49.442751Z, duration: 1, exit-code: 0 git clone --no-single-branch --depth 50 http://git.xfel.eu/detectors/epix-documentation . Cloning into '.'... warning: redirecting to https://git.xfel.eu/detectors/epix-documentation.git/ [rtd-command-info] start-time: 2024-03-04T11:00:49.730959Z, end-time: 2024-03-04T11:00:49.838220Z, duration: 0, exit-code: 0 git checkout --force origin/duarte_documentation_update Note: checking out 'origin/duarte_documentation_update'. 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 performing another checkout. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -b with the checkout command again. Example: git checkout -b HEAD is now at 5edebe8 Update conf.py [rtd-command-info] start-time: 2024-03-04T11:00:49.927387Z, end-time: 2024-03-04T11:00:49.998467Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2024-03-04T11:00:51.438228Z, end-time: 2024-03-04T11:00:56.695207Z, duration: 5, exit-code: 0 python3.8 -mvirtualenv /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest Using base prefix '/home/docs/.pyenv/versions/3.8.0' New python executable in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/bin/python3.8 Also creating executable in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2024-03-04T11:00:56.789409Z, end-time: 2024-03-04T11:00:57.804492Z, duration: 1, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/bin/python -m pip install --upgrade --no-cache-dir pip Requirement already satisfied: pip in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (24.0) [rtd-command-info] start-time: 2024-03-04T11:00:57.890152Z, end-time: 2024-03-04T11:01:23.657144Z, duration: 25, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/bin/python -m pip install --upgrade --no-cache-dir jinja2==2.11.3 markupsafe==2.0.1 Pygments==2.3.1 setuptools==41.0.1 docutils==0.14 mock==1.0.1 pillow==5.4.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.8.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<1.1 Collecting jinja2==2.11.3 Downloading Jinja2-2.11.3-py2.py3-none-any.whl.metadata (3.5 kB) Collecting markupsafe==2.0.1 Downloading MarkupSafe-2.0.1-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl.metadata (3.2 kB) Collecting Pygments==2.3.1 Downloading Pygments-2.3.1-py2.py3-none-any.whl.metadata (1.5 kB) Collecting setuptools==41.0.1 Downloading setuptools-41.0.1-py2.py3-none-any.whl.metadata (3.3 kB) Collecting docutils==0.14 Downloading docutils-0.14-py3-none-any.whl.metadata (2.3 kB) Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 kB 11.0 MB/s eta 0:00:00 Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting pillow==5.4.1 Downloading Pillow-5.4.1.tar.gz (16.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 16.0/16.0 MB 99.4 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.metadata (3.0 kB) Collecting commonmark==0.8.1 Downloading commonmark-0.8.1-py2.py3-none-any.whl.metadata (5.6 kB) Collecting recommonmark==0.5.0 Downloading recommonmark-0.5.0-py2.py3-none-any.whl.metadata (463 bytes) Collecting sphinx<2 Downloading Sphinx-1.8.6-py2.py3-none-any.whl.metadata (7.3 kB) Collecting sphinx-rtd-theme<0.5 Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl.metadata (3.0 kB) Collecting readthedocs-sphinx-ext<1.1 Downloading readthedocs_sphinx_ext-1.0.4-py2.py3-none-any.whl.metadata (1.4 kB) Collecting future (from commonmark==0.8.1) Downloading future-1.0.0-py3-none-any.whl.metadata (4.0 kB) Collecting six>=1.5 (from sphinx<2) Downloading six-1.16.0-py2.py3-none-any.whl.metadata (1.8 kB) Collecting snowballstemmer>=1.1 (from sphinx<2) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl.metadata (6.5 kB) Collecting babel!=2.0,>=1.3 (from sphinx<2) Downloading Babel-2.14.0-py3-none-any.whl.metadata (1.6 kB) Collecting imagesize (from sphinx<2) Downloading imagesize-1.4.1-py2.py3-none-any.whl.metadata (1.5 kB) Collecting requests>=2.0.0 (from sphinx<2) Downloading requests-2.31.0-py3-none-any.whl.metadata (4.6 kB) Collecting packaging (from sphinx<2) Downloading packaging-23.2-py3-none-any.whl.metadata (3.2 kB) Collecting sphinxcontrib-websupport (from sphinx<2) Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl.metadata (1.5 kB) Collecting pytz>=2015.7 (from babel!=2.0,>=1.3->sphinx<2) Downloading pytz-2024.1-py2.py3-none-any.whl.metadata (22 kB) Collecting charset-normalizer<4,>=2 (from requests>=2.0.0->sphinx<2) Downloading charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (33 kB) Collecting idna<4,>=2.5 (from requests>=2.0.0->sphinx<2) Downloading idna-3.6-py3-none-any.whl.metadata (9.9 kB) Collecting urllib3<3,>=1.21.1 (from requests>=2.0.0->sphinx<2) Downloading urllib3-2.2.1-py3-none-any.whl.metadata (6.4 kB) Collecting certifi>=2017.4.17 (from requests>=2.0.0->sphinx<2) Downloading certifi-2024.2.2-py3-none-any.whl.metadata (2.2 kB) Collecting sphinxcontrib-serializinghtml (from sphinxcontrib-websupport->sphinx<2) Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl.metadata (1.5 kB) Downloading Jinja2-2.11.3-py2.py3-none-any.whl (125 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 125.7/125.7 kB 173.1 MB/s eta 0:00:00 Downloading MarkupSafe-2.0.1-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (30 kB) Downloading Pygments-2.3.1-py2.py3-none-any.whl (849 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 849.5/849.5 kB 193.4 MB/s eta 0:00:00 Downloading setuptools-41.0.1-py2.py3-none-any.whl (575 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 576.0/576.0 kB 207.7 MB/s eta 0:00:00 Downloading docutils-0.14-py3-none-any.whl (543 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 543.2/543.2 kB 210.7 MB/s eta 0:00:00 Downloading commonmark-0.8.1-py2.py3-none-any.whl (47 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 47.4/47.4 kB 175.7 MB/s eta 0:00:00 Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Downloading alabaster-0.7.13-py3-none-any.whl (13 kB) Downloading Sphinx-1.8.6-py2.py3-none-any.whl (3.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.1/3.1 MB 175.8 MB/s eta 0:00:00 Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 6.4/6.4 MB 136.5 MB/s eta 0:00:00 Downloading readthedocs_sphinx_ext-1.0.4-py2.py3-none-any.whl (28 kB) Downloading Babel-2.14.0-py3-none-any.whl (11.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 11.0/11.0 MB 150.0 MB/s eta 0:00:00 Downloading requests-2.31.0-py3-none-any.whl (62 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.6/62.6 kB 140.3 MB/s eta 0:00:00 Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 174.8 MB/s eta 0:00:00 Downloading future-1.0.0-py3-none-any.whl (491 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 491.3/491.3 kB 192.0 MB/s eta 0:00:00 Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Downloading packaging-23.2-py3-none-any.whl (53 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 53.0/53.0 kB 98.1 MB/s eta 0:00:00 Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB) Downloading certifi-2024.2.2-py3-none-any.whl (163 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 163.8/163.8 kB 197.8 MB/s eta 0:00:00 Downloading charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (141 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 141.1/141.1 kB 197.8 MB/s eta 0:00:00 Downloading idna-3.6-py3-none-any.whl (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.6/61.6 kB 178.5 MB/s eta 0:00:00 Downloading pytz-2024.1-py2.py3-none-any.whl (505 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 505.5/505.5 kB 216.1 MB/s eta 0:00:00 Downloading urllib3-2.2.1-py3-none-any.whl (121 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.1/121.1 kB 204.8 MB/s eta 0:00:00 Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 94.0/94.0 kB 156.5 MB/s eta 0:00:00 Building wheels for collected packages: mock, pillow 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=c894ea6963c3e3f542caae87a45a9dfd3f5080c47af5f3ab1cb3d80878912b8e Stored in directory: /tmp/pip-ephem-wheel-cache-2zmhdrgb/wheels/41/7c/21/90057f91c6ead7c77a90c52d6e85ca48bf82d8b0d3f8dfbb65 Building wheel for pillow (setup.py): started Building wheel for pillow (setup.py): finished with status 'done' Created wheel for pillow: filename=Pillow-5.4.1-cp38-cp38-linux_x86_64.whl size=1262506 sha256=fadfd9d5644f34116dec44fb77f50bf21560f4be7a955efb1f12dbe4a98de42d Stored in directory: /tmp/pip-ephem-wheel-cache-2zmhdrgb/wheels/5f/a8/6b/5b7b3f764d879214eb03570f74d2b086201eb514e6ffa68d6d Successfully built mock pillow Installing collected packages: snowballstemmer, pytz, Pygments, mock, docutils, urllib3, sphinxcontrib-serializinghtml, six, setuptools, pillow, packaging, markupsafe, imagesize, idna, future, charset-normalizer, certifi, babel, alabaster, sphinxcontrib-websupport, requests, jinja2, commonmark, sphinx, readthedocs-sphinx-ext, sphinx-rtd-theme, recommonmark Attempting uninstall: setuptools Found existing installation: setuptools 69.1.1 Uninstalling setuptools-69.1.1: Successfully uninstalled setuptools-69.1.1 Successfully installed Pygments-2.3.1 alabaster-0.7.13 babel-2.14.0 certifi-2024.2.2 charset-normalizer-3.3.2 commonmark-0.8.1 docutils-0.14 future-1.0.0 idna-3.6 imagesize-1.4.1 jinja2-2.11.3 markupsafe-2.0.1 mock-1.0.1 packaging-23.2 pillow-5.4.1 pytz-2024.1 readthedocs-sphinx-ext-1.0.4 recommonmark-0.5.0 requests-2.31.0 setuptools-41.0.1 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.2.1 [rtd-command-info] start-time: 2024-03-04T11:01:23.746850Z, end-time: 2024-03-04T11:01:26.962807Z, duration: 3, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/bin/python -m pip install --exists-action=w --no-cache-dir -r requirements.txt Collecting git+https://git.xfel.eu/xfel-rtd/rtd-conf.git (from -r requirements.txt (line 3)) Cloning https://git.xfel.eu/xfel-rtd/rtd-conf.git to /tmp/pip-req-build-npz6vsth Running command git clone --filter=blob:none --quiet https://git.xfel.eu/xfel-rtd/rtd-conf.git /tmp/pip-req-build-npz6vsth Resolved https://git.xfel.eu/xfel-rtd/rtd-conf.git to commit 3d66246db37045eaa716d206b13441613c1b413e Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Requirement already satisfied: sphinx==1.8.6 in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (from -r requirements.txt (line 4)) (1.8.6) Collecting breathe==4.7.3 (from -r requirements.txt (line 5)) Downloading breathe-4.7.3-py2.py3-none-any.whl.metadata (1.0 kB) Collecting slumber==0.7.1 (from -r requirements.txt (line 6)) Downloading slumber-0.7.1.tar.gz (10 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting urllib3==1.26.6 (from -r requirements.txt (line 7)) Downloading urllib3-1.26.6-py2.py3-none-any.whl.metadata (44 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 44.3/44.3 kB 2.1 MB/s eta 0:00:00 Requirement already satisfied: six>=1.5 in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (from sphinx==1.8.6->-r requirements.txt (line 4)) (1.16.0) Requirement already satisfied: Jinja2>=2.3 in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (from sphinx==1.8.6->-r requirements.txt (line 4)) (2.11.3) Requirement already satisfied: Pygments>=2.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (from sphinx==1.8.6->-r requirements.txt (line 4)) (2.3.1) Requirement already satisfied: docutils<0.18,>=0.11 in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (from sphinx==1.8.6->-r requirements.txt (line 4)) (0.14) Requirement already satisfied: snowballstemmer>=1.1 in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (from sphinx==1.8.6->-r requirements.txt (line 4)) (2.2.0) Requirement already satisfied: babel!=2.0,>=1.3 in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (from sphinx==1.8.6->-r requirements.txt (line 4)) (2.14.0) Requirement already satisfied: alabaster<0.8,>=0.7 in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (from sphinx==1.8.6->-r requirements.txt (line 4)) (0.7.13) Requirement already satisfied: imagesize in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (from sphinx==1.8.6->-r requirements.txt (line 4)) (1.4.1) Requirement already satisfied: requests>=2.0.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (from sphinx==1.8.6->-r requirements.txt (line 4)) (2.31.0) Requirement already satisfied: setuptools in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (from sphinx==1.8.6->-r requirements.txt (line 4)) (41.0.1) Requirement already satisfied: packaging in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (from sphinx==1.8.6->-r requirements.txt (line 4)) (23.2) Requirement already satisfied: sphinxcontrib-websupport in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (from sphinx==1.8.6->-r requirements.txt (line 4)) (1.2.4) Requirement already satisfied: pytz>=2015.7 in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (from babel!=2.0,>=1.3->sphinx==1.8.6->-r requirements.txt (line 4)) (2024.1) Requirement already satisfied: MarkupSafe>=0.23 in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (from Jinja2>=2.3->sphinx==1.8.6->-r requirements.txt (line 4)) (2.0.1) Requirement already satisfied: charset-normalizer<4,>=2 in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (from requests>=2.0.0->sphinx==1.8.6->-r requirements.txt (line 4)) (3.3.2) Requirement already satisfied: idna<4,>=2.5 in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (from requests>=2.0.0->sphinx==1.8.6->-r requirements.txt (line 4)) (3.6) Requirement already satisfied: certifi>=2017.4.17 in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (from requests>=2.0.0->sphinx==1.8.6->-r requirements.txt (line 4)) (2024.2.2) Requirement already satisfied: sphinxcontrib-serializinghtml in /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages (from sphinxcontrib-websupport->sphinx==1.8.6->-r requirements.txt (line 4)) (1.1.5) Downloading breathe-4.7.3-py2.py3-none-any.whl (73 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 73.7/73.7 kB 13.6 MB/s eta 0:00:00 Downloading urllib3-1.26.6-py2.py3-none-any.whl (138 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 138.5/138.5 kB 24.3 MB/s eta 0:00:00 Building wheels for collected packages: slumber, RTDConf Building wheel for slumber (setup.py): started Building wheel for slumber (setup.py): finished with status 'done' Created wheel for slumber: filename=slumber-0.7.1-py3-none-any.whl size=8098 sha256=85a96bc2294bdb007fa92473e28dfb312d94aeef43a4b40cd5e307ec05683a1b Stored in directory: /tmp/pip-ephem-wheel-cache-jp9a8f79/wheels/d9/31/b7/b6202c6ff32847610ed92e1d3cc9d7cf732bcb2d9b5abad083 Building wheel for RTDConf (setup.py): started Building wheel for RTDConf (setup.py): finished with status 'done' Created wheel for RTDConf: filename=RTDConf-0.1-py3-none-any.whl size=2649 sha256=fa6860e5d7c233181b5e775de94b72efdd7daa6a6c3dbf93bf6e9405b7b077c3 Stored in directory: /tmp/pip-ephem-wheel-cache-jp9a8f79/wheels/35/65/f6/649e0b84ee3e4f6c34209282bbd42c699d74473e1bdacd5762 Successfully built slumber RTDConf Installing collected packages: RTDConf, urllib3, slumber, breathe Attempting uninstall: urllib3 Found existing installation: urllib3 2.2.1 Uninstalling urllib3-2.2.1: Successfully uninstalled urllib3-2.2.1 Successfully installed RTDConf-0.1 breathe-4.7.3 slumber-0.7.1 urllib3-1.26.6 [rtd-command-info] start-time: 2024-03-04T11:01:27.711729Z, end-time: 2024-03-04T11:01:27.780396Z, duration: 0, exit-code: 0 cat source/conf.py # -*- coding: utf-8 -*- # # Template configuration file, created by sphinx-quickstart. # # This file is execfile()d with the current directory set to its containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. from datetime import datetime import os import sys from subprocess import Popen, PIPE from rtd_conf import global_conf cwd = os.getcwd() # install a fixed theme which support proper math formatting # we need to do this explicitely and not via a requirements.txt as # it needs to go to a specific location depending on this build. # os.makedirs("{}/userthemes".format(cwd), exist_ok=True) if os.path.exists("/rtd_root/readthedocs"): os.makedirs("/rtd_root/readthedocs/templates/sphinx/_static", exist_ok=True) # TODO: Investigate personal token in submodules. Would it be acceptable # for project specific submodules, e.g. code documentation added by the user later? # If we still need the a common theme after the RTD update, this git repo should be public. # No personalized token should be shipped with this template. It also might confus git to think that # the user is the person the token belongs to. # this will update our submodules pcmd = ["git", "submodule", "init"] Popen(pcmd).wait() pcmd = ["git", "submodule", "update", "--recursive", "--remote"] Popen(pcmd).wait() # This is a bit hacky, but it seems that with submodules file modification # times are sometime corrupted and set to dates in the 1970s. ZIP is not # happy with this and will fail the build. Thus we search for any affected files # here, and then set the mtime to the current time. pcmd = ["find", "..", "-mtime", "+13700", "-type", "f", "-exec", "touch", "{}", "+"] Popen(pcmd).wait() # If you nevertheless get a ZIP 1980 error, this command will output you # the files which are responsible for triggering it. Should be none if # our fix-up succeeded. pcmd = ["find", "..", "-mtime", "+13700", "-ls"] Popen(pcmd).wait() # 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. #sys.path.insert(0, os.path.abspath('.')) # -- General configuration ----------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # TODO: check for completeness extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'sphinx.ext.graphviz', 'breathe' ] mathjax_path="https://in.xfel.eu/readthedocs/media/MathJax-2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML" # noqa # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = u'ePix documentation' copyright = u'2020, Detector Operations' author = u'M. Cascella' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = '0.1' # The full version, including alpha/beta/rc tags. release = '0.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # If True, figures, tables and code-blocks are automatically numbered if they # have a caption. The numref role is enabled. Obeyed so far only by HTML and # LaTeX builders. Default is False. #numfig = True # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # exclude_patterns = ['userthemes'] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # -- Options for HTML output --------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # TODO: Can the default theme be used after the RTD update? # If not put patched theme in global space # html_theme_path = ["{}/userthemes".format(cwd)] html_theme = "sphinx_rtd_theme_patched" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # 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'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_domain_indices = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'ePixdocumentation' # -- Options for LaTeX output -------------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'ePixdocumentation.tex', u'ePix documentation', u'M. Cascella', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output -------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'ePixdocumentation', u'ePix documentation', [u'M. Cascella'], 1) ] # If true, show URL addresses after external links. #man_show_urls = False # -- Options for Texinfo output ------------------------------------------------ # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', 'ePixdocumentation', u'ePix documentation', u'M. Cascella', 'ePixdocumentation', 'ePix documentation.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # Example configuration for intersphinx: refer to the Python standard library. # intersphinx_mapping = {'http://docs.python.org/': None} def setup(app): app.add_config_value('includeDevInfo', 'false', 'env') ########################################################################### # 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/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl # import importlib import sys import os.path from six import string_types 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: theme = importlib.import_module('sphinx_rtd_theme') html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} if 'html_theme_path' in globals(): html_theme_path.append(theme.get_html_theme_path()) else: html_theme_path = [theme.get_html_theme_path()] if globals().get('websupport2_base_url', False): websupport2_base_url = 'http://rtd.xfel.eu/websupport' websupport2_static_url = '/static/' #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': "media/", 'STATIC_URL': "/static/", 'PRODUCTION_DOMAIN': "rtd.xfel.eu", 'versions': [ ("master", "/en/master/"), ("latest", "/en/latest/"), ("duarte_documentation_update", "/en/duarte_documentation_update/"), ], 'downloads': [ ("pdf", "//rtd.xfel.eu/downloads/epix-documentation/latest/pdf/"), ("html", "//rtd.xfel.eu/downloads/epix-documentation/latest/htmlzip/"), ("epub", "//rtd.xfel.eu/downloads/epix-documentation/latest/epub/"), ], 'subprojects': [ ], 'slug': 'epix-documentation', 'name': u'ePix documentation', 'rtd_language': u'en', 'programming_language': u'py', 'canonical_url': 'http://rtd.xfel.eu/docs/epix-documentation/en/latest/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/source/', 'api_host': 'http://rtd.xfel.eu', 'github_user': 'None', 'proxied_api_host': '/_', 'github_repo': 'None', 'github_version': 'duarte_documentation_update', 'display_github': False, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'duarte_documentation_update', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': 'duarte_documentation_update', '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': 'None', 'commit': '5edebe80', } if 'html_context' in globals(): html_context.update(context) else: html_context = context # Add custom RTD extension if 'extensions' in globals(): # Insert at the beginning because it can interfere # with other extensions. # See https://github.com/rtfd/readthedocs.org/pull/4054 extensions.insert(0, "readthedocs_ext.readthedocs") else: extensions = ["readthedocs_ext.readthedocs"] # Add External version warning banner to the external version documentation if 'branch' == 'external': extensions.insert(1, "readthedocs_ext.external_version_warning") 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-03-04T11:01:27.871653Z, end-time: 2024-03-04T11:01:29.665530Z, duration: 1, exit-code: 2 python /usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/bin/sphinx-build -T -E -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Running Sphinx v1.8.6 loading translations [en]... done making output directory... Traceback (most recent call last): File "/usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages/sphinx/cmd/build.py", line 300, in build_main app = Sphinx(args.sourcedir, args.confdir, args.outputdir, File "/usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages/sphinx/application.py", line 263, in __init__ self._init_builder() File "/usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages/sphinx/application.py", line 324, in _init_builder self.builder.init() File "/usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages/sphinx/builders/html.py", line 329, in init self.init_templates() File "/usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages/sphinx/builders/html.py", line 375, in init_templates self.theme = theme_factory.create(themename) File "/usr/src/app/checkouts/readthedocs.org/user_builds/epix-documentation/envs/latest/lib/python3.8/site-packages/sphinx/theming.py", line 285, in create raise ThemeError(__('no theme named %r found ' sphinx.errors.ThemeError: no theme named 'sphinx_rtd_theme_patched' found (missing theme.conf?) Theme error: no theme named 'sphinx_rtd_theme_patched' found (missing theme.conf?)