Read the Docs build information Build id: 1278338 Project: cerebras-systems-cerebras-systems-developer-documentation Version: latest Commit: af571d121a7ccd982148de2800de215961debe92 Date: 2023-01-31T20:20:12.521424Z State: cancelled Success: False [rtd-command-info] start-time: 2023-01-31T20:20:14.586019Z, end-time: 2023-01-31T20:20:18.345274Z, duration: 3, exit-code: 0 git clone --no-single-branch --depth 50 git@github.com:Cerebras/documentation.git . Cloning into '.'... Warning: Permanently added 'github.com,192.30.255.113' (ECDSA) to the list of known hosts. [rtd-command-info] start-time: 2023-01-31T20:20:18.694831Z, end-time: 2023-01-31T20:20:18.874159Z, duration: 0, exit-code: 0 git checkout --force origin/main Note: switching to 'origin/main'. You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by switching back to a branch. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -c with the switch command. Example: git switch -c Or undo this operation with: git switch - Turn off this advice by setting config variable advice.detachedHead to false HEAD is now at af571d1 Create cs-tensorflow-pl-ws-unified-appliance.rst [rtd-command-info] start-time: 2023-01-31T20:20:19.126427Z, end-time: 2023-01-31T20:20:19.196539Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2023-01-31T20:20:20.195131Z, end-time: 2023-01-31T20:20:24.797052Z, 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/cerebras-systems-cerebras-systems-developer-documentation/envs/latest/bin/python3.7 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/cerebras-systems-cerebras-systems-developer-documentation/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2023-01-31T20:20:25.091024Z, end-time: 2023-01-31T20:20:26.855404Z, 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/cerebras-systems-cerebras-systems-developer-documentation/envs/latest/lib/python3.7/site-packages (23.0) Collecting setuptools<58.3.0 Downloading setuptools-58.2.0-py3-none-any.whl (946 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 946.1/946.1 kB 30.6 MB/s eta 0:00:00 Installing collected packages: setuptools Attempting uninstall: setuptools Found existing installation: setuptools 67.0.0 Uninstalling setuptools-67.0.0: Successfully uninstalled setuptools-67.0.0 Successfully installed setuptools-58.2.0 [rtd-command-info] start-time: 2023-01-31T20:20:27.039208Z, end-time: 2023-01-31T20:20:33.638752Z, duration: 6, exit-code: 0 python -m pip install --upgrade --no-cache-dir pillow mock==1.0.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.9.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<2.3 jinja2<3.1.0 Collecting pillow Downloading Pillow-9.4.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.3 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.3/3.3 MB 77.1 MB/s eta 0:00:00 Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 kB 242.8 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 (13 kB) Collecting commonmark==0.9.1 Downloading commonmark-0.9.1-py2.py3-none-any.whl (51 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 51.1/51.1 kB 165.6 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 186.1 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 171.2 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 jinja2<3.1.0 Downloading Jinja2-3.0.3-py3-none-any.whl (133 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.6/133.6 kB 218.1 MB/s eta 0:00:00 Collecting docutils>=0.11 Downloading docutils-0.19-py3-none-any.whl (570 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 570.5/570.5 kB 233.8 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 184.7 MB/s eta 0:00:00 Collecting imagesize Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Collecting docutils>=0.11 Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 575.5/575.5 kB 241.9 MB/s eta 0:00:00 Collecting sphinxcontrib-websupport Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB) Collecting Pygments>=2.0 Downloading Pygments-2.14.0-py3-none-any.whl (1.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.1/1.1 MB 230.6 MB/s eta 0:00:00 Collecting packaging Downloading packaging-23.0-py3-none-any.whl (42 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 42.7/42.7 kB 139.9 MB/s eta 0:00:00 Collecting requests>=2.0.0 Downloading requests-2.28.2-py3-none-any.whl (62 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.8/62.8 kB 176.4 MB/s eta 0:00:00 Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/cerebras-systems-cerebras-systems-developer-documentation/envs/latest/lib/python3.7/site-packages (from sphinx<2) (58.2.0) Collecting six>=1.5 Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Collecting babel!=2.0,>=1.3 Downloading Babel-2.11.0-py3-none-any.whl (9.5 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 9.5/9.5 MB 186.5 MB/s eta 0:00:00 Collecting MarkupSafe>=2.0 Downloading MarkupSafe-2.1.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB) Collecting pytz>=2015.7 Downloading pytz-2022.7.1-py2.py3-none-any.whl (499 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 499.4/499.4 kB 240.9 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 184.6 MB/s eta 0:00:00 Collecting charset-normalizer<4,>=2 Downloading charset_normalizer-3.0.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (170 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 170.5/170.5 kB 215.2 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.4 MB/s eta 0:00:00 Collecting urllib3<1.27,>=1.21.1 Downloading urllib3-1.26.14-py2.py3-none-any.whl (140 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 140.6/140.6 kB 216.3 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 201.4 MB/s eta 0:00:00 Building wheels for collected packages: mock Building wheel for mock (setup.py): started Building wheel for mock (setup.py): finished with status 'done' Created wheel for mock: filename=mock-1.0.1-py3-none-any.whl size=23772 sha256=43f5f4e24cf9ab5f863f2aaed6489bf418f848a909176f2b8c8f6a649324c93c Stored in directory: /tmp/pip-ephem-wheel-cache-v0cweqml/wheels/7a/94/b1/0fdc5339a5bd487a5cc15421ec200d9ba3e2aa7190e4a727f1 Successfully built mock Installing collected packages: snowballstemmer, pytz, mock, commonmark, charset-normalizer, urllib3, sphinxcontrib-serializinghtml, six, Pygments, pillow, packaging, MarkupSafe, imagesize, idna, docutils, certifi, babel, alabaster, sphinxcontrib-websupport, requests, jinja2, sphinx, readthedocs-sphinx-ext, sphinx-rtd-theme, recommonmark Successfully installed MarkupSafe-2.1.2 Pygments-2.14.0 alabaster-0.7.13 babel-2.11.0 certifi-2022.12.7 charset-normalizer-3.0.1 commonmark-0.9.1 docutils-0.17.1 idna-3.4 imagesize-1.4.1 jinja2-3.0.3 mock-1.0.1 packaging-23.0 pillow-9.4.0 pytz-2022.7.1 readthedocs-sphinx-ext-2.2.0 recommonmark-0.5.0 requests-2.28.2 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.14 [rtd-command-info] start-time: 2023-01-31T20:20:33.854743Z, end-time: 2023-01-31T20:20:38.023814Z, duration: 4, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r external/requirements.txt Collecting sphinx_copybutton Downloading sphinx_copybutton-0.5.1-py3-none-any.whl (13 kB) Collecting sphinx_panels Downloading sphinx_panels-0.6.0-py3-none-any.whl (87 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 87.7/87.7 kB 7.9 MB/s eta 0:00:00 Collecting readthedocs-sphinx-search Downloading readthedocs_sphinx_search-0.2.0-py3-none-any.whl (18 kB) Collecting sphinx_book_theme==0.1.10 Downloading sphinx_book_theme-0.1.10-py3-none-any.whl (94 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 94.5/94.5 kB 66.6 MB/s eta 0:00:00 Collecting beautifulsoup4<5,>=4.6.1 Downloading beautifulsoup4-4.11.2-py3-none-any.whl (129 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 129.4/129.4 kB 201.4 MB/s eta 0:00:00 Collecting pydata-sphinx-theme~=0.7.2 Downloading pydata_sphinx_theme-0.7.2-py3-none-any.whl (1.4 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.4/1.4 MB 78.0 MB/s eta 0:00:00 Collecting pyyaml Downloading PyYAML-6.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (596 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 596.3/596.3 kB 243.3 MB/s eta 0:00:00 Collecting docutils<0.17,>=0.15 Downloading docutils-0.16-py2.py3-none-any.whl (548 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 548.2/548.2 kB 242.8 MB/s eta 0:00:00 Collecting sphinx<5,>=3 Downloading Sphinx-4.5.0-py3-none-any.whl (3.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.1/3.1 MB 195.0 MB/s eta 0:00:00 Collecting soupsieve>1.2 Downloading soupsieve-2.3.2.post1-py3-none-any.whl (37 kB) Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/cerebras-systems-cerebras-systems-developer-documentation/envs/latest/lib/python3.7/site-packages (from sphinx<5,>=3->sphinx_book_theme==0.1.10->-r external/requirements.txt (line 4)) (1.4.1) Collecting sphinxcontrib-htmlhelp>=2.0.0 Downloading sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl (100 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100.5/100.5 kB 207.1 MB/s eta 0:00:00 Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in /home/docs/checkouts/readthedocs.org/user_builds/cerebras-systems-cerebras-systems-developer-documentation/envs/latest/lib/python3.7/site-packages (from sphinx<5,>=3->sphinx_book_theme==0.1.10->-r external/requirements.txt (line 4)) (1.1.5) Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/cerebras-systems-cerebras-systems-developer-documentation/envs/latest/lib/python3.7/site-packages (from sphinx<5,>=3->sphinx_book_theme==0.1.10->-r external/requirements.txt (line 4)) (2.28.2) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/cerebras-systems-cerebras-systems-developer-documentation/envs/latest/lib/python3.7/site-packages (from sphinx<5,>=3->sphinx_book_theme==0.1.10->-r external/requirements.txt (line 4)) (0.7.13) Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/cerebras-systems-cerebras-systems-developer-documentation/envs/latest/lib/python3.7/site-packages (from sphinx<5,>=3->sphinx_book_theme==0.1.10->-r external/requirements.txt (line 4)) (2.2.0) Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/cerebras-systems-cerebras-systems-developer-documentation/envs/latest/lib/python3.7/site-packages (from sphinx<5,>=3->sphinx_book_theme==0.1.10->-r external/requirements.txt (line 4)) (2.14.0) Requirement already satisfied: babel>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/cerebras-systems-cerebras-systems-developer-documentation/envs/latest/lib/python3.7/site-packages (from sphinx<5,>=3->sphinx_book_theme==0.1.10->-r external/requirements.txt (line 4)) (2.11.0) Collecting sphinxcontrib-devhelp Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 84.7/84.7 kB 200.4 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 200.1 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: packaging in /home/docs/checkouts/readthedocs.org/user_builds/cerebras-systems-cerebras-systems-developer-documentation/envs/latest/lib/python3.7/site-packages (from sphinx<5,>=3->sphinx_book_theme==0.1.10->-r external/requirements.txt (line 4)) (23.0) Collecting importlib-metadata>=4.4 Downloading importlib_metadata-6.0.0-py3-none-any.whl (21 kB) Collecting sphinxcontrib-applehelp Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.2/121.2 kB 207.4 MB/s eta 0:00:00 Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/cerebras-systems-cerebras-systems-developer-documentation/envs/latest/lib/python3.7/site-packages (from sphinx<5,>=3->sphinx_book_theme==0.1.10->-r external/requirements.txt (line 4)) (3.0.3) Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/cerebras-systems-cerebras-systems-developer-documentation/envs/latest/lib/python3.7/site-packages (from babel>=1.3->sphinx<5,>=3->sphinx_book_theme==0.1.10->-r external/requirements.txt (line 4)) (2022.7.1) Collecting zipp>=0.5 Downloading zipp-3.12.0-py3-none-any.whl (6.6 kB) Collecting typing-extensions>=3.6.4 Downloading typing_extensions-4.4.0-py3-none-any.whl (26 kB) Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/cerebras-systems-cerebras-systems-developer-documentation/envs/latest/lib/python3.7/site-packages (from Jinja2>=2.3->sphinx<5,>=3->sphinx_book_theme==0.1.10->-r external/requirements.txt (line 4)) (2.1.2) Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/cerebras-systems-cerebras-systems-developer-documentation/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx<5,>=3->sphinx_book_theme==0.1.10->-r external/requirements.txt (line 4)) (3.0.1) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/cerebras-systems-cerebras-systems-developer-documentation/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx<5,>=3->sphinx_book_theme==0.1.10->-r external/requirements.txt (line 4)) (2022.12.7) Requirement already satisfied: urllib3<1.27,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/cerebras-systems-cerebras-systems-developer-documentation/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx<5,>=3->sphinx_book_theme==0.1.10->-r external/requirements.txt (line 4)) (1.26.14) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/cerebras-systems-cerebras-systems-developer-documentation/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx<5,>=3->sphinx_book_theme==0.1.10->-r external/requirements.txt (line 4)) (3.4) Installing collected packages: zipp, typing-extensions, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, soupsieve, readthedocs-sphinx-search, pyyaml, docutils, importlib-metadata, beautifulsoup4, sphinx, sphinx_panels, sphinx_copybutton, pydata-sphinx-theme, sphinx_book_theme Attempting uninstall: docutils Found existing installation: docutils 0.17.1 Uninstalling docutils-0.17.1: Successfully uninstalled docutils-0.17.1 Attempting uninstall: sphinx Found existing installation: Sphinx 1.8.6 Uninstalling Sphinx-1.8.6: Successfully uninstalled Sphinx-1.8.6 Successfully installed beautifulsoup4-4.11.2 docutils-0.16 importlib-metadata-6.0.0 pydata-sphinx-theme-0.7.2 pyyaml-6.0 readthedocs-sphinx-search-0.2.0 soupsieve-2.3.2.post1 sphinx-4.5.0 sphinx_book_theme-0.1.10 sphinx_copybutton-0.5.1 sphinx_panels-0.6.0 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 typing-extensions-4.4.0 zipp-3.12.0 [rtd-command-info] start-time: 2023-01-31T20:20:39.536366Z, end-time: 2023-01-31T20:20:39.614089Z, duration: 0, exit-code: 0 cat external/source/conf.py # Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full # list see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html # -- Path setup -------------------------------------------------------------- # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # # import os # import sys # sys.path.insert(0, os.path.abspath('lib/python3.6/site-packages')) # import os # import sys # sys.path.insert(0, os.path.abspath('.')) # sys.path.insert(0, os.path.abspath('../source/tf')) # # autodoc_mock_imports = ['common_zoo', 'tensorflow', 'numpy' ] # This below combo of path and autodoc mock list works with the layer files copied over to my local source/tf import os import sys sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('..')) sys.path.insert(0, os.path.abspath('tf/layers/')) autodoc_mock_imports = ['modelzoo', 'tensorflow', 'numpy', 'cerebras', 'tensorflow_addons'] # -- Project information ----------------------------------------------------- project = 'Cerebras Developer Documentation' copyright = '2022, Cerebras Systems' author = '' html_title = "Software Documentation (Version 1.7.0)" html_logo = "images/CER_logo.svg" html_favicon = 'images/cs-favicon.png' html_last_updated_fmt = '%c' # -- General configuration --------------------------------------------------- # 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_copybutton", "sphinx_panels", "sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx.ext.graphviz", "sphinx.ext.inheritance_diagram", ] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] html_additional_pages = { # "index": "index.html" } # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. # Temporarily remove API docs while testing -Raj # exclude_patterns = ["tensorflow-docs/api-rst", "tensorflow-docs/cs-1-tf-user-guide/tf-layers", "tensorflow-docs/cs-1-tf-user-guide/running-a-model/cs-input-analyzer.rst", "tensorflow-docs/getting-started/cs-execution-flow.rst"] exclude_patterns = [] # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = "sphinx_book_theme" html_theme_path = [] numfig = True panels_add_bootstrap_css = False html_theme_options = { "show_navbar_depth": 1, "toc_title": "On This Page", } # 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'] html_css_files = [ 'cs-ml-custom.css' ] ########################################################################### # 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': [ ("latest", "/en/latest/"), ], 'downloads': [ ("pdf", "//docs.cerebras.net/_/downloads/en/latest/pdf/"), ("html", "//docs.cerebras.net/_/downloads/en/latest/htmlzip/"), ], 'subprojects': [ ("cerebras-systems-cerebras-sdk-documentation", "https://docs.cerebras.net/projects/sdk-docs/en/latest/"), ("cerebras-systems-isa-documentation", "https://docs.cerebras.net/projects/isa-docs/en/latest/"), ("cerebras-systems-cerebras-operator-documentation", "https://docs.cerebras.net/projects/operator-docs/en/latest/"), ], 'slug': 'cerebras-systems-cerebras-systems-developer-documentation', 'name': u'Cerebras Systems Developer Documentation', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': 'https://docs.cerebras.net/en/latest/', 'analytics_code': 'UA-177830181-2', 'single_version': False, 'conf_py_path': '/external/source/', 'api_host': 'https://readthedocs.com', 'github_user': 'Cerebras', 'proxied_api_host': '/_', 'github_repo': 'documentation', 'github_version': 'main', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'main', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': 'main', 'display_gitlab': False, 'READTHEDOCS': True, 'using_theme': (html_theme == "default"), 'new_theme': (html_theme == "sphinx_rtd_theme"), 'source_suffix': SUFFIX, 'ad_free': False, 'docsearch_disabled': False, 'user_analytics_code': 'UA-177830181-2', 'global_analytics_code': 'UA-17997319-2', 'commit': 'af571d12', } # 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/cerebras-systems-cerebras-systems-developer-documentation/builds/1278338/' 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'])