Read the Docs build information Build id: 1223118 Project: advanced-micro-devices-rocsolver Version: latest Commit: 56bcc88cd481018cdd5e53386d91e1603b301dd6 Date: 2022-12-15T01:13:36.877719Z State: cancelled Success: False [rtd-command-info] start-time: 2022-12-15T01:13:38.821471Z, end-time: 2022-12-15T01:13:40.518596Z, duration: 1, exit-code: 0 git clone --no-single-branch --depth 50 https://github.com/ROCmSoftwarePlatform/rocSOLVER.git . Cloning into '.'... [rtd-command-info] start-time: 2022-12-15T01:13:40.714701Z, end-time: 2022-12-15T01:13:40.918636Z, duration: 0, exit-code: 0 git checkout --force origin/develop Note: switching to 'origin/develop'. 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 56bcc88 Added geblttrf_npvt and geblttrs_npvt (#496) [rtd-command-info] start-time: 2022-12-15T01:13:41.097020Z, end-time: 2022-12-15T01:13:41.153690Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2022-12-15T01:13:42.139702Z, end-time: 2022-12-15T01:13:46.677794Z, duration: 4, exit-code: 0 python3.7 -mvirtualenv Using base prefix '/home/docs/.pyenv/versions/3.7.9' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocsolver/envs/latest/bin/python3.7 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocsolver/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2022-12-15T01:13:46.898325Z, end-time: 2022-12-15T01:13:48.700509Z, duration: 1, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip setuptools<58.3.0 Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocsolver/envs/latest/lib/python3.7/site-packages (22.3.1) Collecting setuptools<58.3.0 Downloading setuptools-58.2.0-py3-none-any.whl (946 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 946.1/946.1 kB 19.5 MB/s eta 0:00:00 Installing collected packages: setuptools Attempting uninstall: setuptools Found existing installation: setuptools 65.6.3 Uninstalling setuptools-65.6.3: Successfully uninstalled setuptools-65.6.3 Successfully installed setuptools-58.2.0 [rtd-command-info] start-time: 2022-12-15T01:13:48.880134Z, end-time: 2022-12-15T01:13:56.093195Z, duration: 7, exit-code: 0 python -m pip install --upgrade --no-cache-dir pillow==5.4.1 mock==1.0.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.9.1 recommonmark==0.5.0 sphinx sphinx-rtd-theme readthedocs-sphinx-ext<2.3 Collecting pillow==5.4.1 Downloading Pillow-5.4.1-cp37-cp37m-manylinux1_x86_64.whl (2.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.0/2.0 MB 37.2 MB/s eta 0:00:00 Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 kB 244.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.9.1 Downloading commonmark-0.9.1-py2.py3-none-any.whl (51 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 51.1/51.1 kB 181.7 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 Downloading sphinx-5.3.0-py3-none-any.whl (3.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.2/3.2 MB 184.9 MB/s eta 0:00:00 Collecting sphinx-rtd-theme Downloading sphinx_rtd_theme-1.1.1-py2.py3-none-any.whl (2.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.8/2.8 MB 196.9 MB/s eta 0:00:00 Collecting readthedocs-sphinx-ext<2.3 Downloading readthedocs_sphinx_ext-2.2.0-py2.py3-none-any.whl (11 kB) Collecting docutils>=0.11 Downloading docutils-0.19-py3-none-any.whl (570 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 570.5/570.5 kB 243.6 MB/s eta 0:00:00 Collecting sphinxcontrib-qthelp Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 90.6/90.6 kB 199.0 MB/s eta 0:00:00 Collecting packaging>=21.0 Downloading packaging-22.0-py3-none-any.whl (42 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 42.6/42.6 kB 172.7 MB/s eta 0:00:00 Collecting sphinxcontrib-applehelp Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.2/121.2 kB 224.1 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 209.7 MB/s eta 0:00:00 Collecting requests>=2.5.0 Downloading requests-2.28.1-py3-none-any.whl (62 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.8/62.8 kB 199.4 MB/s eta 0:00:00 Collecting babel>=2.9 Downloading Babel-2.11.0-py3-none-any.whl (9.5 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 9.5/9.5 MB 170.9 MB/s eta 0:00:00 Collecting sphinxcontrib-jsmath Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Collecting Pygments>=2.12 Downloading Pygments-2.13.0-py3-none-any.whl (1.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.1/1.1 MB 247.6 MB/s eta 0:00:00 Collecting imagesize>=1.3 Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Collecting Jinja2>=3.0 Downloading Jinja2-3.1.2-py3-none-any.whl (133 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.1/133.1 kB 221.4 MB/s eta 0:00:00 Collecting sphinxcontrib-htmlhelp>=2.0.0 Downloading sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl (100 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100.5/100.5 kB 217.6 MB/s eta 0:00:00 Collecting snowballstemmer>=2.0 Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 207.2 MB/s eta 0:00:00 Collecting importlib-metadata>=4.8 Downloading importlib_metadata-5.1.0-py3-none-any.whl (21 kB) Collecting sphinxcontrib-serializinghtml>=1.1.5 Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 94.0/94.0 kB 208.4 MB/s eta 0:00:00 Collecting docutils>=0.11 Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 575.5/575.5 kB 238.7 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 237.1 MB/s eta 0:00:00 Collecting typing-extensions>=3.6.4 Downloading typing_extensions-4.4.0-py3-none-any.whl (26 kB) Collecting zipp>=0.5 Downloading zipp-3.11.0-py3-none-any.whl (6.6 kB) Collecting MarkupSafe>=2.0 Downloading MarkupSafe-2.1.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB) 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 221.3 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 186.5 MB/s eta 0:00:00 Collecting certifi>=2017.4.17 Downloading certifi-2022.12.7-py3-none-any.whl (155 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 155.3/155.3 kB 217.9 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=23772 sha256=821560041f6bca8090e7a892dfe5a38731ee44bc7e1b916138a98d28a7d989f5 Stored in directory: /tmp/pip-ephem-wheel-cache-iqrb7itc/wheels/d1/33/8e/f9d24f00cc130866aacfe7c3bc15571217e2b22cc4c4e1b443 Successfully built mock Installing collected packages: snowballstemmer, pytz, mock, commonmark, alabaster, zipp, urllib3, typing-extensions, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, Pygments, pillow, packaging, MarkupSafe, imagesize, idna, docutils, charset-normalizer, certifi, babel, requests, Jinja2, importlib-metadata, sphinx, readthedocs-sphinx-ext, sphinx-rtd-theme, recommonmark Successfully installed Jinja2-3.1.2 MarkupSafe-2.1.1 Pygments-2.13.0 alabaster-0.7.12 babel-2.11.0 certifi-2022.12.7 charset-normalizer-2.1.1 commonmark-0.9.1 docutils-0.17.1 idna-3.4 imagesize-1.4.1 importlib-metadata-5.1.0 mock-1.0.1 packaging-22.0 pillow-5.4.1 pytz-2022.6 readthedocs-sphinx-ext-2.2.0 recommonmark-0.5.0 requests-2.28.1 snowballstemmer-2.2.0 sphinx-5.3.0 sphinx-rtd-theme-1.1.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 sphinxcontrib-serializinghtml-1.1.5 typing-extensions-4.4.0 urllib3-1.26.13 zipp-3.11.0 [rtd-command-info] start-time: 2022-12-15T01:13:56.277460Z, end-time: 2022-12-15T01:14:02.787087Z, duration: 6, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r docs/source/requirements.txt Requirement already satisfied: alabaster==0.7.12 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocsolver/envs/latest/lib/python3.7/site-packages (from -r docs/source/requirements.txt (line 7)) (0.7.12) Collecting babel==2.9.1 Downloading Babel-2.9.1-py2.py3-none-any.whl (8.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 8.8/8.8 MB 104.4 MB/s eta 0:00:00 Collecting breathe==4.28.0 Downloading breathe-4.28.0-py3-none-any.whl (82 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 82.6/82.6 kB 205.1 MB/s eta 0:00:00 Collecting certifi==2021.10.8 Downloading certifi-2021.10.8-py2.py3-none-any.whl (149 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 149.2/149.2 kB 220.5 MB/s eta 0:00:00 Collecting charset-normalizer==2.0.12 Downloading charset_normalizer-2.0.12-py3-none-any.whl (39 kB) Collecting docutils==0.16 Downloading docutils-0.16-py2.py3-none-any.whl (548 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 548.2/548.2 kB 242.4 MB/s eta 0:00:00 Collecting idna==3.3 Downloading idna-3.3-py3-none-any.whl (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.2/61.2 kB 210.1 MB/s eta 0:00:00 Collecting imagesize==1.3.0 Downloading imagesize-1.3.0-py2.py3-none-any.whl (5.2 kB) Collecting jinja2==3.0.3 Downloading Jinja2-3.0.3-py3-none-any.whl (133 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.6/133.6 kB 56.6 MB/s eta 0:00:00 Collecting m2r2==0.3.1 Downloading m2r2-0.3.1-py3-none-any.whl (11 kB) Requirement already satisfied: markupsafe==2.1.1 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocsolver/envs/latest/lib/python3.7/site-packages (from -r docs/source/requirements.txt (line 35)) (2.1.1) Collecting mistune==0.8.4 Downloading mistune-0.8.4-py2.py3-none-any.whl (16 kB) Collecting packaging==21.3 Downloading packaging-21.3-py3-none-any.whl (40 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 40.8/40.8 kB 182.2 MB/s eta 0:00:00 Collecting pygments==2.11.2 Downloading Pygments-2.11.2-py3-none-any.whl (1.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.1/1.1 MB 245.3 MB/s eta 0:00:00 Collecting pyparsing==3.0.7 Downloading pyparsing-3.0.7-py3-none-any.whl (98 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 98.0/98.0 kB 199.3 MB/s eta 0:00:00 Collecting pytz==2022.1 Downloading pytz-2022.1-py2.py3-none-any.whl (503 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 503.5/503.5 kB 236.8 MB/s eta 0:00:00 Collecting readthedocs-sphinx-ext==2.1.4 Downloading readthedocs_sphinx_ext-2.1.4-py2.py3-none-any.whl (29 kB) Collecting requests==2.27.1 Downloading requests-2.27.1-py2.py3-none-any.whl (63 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 63.1/63.1 kB 191.7 MB/s eta 0:00:00 Collecting six==1.16.0 Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Requirement already satisfied: snowballstemmer==2.2.0 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocsolver/envs/latest/lib/python3.7/site-packages (from -r docs/source/requirements.txt (line 57)) (2.2.0) Collecting sphinx==3.5.3 Downloading Sphinx-3.5.3-py3-none-any.whl (2.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.8/2.8 MB 198.8 MB/s eta 0:00:00 Collecting sphinx-rtd-theme==0.5.2 Downloading sphinx_rtd_theme-0.5.2-py2.py3-none-any.whl (9.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 9.1/9.1 MB 189.1 MB/s eta 0:00:00 Requirement already satisfied: sphinxcontrib-applehelp==1.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocsolver/envs/latest/lib/python3.7/site-packages (from -r docs/source/requirements.txt (line 66)) (1.0.2) Requirement already satisfied: sphinxcontrib-devhelp==1.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocsolver/envs/latest/lib/python3.7/site-packages (from -r docs/source/requirements.txt (line 68)) (1.0.2) Requirement already satisfied: sphinxcontrib-htmlhelp==2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocsolver/envs/latest/lib/python3.7/site-packages (from -r docs/source/requirements.txt (line 70)) (2.0.0) Requirement already satisfied: sphinxcontrib-jsmath==1.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocsolver/envs/latest/lib/python3.7/site-packages (from -r docs/source/requirements.txt (line 72)) (1.0.1) Requirement already satisfied: sphinxcontrib-qthelp==1.0.3 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocsolver/envs/latest/lib/python3.7/site-packages (from -r docs/source/requirements.txt (line 74)) (1.0.3) Requirement already satisfied: sphinxcontrib-serializinghtml==1.1.5 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocsolver/envs/latest/lib/python3.7/site-packages (from -r docs/source/requirements.txt (line 76)) (1.1.5) Collecting urllib3==1.26.9 Downloading urllib3-1.26.9-py2.py3-none-any.whl (138 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 139.0/139.0 kB 227.3 MB/s eta 0:00:00 Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocsolver/envs/latest/lib/python3.7/site-packages (from sphinx==3.5.3->-r docs/source/requirements.txt (line 59)) (58.2.0) Installing collected packages: pytz, mistune, certifi, urllib3, six, pyparsing, pygments, jinja2, imagesize, idna, docutils, charset-normalizer, babel, requests, packaging, m2r2, sphinx, readthedocs-sphinx-ext, sphinx-rtd-theme, breathe Attempting uninstall: pytz Found existing installation: pytz 2022.6 Uninstalling pytz-2022.6: Successfully uninstalled pytz-2022.6 Attempting uninstall: certifi Found existing installation: certifi 2022.12.7 Uninstalling certifi-2022.12.7: Successfully uninstalled certifi-2022.12.7 Attempting uninstall: urllib3 Found existing installation: urllib3 1.26.13 Uninstalling urllib3-1.26.13: Successfully uninstalled urllib3-1.26.13 Attempting uninstall: pygments Found existing installation: Pygments 2.13.0 Uninstalling Pygments-2.13.0: Successfully uninstalled Pygments-2.13.0 Attempting uninstall: jinja2 Found existing installation: Jinja2 3.1.2 Uninstalling Jinja2-3.1.2: Successfully uninstalled Jinja2-3.1.2 Attempting uninstall: imagesize Found existing installation: imagesize 1.4.1 Uninstalling imagesize-1.4.1: Successfully uninstalled imagesize-1.4.1 Attempting uninstall: idna Found existing installation: idna 3.4 Uninstalling idna-3.4: Successfully uninstalled idna-3.4 Attempting uninstall: docutils Found existing installation: docutils 0.17.1 Uninstalling docutils-0.17.1: Successfully uninstalled docutils-0.17.1 Attempting uninstall: charset-normalizer Found existing installation: charset-normalizer 2.1.1 Uninstalling charset-normalizer-2.1.1: Successfully uninstalled charset-normalizer-2.1.1 Attempting uninstall: babel Found existing installation: Babel 2.11.0 Uninstalling Babel-2.11.0: Successfully uninstalled Babel-2.11.0 Attempting uninstall: requests Found existing installation: requests 2.28.1 Uninstalling requests-2.28.1: Successfully uninstalled requests-2.28.1 Attempting uninstall: packaging Found existing installation: packaging 22.0 Uninstalling packaging-22.0: Successfully uninstalled packaging-22.0 Attempting uninstall: sphinx Found existing installation: Sphinx 5.3.0 Uninstalling Sphinx-5.3.0: Successfully uninstalled Sphinx-5.3.0 Attempting uninstall: readthedocs-sphinx-ext Found existing installation: readthedocs-sphinx-ext 2.2.0 Uninstalling readthedocs-sphinx-ext-2.2.0: Successfully uninstalled readthedocs-sphinx-ext-2.2.0 Attempting uninstall: sphinx-rtd-theme Found existing installation: sphinx-rtd-theme 1.1.1 Uninstalling sphinx-rtd-theme-1.1.1: Successfully uninstalled sphinx-rtd-theme-1.1.1 Successfully installed babel-2.9.1 breathe-4.28.0 certifi-2021.10.8 charset-normalizer-2.0.12 docutils-0.16 idna-3.3 imagesize-1.3.0 jinja2-3.0.3 m2r2-0.3.1 mistune-0.8.4 packaging-21.3 pygments-2.11.2 pyparsing-3.0.7 pytz-2022.1 readthedocs-sphinx-ext-2.1.4 requests-2.27.1 six-1.16.0 sphinx-3.5.3 sphinx-rtd-theme-0.5.2 urllib3-1.26.9 [rtd-command-info] start-time: 2022-12-15T01:14:04.380136Z, end-time: 2022-12-15T01:14:04.445485Z, duration: 0, exit-code: 0 cat docs/source/conf.py import os import sys import subprocess read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' if read_the_docs_build: subprocess.call('../run_doxygen.sh') # -- 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.mathjax', 'breathe', 'm2r2'] breathe_projects = { "rocSOLVER": "../docBin/xml" } breathe_default_project = "rocSOLVER" breathe_domain_by_extension = { "h" : "c", "hpp" : "cpp", } # 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': 'restructuredtext', '.md': 'markdown'} # The master toctree document. master_doc = 'index' # General information about the project. project = u'rocSOLVER' copyright = u'2020, Advanced Micro Devices' author = u'Advanced Micro Devices' # 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 = u'3.21' # The full version, including alpha/beta/rc tags. release = u'3.21.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 = 'en' # 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 = ['_build', 'Thumbs.db', '.DS_Store'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False # -- 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 = 'alabaster' #if read_the_docs_build: # html_theme = 'default' #else: import sphinx_rtd_theme html_theme = "sphinx_rtd_theme" html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # 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 = { 'navigation_depth': 4, 'prev_next_buttons_location': 'both', 'display_version': True, 'collapse_navigation': False, } # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". # html_static_path = ['_static'] # Custom sidebar templates, must be a dictionary that maps document names # to template names. # # This is required for the alabaster theme # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars # html_sidebars = { # '**': [ # 'relations.html', # needs 'show_related': True theme option to display # 'searchbox.html', # ] # } # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. htmlhelp_basename = 'rocSOLVERdoc' # -- 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': '\setcounter{tocdepth}{5}', # 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, 'rocSOLVER.tex', u'rocSOLVER Documentation', u'Advanced Micro Devices', 'manual'), ] # -- 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, 'rocsolver', u'rocSOLVER Documentation', [author], 1) ] # -- 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, 'rocSOLVER', u'rocSOLVER Documentation', author, 'rocSOLVER development team', 'Implementation of LAPACK routines on AMD GPUs', 'Miscellaneous'), ] ########################################################################### # auto-created readthedocs.org specific configuration # ########################################################################### # # The following code was added during an automated build on readthedocs.org # It is auto created and injected for every build. The result is based on the # conf.py.tmpl file found in the readthedocs.org codebase: # https://github.com/rtfd/readthedocs.org/blob/main/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl # # Note: this file shouldn't rely on extra dependencies. import importlib import sys import os.path # Borrowed from six. PY3 = sys.version_info[0] == 3 string_types = str if PY3 else basestring from sphinx import version_info # Get suffix for proper linking to GitHub # This is deprecated in Sphinx 1.3+, # as each page can have its own suffix if globals().get('source_suffix', False): if isinstance(source_suffix, string_types): SUFFIX = source_suffix elif isinstance(source_suffix, (list, tuple)): # Sphinx >= 1.3 supports list/tuple to define multiple suffixes SUFFIX = source_suffix[0] elif isinstance(source_suffix, dict): # Sphinx >= 1.8 supports a mapping dictionary for multiple suffixes SUFFIX = list(source_suffix.keys())[0] # make a ``list()`` for py2/py3 compatibility else: # default to .rst SUFFIX = '.rst' else: SUFFIX = '.rst' # Add RTD Static Path. Add to the end because it overwrites previous files. if not 'html_static_path' in globals(): html_static_path = [] if os.path.exists('_static'): html_static_path.append('_static') # Add RTD Theme only if they aren't overriding it already using_rtd_theme = ( ( 'html_theme' in globals() and html_theme in ['default'] and # Allow people to bail with a hack of having an html_style 'html_style' not in globals() ) or 'html_theme' not in globals() ) if using_rtd_theme: 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 = 'https://readthedocs.com/websupport' websupport2_static_url = 'https://assets.readthedocs.com/' #Add project information to the template context. context = { 'using_theme': using_rtd_theme, 'html_theme': html_theme, 'current_version': "latest", 'version_slug': "latest", 'MEDIA_URL': "https://media.readthedocs.com/media/", 'STATIC_URL': "https://assets.readthedocs.com/", 'PRODUCTION_DOMAIN': "readthedocs.com", 'proxied_static_path': "/_/static/", 'versions': [ ], 'downloads': [ ("pdf", "//rocmdocs.amd.com/_/downloads/rocSOLVER/en/latest/pdf/"), ("html", "//rocmdocs.amd.com/_/downloads/rocSOLVER/en/latest/htmlzip/"), ("epub", "//rocmdocs.amd.com/_/downloads/rocSOLVER/en/latest/epub/"), ], 'subprojects': [ ], 'slug': 'advanced-micro-devices-rocsolver', 'name': u'rocSOLVER', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': 'https://rocmdocs.amd.com/projects/rocSOLVER/en/latest/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/docs/source/', 'api_host': 'https://readthedocs.com', 'github_user': 'ROCmSoftwarePlatform', 'proxied_api_host': '/_', 'github_repo': 'rocSOLVER', 'github_version': 'develop', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'develop', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': 'develop', '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': '56bcc88c', } # 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(): 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") readthedocs_vcs_url = 'None' readthedocs_build_url = 'https://readthedocs.com/projects/advanced-micro-devices-rocsolver/builds/1223118/' 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'])