Read the Docs build information Build id: 1197257 Project: graphcore-ipu-pod128-data-centre-checklist Version: 1.0.0 Commit: dea3876534773070362efa10f8d66e7631fbfe70 Date: 2022-11-27T13:46:00.605676Z State: finished Success: True [rtd-command-info] start-time: 2022-11-27T13:46:02.540947Z, end-time: 2022-11-27T13:46:04.002784Z, duration: 1, exit-code: 0 git clone --no-single-branch --depth 50 git@github.com:gc-docs/ipu-pod128-datacentre-checklist.git . Cloning into '.'... Warning: Permanently added 'github.com,192.30.255.112' (ECDSA) to the list of known hosts. [rtd-command-info] start-time: 2022-11-27T13:46:04.199850Z, end-time: 2022-11-27T13:46:04.290435Z, duration: 0, exit-code: 0 git checkout --force origin/1.0.0 Note: switching to 'origin/1.0.0'. 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 dea3876 Update theme configuration files [rtd-command-info] start-time: 2022-11-27T13:46:04.488821Z, end-time: 2022-11-27T13:46:04.570061Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2022-11-27T13:46:05.506144Z, end-time: 2022-11-27T13:46:09.771390Z, duration: 4, exit-code: 0 python3.6 -mvirtualenv Using base prefix '/home/docs/.pyenv/versions/3.6.12' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/bin/python3.6 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2022-11-27T13:46:09.952388Z, end-time: 2022-11-27T13:46:11.933867Z, 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/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (21.3.1) Collecting setuptools<58.3.0 Downloading setuptools-58.2.0-py3-none-any.whl (946 kB) Installing collected packages: setuptools Attempting uninstall: setuptools Found existing installation: setuptools 59.6.0 Uninstalling setuptools-59.6.0: Successfully uninstalled setuptools-59.6.0 Successfully installed setuptools-58.2.0 [rtd-command-info] start-time: 2022-11-27T13:46:12.117444Z, end-time: 2022-11-27T13:46:20.523085Z, duration: 8, 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-cp36-cp36m-manylinux1_x86_64.whl (2.0 MB) Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) 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) 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) Collecting sphinx-rtd-theme Downloading sphinx_rtd_theme-1.1.1-py2.py3-none-any.whl (2.8 MB) 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.18.1-py2.py3-none-any.whl (570 kB) Collecting sphinxcontrib-htmlhelp>=2.0.0 Downloading sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl (100 kB) Collecting Pygments>=2.12 Downloading Pygments-2.13.0-py3-none-any.whl (1.1 MB) Collecting snowballstemmer>=2.0 Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) Collecting packaging>=21.0 Downloading packaging-21.3-py3-none-any.whl (40 kB) Collecting sphinxcontrib-applehelp Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) Collecting Jinja2>=3.0 Downloading Jinja2-3.0.3-py3-none-any.whl (133 kB) Collecting imagesize>=1.3 Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Collecting importlib-metadata>=4.8 Downloading importlib_metadata-4.8.3-py3-none-any.whl (17 kB) Collecting sphinxcontrib-jsmath Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Collecting sphinxcontrib-qthelp Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) Collecting babel>=2.9 Downloading Babel-2.11.0-py3-none-any.whl (9.5 MB) Collecting requests>=2.5.0 Downloading requests-2.27.1-py2.py3-none-any.whl (63 kB) Collecting sphinxcontrib-devhelp Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) Collecting sphinxcontrib-serializinghtml>=1.1.5 Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) Collecting docutils>=0.11 Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB) Collecting pytz>=2015.7 Downloading pytz-2022.6-py2.py3-none-any.whl (498 kB) Collecting zipp>=0.5 Downloading zipp-3.6.0-py3-none-any.whl (5.3 kB) Collecting typing-extensions>=3.6.4 Downloading typing_extensions-4.1.1-py3-none-any.whl (26 kB) Collecting MarkupSafe>=2.0 Downloading MarkupSafe-2.0.1-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (30 kB) Collecting pyparsing!=3.0.5,>=2.0.2 Downloading pyparsing-3.0.9-py3-none-any.whl (98 kB) Collecting charset-normalizer~=2.0.0 Downloading charset_normalizer-2.0.12-py3-none-any.whl (39 kB) Collecting certifi>=2017.4.17 Downloading certifi-2022.9.24-py3-none-any.whl (161 kB) Collecting urllib3<1.27,>=1.21.1 Downloading urllib3-1.26.13-py2.py3-none-any.whl (140 kB) Collecting idna<4,>=2.5 Downloading idna-3.4-py3-none-any.whl (61 kB) 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=23773 sha256=55034663e299b83498b61e59cf82ffbbda6a71363c39bce5acff93d136842b9a Stored in directory: /tmp/pip-ephem-wheel-cache-oq56xuiz/wheels/98/4d/ec/1aa935d28cb63b7b16037fc990302a34244ac3b0601a4e0c00 Successfully built mock Installing collected packages: zipp, urllib3, typing-extensions, pytz, pyparsing, MarkupSafe, idna, charset-normalizer, certifi, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, snowballstemmer, requests, Pygments, packaging, Jinja2, importlib-metadata, imagesize, docutils, babel, alabaster, sphinx, commonmark, sphinx-rtd-theme, recommonmark, readthedocs-sphinx-ext, pillow, mock Successfully installed Jinja2-3.0.3 MarkupSafe-2.0.1 Pygments-2.13.0 alabaster-0.7.12 babel-2.11.0 certifi-2022.9.24 charset-normalizer-2.0.12 commonmark-0.9.1 docutils-0.17.1 idna-3.4 imagesize-1.4.1 importlib-metadata-4.8.3 mock-1.0.1 packaging-21.3 pillow-5.4.1 pyparsing-3.0.9 pytz-2022.6 readthedocs-sphinx-ext-2.2.0 recommonmark-0.5.0 requests-2.27.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.1.1 urllib3-1.26.13 zipp-3.6.0 [rtd-command-info] start-time: 2022-11-27T13:46:20.825119Z, end-time: 2022-11-27T13:46:28.379134Z, duration: 7, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r requirements.txt Collecting beautifulsoup4==4.10.0 Downloading beautifulsoup4-4.10.0-py3-none-any.whl (97 kB) Collecting breathe==4.33.1 Downloading breathe-4.33.1-py3-none-any.whl (92 kB) Collecting cloud_sptheme==1.10.1.post20200504175005 Downloading cloud_sptheme-1.10.1.post20200504175005-py2.py3-none-any.whl (91 kB) Requirement already satisfied: docutils>0.17 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from -r requirements.txt (line 4)) (0.17.1) Requirement already satisfied: jinja2<3.1.0 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from -r requirements.txt (line 5)) (3.0.3) Collecting m2r==0.2.1 Downloading m2r-0.2.1.tar.gz (16 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting mistune<2.0.0 Downloading mistune-0.8.4-py2.py3-none-any.whl (16 kB) Collecting myst-parser Downloading myst_parser-0.16.1-py3-none-any.whl (48 kB) Collecting regex==2022.3.15 Downloading regex-2022.3.15-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (749 kB) Collecting sphinx_lfs_content==1.1.0 Downloading sphinx_lfs_content-1.1.0.tar.gz (3.7 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting sphinx_rtd_theme==1.0.0 Downloading sphinx_rtd_theme-1.0.0-py2.py3-none-any.whl (2.8 MB) Collecting sphinx-argparse==0.3.1 Downloading sphinx_argparse-0.3.1-py2.py3-none-any.whl (12 kB) Collecting sphinx-copybutton==0.5.0 Downloading sphinx_copybutton-0.5.0-py3-none-any.whl (12 kB) Collecting sphinx-notfound-page==0.8 Downloading sphinx_notfound_page-0.8-py3-none-any.whl (15 kB) Collecting sphinx-tabs Downloading sphinx_tabs-3.3.1-py3-none-any.whl (10.0 kB) Collecting Sphinx==4.5.0 Downloading Sphinx-4.5.0-py3-none-any.whl (3.1 MB) Collecting sphinxcontrib-bibtex==2.4.2 Downloading sphinxcontrib_bibtex-2.4.2-py3-none-any.whl (39 kB) Collecting soupsieve>1.2 Downloading soupsieve-2.3.2.post1-py3-none-any.whl (37 kB) Requirement already satisfied: requests in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from sphinx_lfs_content==1.1.0->-r requirements.txt (line 10)) (2.27.1) Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 16)) (21.3) Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 16)) (1.0.2) Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 16)) (1.0.2) Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 16)) (2.0.0) Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 16)) (2.13.0) Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 16)) (1.0.1) Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 16)) (1.4.1) Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 16)) (1.0.3) Requirement already satisfied: babel>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 16)) (2.11.0) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 16)) (0.7.12) Requirement already satisfied: importlib-metadata>=4.4 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 16)) (4.8.3) Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 16)) (2.2.0) Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 16)) (1.1.5) Collecting dataclasses Downloading dataclasses-0.8-py3-none-any.whl (19 kB) Collecting pybtex-docutils>=1.0.0 Downloading pybtex_docutils-1.0.2-py3-none-any.whl (6.3 kB) Collecting pybtex>=0.24 Downloading pybtex-0.24.0-py2.py3-none-any.whl (561 kB) Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from jinja2<3.1.0->-r requirements.txt (line 5)) (2.0.1) Collecting mdit-py-plugins~=0.3.0 Downloading mdit_py_plugins-0.3.0-py3-none-any.whl (43 kB) Collecting pyyaml Downloading PyYAML-6.0-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (603 kB) Collecting markdown-it-py<3.0.0,>=1.0.0 Downloading markdown_it_py-2.0.1-py3-none-any.whl (84 kB) Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from babel>=1.3->Sphinx==4.5.0->-r requirements.txt (line 16)) (2022.6) Requirement already satisfied: typing-extensions>=3.6.4 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from importlib-metadata>=4.4->Sphinx==4.5.0->-r requirements.txt (line 16)) (4.1.1) Requirement already satisfied: zipp>=0.5 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from importlib-metadata>=4.4->Sphinx==4.5.0->-r requirements.txt (line 16)) (3.6.0) Collecting attrs<22,>=19 Downloading attrs-21.4.0-py2.py3-none-any.whl (60 kB) Collecting mdurl~=0.1 Downloading mdurl-0.1.0-py3-none-any.whl (11 kB) Collecting latexcodec>=1.0.4 Downloading latexcodec-2.0.1-py2.py3-none-any.whl (18 kB) Collecting six Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from requests->sphinx_lfs_content==1.1.0->-r requirements.txt (line 10)) (2022.9.24) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from requests->sphinx_lfs_content==1.1.0->-r requirements.txt (line 10)) (3.4) Requirement already satisfied: urllib3<1.27,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from requests->sphinx_lfs_content==1.1.0->-r requirements.txt (line 10)) (1.26.13) Requirement already satisfied: charset-normalizer~=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from requests->sphinx_lfs_content==1.1.0->-r requirements.txt (line 10)) (2.0.12) Requirement already satisfied: pyparsing!=3.0.5,>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/1.0.0/lib/python3.6/site-packages (from packaging->Sphinx==4.5.0->-r requirements.txt (line 16)) (3.0.9) Building wheels for collected packages: m2r, sphinx-lfs-content Building wheel for m2r (setup.py): started Building wheel for m2r (setup.py): finished with status 'done' Created wheel for m2r: filename=m2r-0.2.1-py3-none-any.whl size=10477 sha256=01a4fd8b408c7fc4ec5c9e1dc7b0ccfc9862a7e709ed28cc74a77dad07e4b1ba Stored in directory: /tmp/pip-ephem-wheel-cache-10d_nmo3/wheels/19/5d/39/418a1e8bfe6c4259fa80fb882a2e4c28d940eebbc44ebd1c63 Building wheel for sphinx-lfs-content (setup.py): started Building wheel for sphinx-lfs-content (setup.py): finished with status 'done' Created wheel for sphinx-lfs-content: filename=sphinx_lfs_content-1.1.0-py3-none-any.whl size=4082 sha256=18fe266b3c4c3a110bcb5c6fe7d10957527f70e6c6f7d15d757f6c2efa2c33c4 Stored in directory: /tmp/pip-ephem-wheel-cache-10d_nmo3/wheels/de/02/58/1e90cc0f3fb6798d5c6cc02883b6b2edf62a0795aa1f9800b2 Successfully built m2r sphinx-lfs-content Installing collected packages: six, pyyaml, mdurl, latexcodec, attrs, pybtex, markdown-it-py, Sphinx, soupsieve, pybtex-docutils, mistune, mdit-py-plugins, dataclasses, sphinxcontrib-bibtex, sphinx-tabs, sphinx-rtd-theme, sphinx-notfound-page, sphinx-lfs-content, sphinx-copybutton, sphinx-argparse, regex, myst-parser, m2r, cloud-sptheme, breathe, beautifulsoup4 Attempting uninstall: Sphinx Found existing installation: sphinx 5.3.0 Uninstalling sphinx-5.3.0: Successfully uninstalled sphinx-5.3.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 Sphinx-4.5.0 attrs-21.4.0 beautifulsoup4-4.10.0 breathe-4.33.1 cloud-sptheme-1.10.1.post20200504175005 dataclasses-0.8 latexcodec-2.0.1 m2r-0.2.1 markdown-it-py-2.0.1 mdit-py-plugins-0.3.0 mdurl-0.1.0 mistune-0.8.4 myst-parser-0.16.1 pybtex-0.24.0 pybtex-docutils-1.0.2 pyyaml-6.0 regex-2022.3.15 six-1.16.0 soupsieve-2.3.2.post1 sphinx-argparse-0.3.1 sphinx-copybutton-0.5.0 sphinx-lfs-content-1.1.0 sphinx-notfound-page-0.8 sphinx-rtd-theme-1.0.0 sphinx-tabs-3.3.1 sphinxcontrib-bibtex-2.4.2 [rtd-command-info] start-time: 2022-11-27T13:46:30.225888Z, end-time: 2022-11-27T13:46:30.283128Z, duration: 0, exit-code: 0 cat conf.py # Configuration file for the Sphinx documentation builder. # Copyright (c) 2021 Graphcore Ltd. All rights reserved. # # -- 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 re import sys import glob import shutil import datetime from docutils import nodes from docutils.parsers.rst import roles sys.path.insert(0, os.path.abspath(".")) # -- Operations to perform when building on Read The Docs -------------------- if os.environ.get("READTHEDOCS", False): # Get version set by RTD from the environment version = os.environ.get("READTHEDOCS_VERSION", "") # This will be substituted by the script that publishes to RTD project = ( "IPU-POD128 datacentre checklist" # Need double quotes because title might include apostrophe ) # Install git-lfs, and then get any relevant files, for those documents that need it. # This is for TensorFlow, PopART and others that need various binary (wheel and library) files. # Based on: https://github.com/readthedocs/readthedocs.org/issues/1846#issuecomment-477184259 # Someone packaged the process up as a Sphinx extension: https://github.com/ssciwr/sphinx_lfs_content # I tried that but couldn't get it to work reliably. Possibly a race condition between git-lfs # files being installed and the next commands executed? I didn't have the time to look into it. if not os.path.exists("./git-lfs"): os.system( "wget https://github.com/git-lfs/git-lfs/releases/download/v2.11.0/git-lfs-linux-amd64-v2.11.0.tar.gz" ) os.system("tar xvfz git-lfs-linux-amd64-v2.11.0.tar.gz") os.system("./git-lfs install") # make lfs available in current repository if os.system("./git-lfs fetch"): # download content from remote exit(1) # exit early if git-lfs not working (e.g. authentication problems) os.system("./git-lfs checkout") # make local files to have the real content on them # If there is a TensorFlow wheel file, install it wheel = glob.glob("tensorflow*.whl") if len(wheel) > 0: print(f"TensorFlow wheel: {wheel[0]}") if os.system(f"pip install {wheel[0]}"): exit(1) # If there is a PopTorch wheel file, install it wheel = glob.glob("poptorch*.whl") if len(wheel) > 0: print(f"PopTorch wheel: {wheel[0]}") if os.system(f"pip install {wheel[0]}"): exit(1) # If the document uses doxygen, run it now if os.path.isfile("Doxyfile"): if os.system("doxygen"): # Quit if doxygen processing failed exit(1) # Copy the generated html to a directory where it will be # uploaded to Read the Docs so we can link to it in future. src = "doxygen/html" if os.path.exists(src): dst = os.path.join("_html/doxygen") if os.path.exists(dst): shutil.rmtree(dst) # os.makedirs(dst, exist_ok=True) shutil.copytree(src, dst) # , dirs_exist_ok=True) else: # Defined in the local build script version = os.environ.get("VERSION", "0.0.0") project = os.environ.get("DOC_TITLE", "Title") # -- Local extensions -------------------------------------------------------- # PDF display role. In the .rst file, use it as follows: # :pdf:`Document Title ` # Then put the pdf file in the directory `pdf` # This generates a link to the pdf, which will be displayed in the browser def pdf_role(name, rawtext, text, lineno, inliner, options={}, content=[]): title = text link = text m = re.search(r"([^<]+)<([^>]+)>", text) if m: title = m.group(1).strip() link = "_static/" + m.group(2) node = nodes.reference(rawtext, title, refuri=link, **options) return [node, nodes.inline("", " (pdf)")], [] # Arxiv link role. In the .rst file, use it as follows: # :arxiv:`1810.04805` # :arxiv:`Devlin et al. 2019 <1810.04805>` # This generates a link to the abstract on Arxiv # TODO: error checking of the Arxiv reference # TODO: option to fetch the doc title? def arxiv_role(name, rawtext, text, lineno, inliner, options={}, content=[]): title = text link = text m = re.search(r"([^<]+)<([^>]+)>", text) if m: title = m.group(1).strip() link = "https://arxiv.org/abs/" + m.group(2) else: title = "arXiv: " + text link = "https://arxiv.org/abs/" + text node = nodes.reference(rawtext, title, refuri=link, **options) return [node], [] # Mark the text with the class "strike" defined in the stylesheet as strikethorugh text def strikethrough(_role, rawtext, text, _lineno, _inliner, options={}, _content=[]): roles.set_classes(options) options.setdefault('classes', []).append("strike") return [nodes.inline(rawtext, text, **options)], [] def setup(app): app.add_role("pdf", pdf_role) app.add_role("arxiv", arxiv_role) app.add_role("strike", strikethrough) # -- Other project information ----------------------------------------------------- author = "Graphcore Ltd" release = version version_date = f"{version} ({datetime.date.today().isoformat()})" # -- General configuration --------------------------------------------------- suppress_warnings = [ "autosectionlabel.*", ] master_doc = "index" autodoc_typehints = "description" # 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.graphviz", "sphinx.ext.ifconfig", "sphinx.ext.napoleon", "breathe", "sphinx.ext.intersphinx", "sphinx.ext.autosectionlabel", "sphinx_copybutton", "cloud_sptheme.ext.table_styling", ] if os.environ.get("READTHEDOCS", False): extensions.append("notfound.extension") bibtex_bibfiles = ["refs.bib"] if os.path.isfile(bibtex_bibfiles[0]): extensions.append("sphinxcontrib.bibtex") copybutton_prompt_text = r">>> |\$ " copybutton_prompt_is_regexp = True copybutton_only_copy_prompt_lines = True copybutton_line_continuation_character = "\\" # Intersphinx mapping: keep this in alphabetical order for ease of updating intersphinx_mapping = { # Third party documents "numpy": ("https://numpy.org/doc/stable/", None), "python": ("https://docs.python.org/3", None), "pytorch": ("https://pytorch.org/docs/stable/", None), "pytorch-cpp": ("https://pytorch.org/cppdocs/", None), # Graphcore docs: with the exception of tensorflow1 and tensorflow2, these # are the same as the relevant part of the URL for the document. # (I shortened the TensorFlow ones for ... well, you know, brevity.) "ai-float-white-paper": ("https://docs.graphcore.ai/projects/ai-float-white-paper/en/latest/", None), "approved-server-list": ("https://docs.graphcore.ai/projects/graphcore-approved-server-list/en/latest/", None), "assembly-programming": ("https://docs.graphcore.ai/projects/assembly-programming/en/latest/", None), "available-memory": ("https://docs.graphcore.ai/projects/available-memory/en/latest/", None), "bert-training": ("https://docs.graphcore.ai/projects/bert-training/en/latest/", None), "bmc-user-guide": ("https://docs.graphcore.ai/projects/bmc-user-guide/en/latest/", None), "cla": ("https://docs.graphcore.ai/projects/cla/en/latest/", None), "command-line-tools": ("https://docs.graphcore.ai/projects/command-line-tools/en/latest/", None), "custom-ops": ("https://docs.graphcore.ai/projects/custom-ops/en/latest/", None), "eula": ("https://docs.graphcore.ai/projects/eula/en/latest/", None), "glossary": ("https://docs.graphcore.ai/projects/graphcore-glossary/en/latest/", None), "graphcloud-getting-started": ("https://docs.graphcore.ai/projects/graphcloud-getting-started/en/latest/", None), "ipu-m2000-datasheet": ("https://docs.graphcore.ai/projects/graphcore-ipu-m2000-datasheet/en/latest/", None), "ipu-overview": ("https://docs.graphcore.ai/projects/ipu-overview/en/latest/", None), "ipu-pod-da-getting-started": ("https://docs.graphcore.ai/projects/ipu-pod-da-getting-started/en/latest/", None), "ipu-pod-getting-started": ("https://docs.graphcore.ai/projects/ipu-pod-getting-started/en/latest/", None), "ipu-pod16-datasheet": ("https://docs.graphcore.ai/projects/ipu-pod16-datasheet/en/latest/", None), "ipu-pod64-build-test": ("https://docs.graphcore.ai/projects/ipu-pod64-build-test/en/latest/", None), "ipu-pod64-datacentre-checklist": ("https://docs.graphcore.ai/projects/ipu-pod64-datacentre-checklist/en/latest/", None), "ipu-pod64-datasheet": ("https://docs.graphcore.ai/projects/ipu-pod64-datasheet/en/latest/", None), "ipu-pod64-integration": ("https://docs.graphcore.ai/projects/ipu-pod64-integration/en/latest/", None), "ipu-pod128-build-test": ("https://docs.graphcore.ai/projects/ipu-pod128-build-test/en/latest/", None), "ipu-pod128-datacentre-checklist": ("https://docs.graphcore.ai/projects/ipu-pod128-datacentre-checklist/en/latest/", None), "ipu-pod128-datasheet": ("https://docs.graphcore.ai/projects/ipu-pod128-datasheet/en/latest/", None), "ipu-pod128-integration": ("https://docs.graphcore.ai/projects/ipu-pod128-integration/en/latest/", None), "ipu-podda-build-test": ("https://docs.graphcore.ai/projects/ipu-podda-build-test/en/latest/", None), #"isa": ("https://docs.graphcore.ai/projects/isa/en/latest/", None), "popart-cpp-api": ("https://docs.graphcore.ai/projects/popart-cpp-api/en/latest/", None), "popart-python-api": ("https://docs.graphcore.ai/projects/popart-python-api/en/latest/", None), "popart-user-guide": ("https://docs.graphcore.ai/projects/popart-user-guide/en/latest/", None), "poplar-api": ("https://docs.graphcore.ai/projects/poplar-api/en/latest/", None), "poplar-docker": ("https://docs.graphcore.ai/projects/poplar-docker/en/latest/", None), "poplar-user-guide": ("https://docs.graphcore.ai/projects/poplar-user-guide/en/latest/", None), "poprun-user-guide": ("https://docs.graphcore.ai/projects/poprun-user-guide/en/latest/", None), "poptorch-user-guide": ("https://docs.graphcore.ai/projects/poptorch-user-guide/en/latest/", None), "popvision-user-guide": ("https://docs.graphcore.ai/projects/graphcore-popvision-user-guide/en/latest/", None), "porting-tf-models": ("https://docs.graphcore.ai/projects/porting-tf-models/en/latest/", None), "profile-data": ("https://docs.graphcore.ai/projects/profile-data/en/latest/", None), "libpva": ("https://docs.graphcore.ai/projects/libpva/en/latest/", None), "libpvti": ("https://docs.graphcore.ai/projects/libpvti/en/latest/", None), "rack-tool": ("https://docs.graphcore.ai/projects/rack-tool/en/latest/", None), "release-notes": ("https://docs.graphcore.ai/projects/release-notes/en/latest/", None), "sdk-overview": ("https://docs.graphcore.ai/projects/sdk-overview/en/latest/", None), "tensorflow1": ("https://docs.graphcore.ai/projects/tensorflow1-user-guide/en/latest/", None), "tensorflow2": ("https://docs.graphcore.ai/projects/tensorflow-user-guide/en/latest/", None), "tf-model-parallelism": ("https://docs.graphcore.ai/projects/tf-model-parallelism/en/latest/", None), "tf-recompilation": ("https://docs.graphcore.ai/projects/tf-recompilation/en/latest/", None), "vipu-admin": ("https://docs.graphcore.ai/projects/vipu-admin/en/latest/", None), "vipu-user": ("https://docs.graphcore.ai/projects/vipu-user/en/latest/", None), } # Content for the 404 notfound extension on Read The Docs notfound_context = { "title": "Page not found", "body": """

