Read the Docs build information Build id: 25025 Project: jjattenuator Version: latest Commit: 7e28d53acf4fbcccaecbb3bd71ba559c2e2b377c Date: 2022-12-05T11:52:24.008047Z State: finished Success: True [rtd-command-info] start-time: 2022-12-05T11:52:25.213003Z, end-time: 2022-12-05T11:52:25.820718Z, duration: 0, exit-code: 0 git clone --no-single-branch --depth 50 http://git.xfel.eu/gitlab/karaboDevices/jjAttenuator . Cloning into '.'... warning: redirecting to https://git.xfel.eu/gitlab/karaboDevices/jjAttenuator.git/ [rtd-command-info] start-time: 2022-12-05T11:52:26.121474Z, end-time: 2022-12-05T11:52:26.192782Z, duration: 0, exit-code: 0 git checkout --force origin/master Note: checking out 'origin/master'. You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by 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 7e28d53 Merge branch 'refactor_for_readability' into 'master' [rtd-command-info] start-time: 2022-12-05T11:52:26.276867Z, end-time: 2022-12-05T11:52:26.334040Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2022-12-05T11:52:27.611150Z, end-time: 2022-12-05T11:52:32.547640Z, duration: 4, exit-code: 0 python3.8 -mvirtualenv /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest Using base prefix '/home/docs/.pyenv/versions/3.8.0' New python executable in /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest/bin/python3.8 Also creating executable in /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2022-12-05T11:52:32.636046Z, end-time: 2022-12-05T11:52:33.574793Z, duration: 0, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/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/jjattenuator/envs/latest/lib/python3.8/site-packages (22.3.1) [rtd-command-info] start-time: 2022-12-05T11:52:33.662199Z, end-time: 2022-12-05T11:52:59.071227Z, duration: 25, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/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 (125 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 125.7/125.7 kB 3.4 MB/s eta 0:00:00 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 (30 kB) Collecting Pygments==2.3.1 Downloading Pygments-2.3.1-py2.py3-none-any.whl (849 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 849.5/849.5 kB 15.8 MB/s eta 0:00:00 Collecting setuptools==41.0.1 Downloading setuptools-41.0.1-py2.py3-none-any.whl (575 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 576.0/576.0 kB 183.9 MB/s eta 0:00:00 Collecting docutils==0.14 Downloading docutils-0.14-py3-none-any.whl (543 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 543.2/543.2 kB 189.5 MB/s eta 0:00:00 Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 kB 163.6 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 140.0 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.12-py2.py3-none-any.whl (14 kB) Collecting commonmark==0.8.1 Downloading commonmark-0.8.1-py2.py3-none-any.whl (47 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 47.4/47.4 kB 125.9 MB/s eta 0:00:00 Collecting recommonmark==0.5.0 Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Collecting sphinx<2 Downloading Sphinx-1.8.6-py2.py3-none-any.whl (3.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.1/3.1 MB 225.9 MB/s eta 0:00:00 Collecting sphinx-rtd-theme<0.5 Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 6.4/6.4 MB 156.7 MB/s eta 0:00:00 Collecting readthedocs-sphinx-ext<1.1 Downloading readthedocs_sphinx_ext-1.0.4-py2.py3-none-any.whl (28 kB) Collecting future Downloading future-0.18.2.tar.gz (829 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 829.2/829.2 kB 225.2 MB/s eta 0:00:00 Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting sphinxcontrib-websupport Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB) Collecting six>=1.5 Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Collecting packaging Downloading packaging-21.3-py3-none-any.whl (40 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 40.8/40.8 kB 154.7 MB/s eta 0:00:00 Collecting imagesize Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Collecting babel!=2.0,>=1.3 Downloading Babel-2.11.0-py3-none-any.whl (9.5 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 9.5/9.5 MB 143.4 MB/s eta 0:00:00 Collecting requests>=2.0.0 Downloading requests-2.28.1-py3-none-any.whl (62 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.8/62.8 kB 160.6 MB/s eta 0:00:00 Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 189.5 MB/s eta 0:00:00 Collecting pytz>=2015.7 Downloading pytz-2022.6-py2.py3-none-any.whl (498 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 498.1/498.1 kB 212.8 MB/s eta 0:00:00 Collecting charset-normalizer<3,>=2 Downloading charset_normalizer-2.1.1-py3-none-any.whl (39 kB) Collecting urllib3<1.27,>=1.21.1 Downloading urllib3-1.26.13-py2.py3-none-any.whl (140 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 140.6/140.6 kB 204.8 MB/s eta 0:00:00 Collecting idna<4,>=2.5 Downloading idna-3.4-py3-none-any.whl (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.5/61.5 kB 141.0 MB/s eta 0:00:00 Collecting certifi>=2017.4.17 Downloading certifi-2022.9.24-py3-none-any.whl (161 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 161.1/161.1 kB 201.8 MB/s eta 0:00:00 Collecting pyparsing!=3.0.5,>=2.0.2 Downloading pyparsing-3.0.9-py3-none-any.whl (98 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 98.3/98.3 kB 196.6 MB/s eta 0:00:00 Collecting sphinxcontrib-serializinghtml Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 94.0/94.0 kB 184.5 MB/s eta 0:00:00 Building wheels for collected packages: mock, pillow, future 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=60bdd09df130dda4a12092a7acd79441b876ceae45d2d1b39bdd8b38d2aac394 Stored in directory: /tmp/pip-ephem-wheel-cache-srgl_6no/wheels/17/19/d4/cf0d726b5d1c635d98e82c451a566e84870a10373f29ce6517 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=1262503 sha256=7f005c1cb08a5bc6257395be9e2f053dab14562612a045507c88db0eb9f742c6 Stored in directory: /tmp/pip-ephem-wheel-cache-srgl_6no/wheels/b1/e9/c4/aaa279191f4df841f7bba11edcf38095a0fc829abe9ab84b68 Building wheel for future (setup.py): started Building wheel for future (setup.py): finished with status 'done' Created wheel for future: filename=future-0.18.2-py3-none-any.whl size=491059 sha256=108c9b7a3a7fdbed3366a8022a9b751555a4c276d8b1fcbe1490a638b3cd0712 Stored in directory: /tmp/pip-ephem-wheel-cache-srgl_6no/wheels/01/49/0c/4e0a697824c7bd6516afb22e1af9d51427ccd36c74b05a297e Successfully built mock pillow future Installing collected packages: snowballstemmer, pytz, Pygments, mock, docutils, alabaster, urllib3, sphinxcontrib-serializinghtml, six, setuptools, pyparsing, pillow, markupsafe, imagesize, idna, future, charset-normalizer, certifi, babel, sphinxcontrib-websupport, requests, packaging, jinja2, commonmark, sphinx, readthedocs-sphinx-ext, sphinx-rtd-theme, recommonmark Attempting uninstall: setuptools Found existing installation: setuptools 65.6.3 Uninstalling setuptools-65.6.3: Successfully uninstalled setuptools-65.6.3 Successfully installed Pygments-2.3.1 alabaster-0.7.12 babel-2.11.0 certifi-2022.9.24 charset-normalizer-2.1.1 commonmark-0.8.1 docutils-0.14 future-0.18.2 idna-3.4 imagesize-1.4.1 jinja2-2.11.3 markupsafe-2.0.1 mock-1.0.1 packaging-21.3 pillow-5.4.1 pyparsing-3.0.9 pytz-2022.6 readthedocs-sphinx-ext-1.0.4 recommonmark-0.5.0 requests-2.28.1 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-1.26.13 [rtd-command-info] start-time: 2022-12-05T11:52:59.157535Z, end-time: 2022-12-05T11:53:05.210463Z, duration: 6, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest/bin/python -m pip install --exists-action=w --no-cache-dir -r doc/requirements.txt Collecting git+https://xfel.redmine:****@git.xfel.eu/gitlab/Karabo/rtd-conf-py.git (from -r doc/requirements.txt (line 3)) Cloning https://xfel.redmine:****@git.xfel.eu/gitlab/Karabo/rtd-conf-py.git to /tmp/pip-req-build-jl5ux6o8 Running command git clone --filter=blob:none --quiet 'https://xfel.redmine:****@git.xfel.eu/gitlab/Karabo/rtd-conf-py.git' /tmp/pip-req-build-jl5ux6o8 Resolved https://xfel.redmine:****@git.xfel.eu/gitlab/Karabo/rtd-conf-py.git to commit 62321ac3eb702ecb968096a49c2c1671a2f3874f Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting slumber Downloading slumber-0.7.1.tar.gz (10 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting breathe Downloading breathe-4.34.0-py3-none-any.whl (92 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 92.8/92.8 kB 3.7 MB/s eta 0:00:00 Requirement already satisfied: requests in /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest/lib/python3.8/site-packages (from slumber->-r doc/requirements.txt (line 1)) (2.28.1) Requirement already satisfied: docutils>=0.12 in /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest/lib/python3.8/site-packages (from breathe->-r doc/requirements.txt (line 2)) (0.14) Collecting Sphinx!=5.0.0,<6,>=4.0 Downloading sphinx-5.3.0-py3-none-any.whl (3.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.2/3.2 MB 34.0 MB/s eta 0:00:00 Collecting sphinxcontrib-devhelp Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 84.7/84.7 kB 208.9 MB/s eta 0:00:00 Collecting sphinxcontrib-jsmath Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Requirement already satisfied: imagesize>=1.3 in /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest/lib/python3.8/site-packages (from Sphinx!=5.0.0,<6,>=4.0->breathe->-r doc/requirements.txt (line 2)) (1.4.1) Requirement already satisfied: packaging>=21.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest/lib/python3.8/site-packages (from Sphinx!=5.0.0,<6,>=4.0->breathe->-r doc/requirements.txt (line 2)) (21.3) Collecting sphinxcontrib-qthelp Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 90.6/90.6 kB 204.1 MB/s eta 0:00:00 Requirement already satisfied: alabaster<0.8,>=0.7 in /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest/lib/python3.8/site-packages (from Sphinx!=5.0.0,<6,>=4.0->breathe->-r doc/requirements.txt (line 2)) (0.7.12) Collecting sphinxcontrib-htmlhelp>=2.0.0 Downloading sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl (100 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100.5/100.5 kB 196.5 MB/s eta 0:00:00 Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest/lib/python3.8/site-packages (from Sphinx!=5.0.0,<6,>=4.0->breathe->-r doc/requirements.txt (line 2)) (1.1.5) Requirement already satisfied: snowballstemmer>=2.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest/lib/python3.8/site-packages (from Sphinx!=5.0.0,<6,>=4.0->breathe->-r doc/requirements.txt (line 2)) (2.2.0) Collecting importlib-metadata>=4.8 Downloading importlib_metadata-5.1.0-py3-none-any.whl (21 kB) Requirement already satisfied: babel>=2.9 in /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest/lib/python3.8/site-packages (from Sphinx!=5.0.0,<6,>=4.0->breathe->-r doc/requirements.txt (line 2)) (2.11.0) Collecting sphinxcontrib-applehelp Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.2/121.2 kB 225.4 MB/s eta 0:00:00 Collecting Jinja2>=3.0 Downloading Jinja2-3.1.2-py3-none-any.whl (133 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.1/133.1 kB 225.7 MB/s eta 0:00:00 Collecting Pygments>=2.12 Downloading Pygments-2.13.0-py3-none-any.whl (1.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.1/1.1 MB 207.8 MB/s eta 0:00:00 Requirement already satisfied: idna<4,>=2.5 in /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest/lib/python3.8/site-packages (from requests->slumber->-r doc/requirements.txt (line 1)) (3.4) Requirement already satisfied: urllib3<1.27,>=1.21.1 in /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest/lib/python3.8/site-packages (from requests->slumber->-r doc/requirements.txt (line 1)) (1.26.13) Requirement already satisfied: charset-normalizer<3,>=2 in /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest/lib/python3.8/site-packages (from requests->slumber->-r doc/requirements.txt (line 1)) (2.1.1) Requirement already satisfied: certifi>=2017.4.17 in /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest/lib/python3.8/site-packages (from requests->slumber->-r doc/requirements.txt (line 1)) (2022.9.24) Requirement already satisfied: pytz>=2015.7 in /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest/lib/python3.8/site-packages (from babel>=2.9->Sphinx!=5.0.0,<6,>=4.0->breathe->-r doc/requirements.txt (line 2)) (2022.6) Collecting zipp>=0.5 Downloading zipp-3.11.0-py3-none-any.whl (6.6 kB) Requirement already satisfied: MarkupSafe>=2.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest/lib/python3.8/site-packages (from Jinja2>=3.0->Sphinx!=5.0.0,<6,>=4.0->breathe->-r doc/requirements.txt (line 2)) (2.0.1) Requirement already satisfied: pyparsing!=3.0.5,>=2.0.2 in /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest/lib/python3.8/site-packages (from packaging>=21.0->Sphinx!=5.0.0,<6,>=4.0->breathe->-r doc/requirements.txt (line 2)) (3.0.9) 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=6762bef5777f0247b8a677fe1c1adc611ce7e331422e155de01dfbc4c3e81b57 Stored in directory: /tmp/pip-ephem-wheel-cache-wmcp0ys6/wheels/86/f0/cf/2e7ea68a10eda0a3dd3b824cbc56622086ade417712f6334e5 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=2456 sha256=1fbdec06d8654a433a72bafd29e225b6012e8f604269f666ebf1581599dc533a Stored in directory: /tmp/pip-ephem-wheel-cache-wmcp0ys6/wheels/15/33/f4/4466492b637eeac9397ddde67f3fb5c9ab90ff80828f795407 Successfully built slumber RTDConf Installing collected packages: RTDConf, zipp, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, Pygments, Jinja2, slumber, importlib-metadata, Sphinx, breathe Attempting uninstall: Pygments Found existing installation: Pygments 2.3.1 Uninstalling Pygments-2.3.1: Successfully uninstalled Pygments-2.3.1 Attempting uninstall: Jinja2 Found existing installation: Jinja2 2.11.3 Uninstalling Jinja2-2.11.3: Successfully uninstalled Jinja2-2.11.3 Attempting uninstall: Sphinx Found existing installation: Sphinx 1.8.6 Uninstalling Sphinx-1.8.6: Successfully uninstalled Sphinx-1.8.6 Successfully installed Jinja2-3.1.2 Pygments-2.13.0 RTDConf-0.1 Sphinx-5.3.0 breathe-4.34.0 importlib-metadata-5.1.0 slumber-0.7.1 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-2.0.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 zipp-3.11.0 [rtd-command-info] start-time: 2022-12-05T11:53:05.909317Z, end-time: 2022-12-05T11:53:05.976055Z, duration: 0, exit-code: 0 cat doc/source/conf.py #!/usr/bin/env python3 # -*- coding: utf-8 -*- # # 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. # 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 # -- 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. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'sphinx.ext.graphviz', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] 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 = 'jjAttenuator' copyright = '2018, CAS' author = 'CAS' # 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 = '1.0' # The full version, including alpha/beta/rc tags. release = '1.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. 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' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path exclude_patterns = [] # 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 = [] # If true, keep warnings as "system message" paragraphs in the built documents. # keep_warnings = False # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True # -- 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 = 'default' # 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. # " v documentation" by default. # # html_title = 'FXE-Instrument Control Infrastructure v1.0' # 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 (relative to this directory) to use as a 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'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. # # html_extra_path = [] # If not None, a 'Last updated on:' timestamp is inserted at every page # bottom, using the given strftime format. # The empty string is equivalent to '%b %d, %Y'. # # html_last_updated_fmt = None # 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 # Language to be used for generating the HTML full-text search index. # Sphinx supports the following languages: # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh' # # html_search_language = 'en' # A dictionary with options for the search language support, empty by default. # 'ja' uses this config value. # 'zh' user can custom change `jieba` dictionary path. # # html_search_options = {'type': 'default'} # The name of a javascript file (relative to the configuration directory) that # implements a search results scorer. If empty, the default will be used. # # html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. htmlhelp_basename = 'CAS-Xrayfeeddoc' # -- 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': '', # Latex figure (float) alignment # # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, 'Xrayfeed.tex', 'XrayFeed', 'CAS', '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 = [] # It false, will not define \strong, \code, itleref, \crossref ... but only # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added # packages. # # latex_keep_old_macro_names = True # 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 = [ (master_doc, 'cas-xrayfeed', 'XrayFeed Documentation', [author], 1) ] # If true, show URL addresses after external links. # # man_show_urls = False # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ (master_doc, 'xrayfeed', 'XrayFeed Documentation', [author], 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 = [ (master_doc, 'XrayFeed', 'XrayFeed Documentation', author, 'XrayFeed', 'One line description of project.', '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' # If true, do not generate a @detailmenu in the "Top" node's menu. # # texinfo_no_detailmenu = False # set this variable for allowing references numfig = True ########################################################################### # 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': [ ("latest", "/en/latest/"), ("docs", "/en/docs/"), ], 'downloads': [ ], 'subprojects': [ ], 'slug': 'jjattenuator', 'name': u'jjAttenuator', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': 'http://rtd.xfel.eu/docs/jjattenuator/en/latest/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/doc/source/', 'api_host': 'http://rtd.xfel.eu', 'github_user': 'None', 'proxied_api_host': '/_', 'github_repo': 'None', 'github_version': 'master', 'display_github': False, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'master', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': 'master', 'display_gitlab': False, 'READTHEDOCS': True, 'using_theme': (html_theme == "default"), 'new_theme': (html_theme == "sphinx_rtd_theme"), 'source_suffix': SUFFIX, 'ad_free': False, 'docsearch_disabled': False, 'user_analytics_code': '', 'global_analytics_code': 'None', 'commit': '7e28d53a', } 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: 2022-12-05T11:53:06.066249Z, end-time: 2022-12-05T11:53:07.446262Z, duration: 1, exit-code: 0 python /usr/src/app/checkouts/readthedocs.org/user_builds/jjattenuator/envs/latest/bin/sphinx-build -T -E -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Running Sphinx v5.3.0 WARNING: Invalid configuration value found: 'language = None'. Update your configuration to a valid language code. Falling back to 'en' (English). making output directory... done building [mo]: targets for 0 po files that are out of date building [readthedocs]: targets for 6 source files that are out of date updating environment: [new config] 6 added, 0 changed, 0 removed reading sources... [ 16%] JJAttenuator reading sources... [ 33%] device_init reading sources... [ 50%] device_run reading sources... [ 66%] device_state reading sources... [ 83%] index reading sources... [100%] introduction looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 16%] JJAttenuator writing output... [ 33%] device_init writing output... [ 50%] device_run writing output... [ 66%] device_state writing output... [ 83%] index writing output... [100%] introduction generating indices... genindex done writing additional pages... search done copying images... [ 11%] _images/SPB_motors.png copying images... [ 22%] _images/material_selection.png copying images... [ 33%] _images/rod_positions.png copying images... [ 44%] _images/move_slots.png copying images... [ 55%] _images/rod_status_pos.png copying images... [ 66%] _images/device_running.png copying images... [ 77%] _images/target_config.png copying images... [ 88%] _images/SAA.png copying images... [100%] _images/arm_slots.png copying static files... done copying readthedocs static files... done copying searchtools... done copying extra files... done dumping search index in English (code: en)... done dumping object inventory... done build succeeded, 1 warning. The HTML pages are in _build/html.