Page not found

Sorry, we could find the page you were looking for.

Try returning to the documentation home page and searching from there.

""", } # Use the root project for resources and links (see T45222) notfound_urls_prefix = "/en/latest/" napoleon_google_docstring = True breathe_projects = { "project": "doxygen/xml", } breathe_default_project = "project" breathe_show_enumvalue_initializer = True breathe_default_members = ("members", "undoc-members") cpp_index_common_prefix = [ "poplar::core::", "poplar::detail::", "poplar::layout::", "poplar::traits::", "poplar::program::", "poplin::fc::", "poplin::matmul::", "poplin::multiconv::", "popnn::bn::", "popnn::gn::", "popnn::gru::", "popnn::in::", "popnn::ln::", "popnn::lstm::", "popnn::matmul::", "popnn::pooling::", "popnn::rnn::", "popops::architecture::", "popops::embedding::", "popops::expr::", "popops::rearrange::", "popsparse::dynamic::", "popsparse::experimental::", "poputil::graphfn::", "poplar::", "poplin::", "popnn::", "popops::", "poprand::", "popsparse::", "poputil::", "poplibs::", "popart::", "popdist::", "gcl::", "pva::preview::", "pva::", "pvti::", ] modindex_common_prefix = [ "tensorflow.python.ipu", "tensorflow.python.", "tensorflow.", "popart.", "poptorch.", "popdist.", "pva.", ] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. exclude_patterns = [] default_role = "code" # Internationalization gettext_uuid = True gettext_compact = False locale_dirs = ['locales'] # Define abbreviations for IPU-PODn names with subscripts # These use non-breaking hyphens & spaces, so be careful if editing or adding new definitions pod_sizes = [2 ** i for i in range(2, 14)] + ["N"] pod_definitions = [ f".. |POD{i}| replace:: IPU‑POD\\ :subscript:`{i}`" for i in pod_sizes ] rst_epilog = ( "\n".join(pod_definitions) + r""" .. |newpage| raw:: latex \newpage .. |POD| replace:: IPU‑POD """ ) # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = "sphinx_rtd_theme" html_theme_options = { "logo_only": False, "navigation_depth": 5, "collapse_navigation": False, } html_favicon = "_static/favicon.png" # Enable numbered figures and cross references numfig = True numfig_format = { "section": "Section {number}, {name}", "figure": "Fig. %s", "table": "Table %s", "code-block": "Listing %s", } # Path to custom robots.txt etc if os.path.isdir("_html"): html_extra_path = ["_html"] # 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 os.path.isdir("pdf"): html_static_path.append("pdf") # CSS file to create the Graphcore style plus optional css local to each document html_css_files = ["css/custom_rtd.css"] if os.path.isfile("_static/css/local.css"): html_css_files.append("css/local.css") html_js_files = [ "js/graphcore.js", ] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". html_title = project # The name of an image file (relative to this directory) to place at the top # of the sidebar. html_logo = "_static/graphcorelogo-html.png" # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. html_use_smartypants = True # If true, links to the reST sources are added to the pages. html_show_sourcelink = False # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. html_show_sphinx = False # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. html_show_copyright = False # -- Options for LaTeX output --------------------------------------------- # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_class = "manual" latex_documents = [ ("index", "doc.tex", os.environ.get("DOC_TITLE"), author, latex_class), ] # The name of an image file (relative to this directory) to place at the top of # the title page. latex_logo = "_static/graphcorelogo.pdf" latex_additional_files = [ "_static/graphcoresymbol.pdf", ] latex_show_pagerefs = False latex_show_urls = "no" latex_elements = { # Reduce code block font size as we have some very long lines "fvset": r"\fvset{fontsize=\footnotesize}", # Options to pass to packages "passoptionstopackages": r"\PassOptionsToPackage{dvipsnames, table, xcdraw}{xcolor}", # Set up margins for geometry "sphinxsetup": """ hmargin={19mm, 19mm}, vmargin={26mm, 26mm}, warningBorderColor={HTML}{FF6F79}, noteBorderColor={HTML}{D9D9D9}, VerbatimBorderColor={HTML}{D9D9D9}, TitleColor={HTML}{292C31}, """, # The paper size ('letterpaper' or 'a4paper'). "papersize": "a4paper", # Save paper and screen space "extraclassoptions": "openany,oneside", # Keep figures where they are placed "figure_align": "H", "releasename": "Version", # The font size ('10pt', '11pt' or '12pt'). "pointsize": "10pt", # API docs have a problem with the default depth "maxlistdepth": "20", # Make text in index smaller to account for the unreasonably long entries "printindex": r"\footnotesize\raggedright\printindex", # Additional stuff for the LaTeX preamble. "preamble": r""" %% Set maximum depth of numbered headings \setcounter{tocdepth}{2} \setcounter{secnumdepth}{2} %% Experimental: Optionally add list of figures, list of tables, etc to TOC \usepackage{etoolbox} \providebool{include-toc} \booltrue{include-toc} \providebool{include-lot} \providebool{include-lof} \makeatletter \renewcommand{\sphinxtableofcontents}{% % % before resetting page counter, let's do the right thing. \if@openright\cleardoublepage\else\clearpage\fi \pagenumbering{roman}% \ifbool{include-toc} { \begingroup \parskip \z@skip \tableofcontents \endgroup }{} % %% Additional lists \ifbool{include-lof} { \if@openright\cleardoublepage\else\clearpage\fi \addcontentsline{toc}{chapter}{List of Figures}% \listoffigures }{} % \ifbool{include-lot} { \if@openright\cleardoublepage\else\clearpage\fi \addcontentsline{toc}{chapter}{List of tables}% \listoftables }{} % \if@openright\cleardoublepage\else\clearpage\fi \pagenumbering{arabic}% } \makeatother %% Table captions and headers \makeatletter \definecolor{gcgrey}{HTML}{FAF8F9} \usepackage[font=bf]{caption} \protected\def\sphinxstyletheadfamily{\cellcolor{gcgrey} \py@HeaderFamily \py@TitleColor} \renewcommand{\arraystretch}{1.5} %% Set fonts \renewcommand{\familydefault}{\sfdefault} \usepackage{charter} \usepackage[defaultsans]{lato} \usepackage{inconsolata} %% One-column index to cope with long, fully resolved names \renewenvironment{theindex}{ \chapter*{\indexname} \markboth{\MakeUppercase\indexname}{\MakeUppercase\indexname} \setlength{\parskip}{0.1em} \relax \let\item\@idxitem }{} \makeatother %% Set up page headers and footers \usepackage{fancyhdr} \pagestyle{fancy} \setlength\headheight{32pt} \fancypagestyle{normal}{ \fancyhf{} \fancyhead[L]{\includegraphics[width=10mm]{graphcoresymbol}} \fancyhead[R]{\large """ + project + r""" \\ } \fancyfoot[L]{Version: """ + version_date + r"""} \fancyfoot[R]{\thepage} \renewcommand{\headrulewidth}{0.5pt} \renewcommand{\footrulewidth}{0.5pt} } \fancypagestyle{plain}{% \fancyhf{} \fancyfoot[L]{Version: """ + version_date + r"""} \fancyfoot[R]{\thepage} \renewcommand{\headrulewidth}{0pt} \renewcommand{\footrulewidth}{0.5pt} } """, } ########################################################################### # 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': "1.0.0", 'version_slug': "1.0.0", '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/"), ("1.0.0", "/en/1.0.0/"), ], 'downloads': [ ("html", "//docs.graphcore.ai/_/downloads/ipu-pod128-datacentre-checklist/en/1.0.0/htmlzip/"), ], 'subprojects': [ ], 'slug': 'graphcore-ipu-pod128-data-centre-checklist', 'name': u'IPU-POD128 Data Centre Checklist', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': 'https://docs.graphcore.ai/projects/ipu-pod128-datacentre-checklist/en/latest/', 'analytics_code': 'UA-82396948-1', 'single_version': False, 'conf_py_path': '/', 'api_host': 'https://readthedocs.com', 'github_user': 'gc-docs', 'proxied_api_host': '/_', 'github_repo': 'ipu-pod128-datacentre-checklist', 'github_version': '1.0.0', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': '1.0.0', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': '1.0.0', '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-82396948-1', 'global_analytics_code': 'UA-17997319-2', 'commit': 'dea38765', } # 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/graphcore-ipu-pod128-data-centre-checklist/builds/1197257/' 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-11-27T13:46:30.465055Z, end-time: 2022-11-27T13:47:32.893152Z, duration: 62, exit-code: 0 python -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html Running Sphinx v4.5.0 --2022-11-27 13:46:30-- https://github.com/git-lfs/git-lfs/releases/download/v2.11.0/git-lfs-linux-amd64-v2.11.0.tar.gz Resolving github.com (github.com)... 192.30.255.112 Connecting to github.com (github.com)|192.30.255.112|:443... connected. HTTP request sent, awaiting response... 302 Found Location: https://objects.githubusercontent.com/github-production-release-asset-2e65be/13021798/fa85ce00-9147-11ea-9ec4-c204e7a4e6cd?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIWNJYAX4CSVEH53A%2F20221127%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20221127T134630Z&X-Amz-Expires=300&X-Amz-Signature=71c5e1ecd79ba7140727e94e20630683f8fd73451af623a06830b209a25628ee&X-Amz-SignedHeaders=host&actor_id=0&key_id=0&repo_id=13021798&response-content-disposition=attachment%3B%20filename%3Dgit-lfs-linux-amd64-v2.11.0.tar.gz&response-content-type=application%2Foctet-stream [following] --2022-11-27 13:46:31-- https://objects.githubusercontent.com/github-production-release-asset-2e65be/13021798/fa85ce00-9147-11ea-9ec4-c204e7a4e6cd?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIWNJYAX4CSVEH53A%2F20221127%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20221127T134630Z&X-Amz-Expires=300&X-Amz-Signature=71c5e1ecd79ba7140727e94e20630683f8fd73451af623a06830b209a25628ee&X-Amz-SignedHeaders=host&actor_id=0&key_id=0&repo_id=13021798&response-content-disposition=attachment%3B%20filename%3Dgit-lfs-linux-amd64-v2.11.0.tar.gz&response-content-type=application%2Foctet-stream Resolving objects.githubusercontent.com (objects.githubusercontent.com)... 185.199.109.133, 185.199.108.133, 185.199.111.133, ... Connecting to objects.githubusercontent.com (objects.githubusercontent.com)|185.199.109.133|:443... connected. HTTP request sent, awaiting response... 200 OK Length: 4666614 (4.5M) [application/octet-stream] Saving to: ‘git-lfs-linux-amd64-v2.11.0.tar.gz’ 0K .......... .......... .......... .......... .......... 1% 5.45M 1s 50K .......... .......... .......... .......... .......... 2% 6.85M 1s 100K .......... .......... .......... .......... .......... 3% 23.1M 1s 150K .......... .......... .......... .......... .......... 4% 26.8M 0s 200K .......... .......... .......... .......... .......... 5% 11.6M 0s 250K .......... .......... .......... .......... .......... 6% 41.6M 0s 300K .......... .......... .......... .......... .......... 7% 23.7M 0s 350K .......... .......... .......... .......... .......... 8% 63.8M 0s 400K .......... .......... .......... .......... .......... 9% 59.4M 0s 450K .......... .......... .......... .......... .......... 10% 198M 0s 500K .......... .......... .......... .......... .......... 12% 15.7M 0s 550K .......... .......... .......... .......... .......... 13% 35.1M 0s 600K .......... .......... .......... .......... .......... 14% 29.3M 0s 650K .......... .......... .......... .......... .......... 15% 197M 0s 700K .......... .......... .......... .......... .......... 16% 201M 0s 750K .......... .......... .......... .......... .......... 17% 76.8M 0s 800K .......... .......... .......... .......... .......... 18% 115M 0s 850K .......... .......... .......... .......... .......... 19% 97.2M 0s 900K .......... .......... .......... .......... .......... 20% 117M 0s 950K .......... .......... .......... .......... .......... 21% 139M 0s 1000K .......... .......... .......... .......... .......... 23% 25.1M 0s 1050K .......... .......... .......... .......... .......... 24% 152M 0s 1100K .......... .......... .......... .......... .......... 25% 37.9M 0s 1150K .......... .......... .......... .......... .......... 26% 182M 0s 1200K .......... .......... .......... .......... .......... 27% 170M 0s 1250K .......... .......... .......... .......... .......... 28% 40.7M 0s 1300K .......... .......... .......... .......... .......... 29% 170M 0s 1350K .......... .......... .......... .......... .......... 30% 191M 0s 1400K .......... .......... .......... .......... .......... 31% 191M 0s 1450K .......... .......... .......... .......... .......... 32% 179M 0s 1500K .......... .......... .......... .......... .......... 34% 80.5M 0s 1550K .......... .......... .......... .......... .......... 35% 175M 0s 1600K .......... .......... .......... .......... .......... 36% 171M 0s 1650K .......... .......... .......... .......... .......... 37% 200M 0s 1700K .......... .......... .......... .......... .......... 38% 158M 0s 1750K .......... .......... .......... .......... .......... 39% 180M 0s 1800K .......... .......... .......... .......... .......... 40% 178M 0s 1850K .......... .......... .......... .......... .......... 41% 198M 0s 1900K .......... .......... .......... .......... .......... 42% 204M 0s 1950K .......... .......... .......... .......... .......... 43% 177M 0s 2000K .......... .......... .......... .......... .......... 44% 40.1M 0s 2050K .......... .......... .......... .......... .......... 46% 83.4M 0s 2100K .......... .......... .......... .......... .......... 47% 149M 0s 2150K .......... .......... .......... .......... .......... 48% 144M 0s 2200K .......... .......... .......... .......... .......... 49% 206M 0s 2250K .......... .......... .......... .......... .......... 50% 242M 0s 2300K .......... .......... .......... .......... .......... 51% 305M 0s 2350K .......... .......... .......... .......... .......... 52% 282M 0s 2400K .......... .......... .......... .......... .......... 53% 309M 0s 2450K .......... .......... .......... .......... .......... 54% 317M 0s 2500K .......... .......... .......... .......... .......... 55% 105M 0s 2550K .......... .......... .......... .......... .......... 57% 46.8M 0s 2600K .......... .......... .......... .......... .......... 58% 77.2M 0s 2650K .......... .......... .......... .......... .......... 59% 209M 0s 2700K .......... .......... .......... .......... .......... 60% 102M 0s 2750K .......... .......... .......... .......... .......... 61% 63.9M 0s 2800K .......... .......... .......... .......... .......... 62% 212M 0s 2850K .......... .......... .......... .......... .......... 63% 215M 0s 2900K .......... .......... .......... .......... .......... 64% 210M 0s 2950K .......... .......... .......... .......... .......... 65% 195M 0s 3000K .......... .......... .......... .......... .......... 66% 215M 0s 3050K .......... .......... .......... .......... .......... 68% 142M 0s 3100K .......... .......... .......... .......... .......... 69% 82.1M 0s 3150K .......... .......... .......... .......... .......... 70% 171M 0s 3200K .......... .......... .......... .......... .......... 71% 213M 0s 3250K .......... .......... .......... .......... .......... 72% 215M 0s 3300K .......... .......... .......... .......... .......... 73% 87.2M 0s 3350K .......... .......... .......... .......... .......... 74% 92.6M 0s 3400K .......... .......... .......... .......... .......... 75% 209M 0s 3450K .......... .......... .......... .......... .......... 76% 211M 0s 3500K .......... .......... .......... .......... .......... 77% 97.9M 0s 3550K .......... .......... .......... .......... .......... 78% 74.7M 0s 3600K .......... .......... .......... .......... .......... 80% 90.7M 0s 3650K .......... .......... .......... .......... .......... 81% 174M 0s 3700K .......... .......... .......... .......... .......... 82% 133M 0s 3750K .......... .......... .......... .......... .......... 83% 169M 0s 3800K .......... .......... .......... .......... .......... 84% 154M 0s 3850K .......... .......... .......... .......... .......... 85% 156M 0s 3900K .......... .......... .......... .......... .......... 86% 127M 0s 3950K .......... .......... .......... .......... .......... 87% 151M 0s 4000K .......... .......... .......... .......... .......... 88% 151M 0s 4050K .......... .......... .......... .......... .......... 89% 146M 0s 4100K .......... .......... .......... .......... .......... 91% 143M 0s 4150K .......... .......... .......... .......... .......... 92% 116M 0s 4200K .......... .......... .......... .......... .......... 93% 130M 0s 4250K .......... .......... .......... .......... .......... 94% 146M 0s 4300K .......... .......... .......... .......... .......... 95% 148M 0s 4350K .......... .......... .......... .......... .......... 96% 126M 0s 4400K .......... .......... .......... .......... .......... 97% 124M 0s 4450K .......... .......... .......... .......... .......... 98% 148M 0s 4500K .......... .......... .......... .......... .......... 99% 144M 0s 4550K ....... 100% 139M=0.07s 2022-11-27 13:46:31 (66.2 MB/s) - ‘git-lfs-linux-amd64-v2.11.0.tar.gz’ saved [4666614/4666614] README.md CHANGELOG.md git-lfs install.sh Updated git hooks. Git LFS initialized. fetch: Fetching reference HEAD loading translations [en]... done making output directory... done loading intersphinx inventory from https://numpy.org/doc/stable/objects.inv... loading intersphinx inventory from https://docs.python.org/3/objects.inv... loading intersphinx inventory from https://pytorch.org/docs/stable/objects.inv... loading intersphinx inventory from https://pytorch.org/cppdocs/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ai-float-white-paper/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcore-approved-server-list/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/assembly-programming/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/available-memory/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/bert-training/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/bmc-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/cla/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/command-line-tools/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/custom-ops/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/eula/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcore-glossary/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcloud-getting-started/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcore-ipu-m2000-datasheet/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-overview/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod-da-getting-started/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod-getting-started/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod16-datasheet/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod64-build-test/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod64-datacentre-checklist/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod64-datasheet/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod64-integration/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod128-build-test/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod128-datacentre-checklist/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod128-datasheet/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod128-integration/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-podda-build-test/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/popart-cpp-api/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/popart-python-api/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/popart-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/poplar-api/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/poplar-docker/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/poplar-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/poprun-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/poptorch-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcore-popvision-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/porting-tf-models/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/profile-data/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/libpva/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/libpvti/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/rack-tool/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/release-notes/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/sdk-overview/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/tensorflow1-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/tensorflow-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/tf-model-parallelism/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/tf-recompilation/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/vipu-admin/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/vipu-user/en/latest/objects.inv... WARNING: failed to reach any of the inventories with the following issues: intersphinx inventory 'https://docs.graphcore.ai/projects/ipu-overview/en/latest/objects.inv' not fetchable due to : 504 Server Error: Gateway Time-out for url: https://docs.graphcore.ai/projects/ipu-overview/en/latest/objects.inv building [mo]: targets for 0 po files that are out of date building [html]: targets for 2 source files that are out of date updating environment: [new config] 2 added, 0 changed, 0 removed reading sources... [ 50%] index reading sources... [100%] legal looking for now-outdated files... none found pickling environment... done checking consistency... /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/checkouts/1.0.0/legal.rst: WARNING: document isn't included in any toctree done preparing documents... done writing output... [ 50%] index writing output... [100%] legal generating indices... genindex done writing additional pages... search done copying static files... done copying extra files... done dumping search index in English (code: en)... done dumping object inventory... done build succeeded, 2 warnings. The HTML pages are in _build/html. Updating searchtools for Read the Docs search... [rtd-command-info] start-time: 2022-11-27T13:47:33.165490Z, end-time: 2022-11-27T13:47:36.706103Z, duration: 3, exit-code: 0 python -m sphinx -T -E -b readthedocssinglehtmllocalmedia -d _build/doctrees -D language=en . _build/localmedia Running Sphinx v4.5.0 Updated git hooks. Git LFS initialized. fetch: Fetching reference HEAD loading translations [en]... done making output directory... done loading intersphinx inventory from https://numpy.org/doc/stable/objects.inv... loading intersphinx inventory from https://docs.python.org/3/objects.inv... loading intersphinx inventory from https://pytorch.org/docs/stable/objects.inv... loading intersphinx inventory from https://pytorch.org/cppdocs/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ai-float-white-paper/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcore-approved-server-list/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/assembly-programming/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/available-memory/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/bert-training/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/bmc-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/cla/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/command-line-tools/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/custom-ops/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/eula/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcore-glossary/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcloud-getting-started/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcore-ipu-m2000-datasheet/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-overview/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod-da-getting-started/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod-getting-started/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod16-datasheet/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod64-build-test/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod64-datacentre-checklist/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod64-datasheet/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod64-integration/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod128-build-test/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod128-datacentre-checklist/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod128-datasheet/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod128-integration/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-podda-build-test/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/popart-cpp-api/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/popart-python-api/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/popart-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/poplar-api/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/poplar-docker/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/poplar-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/poprun-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/poptorch-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcore-popvision-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/porting-tf-models/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/profile-data/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/libpva/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/libpvti/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/rack-tool/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/release-notes/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/sdk-overview/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/tensorflow1-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/tensorflow-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/tf-model-parallelism/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/tf-recompilation/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/vipu-admin/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/vipu-user/en/latest/objects.inv... building [mo]: targets for 0 po files that are out of date building [readthedocssinglehtmllocalmedia]: all documents updating environment: [new config] 2 added, 0 changed, 0 removed reading sources... [ 50%] index reading sources... [100%] legal looking for now-outdated files... none found pickling environment... done checking consistency... /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/checkouts/1.0.0/legal.rst: WARNING: document isn't included in any toctree done preparing documents... done assembling single document... done writing... done writing additional files... done copying static files... done copying extra files... done dumping object inventory... done build succeeded, 1 warning. The HTML page is in _build/localmedia. Updating searchtools for Read the Docs search...