Read the Docs build information Build id: 1473627 Project: canonical-checkbox Version: stable Commit: 67e872915bc2934d2938817064be9600355b3091 Date: 2023-05-15T15:45:57.412901Z State: finished Success: True [rtd-command-info] start-time: 2023-05-15T15:45:59.303675Z, end-time: 2023-05-15T15:46:02.532756Z, duration: 3, exit-code: 0 git clone --no-single-branch --depth 50 https://github.com/canonical/checkbox.git . Cloning into '.'... [rtd-command-info] start-time: 2023-05-15T15:46:02.774133Z, end-time: 2023-05-15T15:46:03.091435Z, duration: 0, exit-code: 0 git checkout --force 67e872915bc2934d2938817064be9600355b3091 Note: switching to '67e872915bc2934d2938817064be9600355b3091'. 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 67e87291 Bump version: 2.5 → 2.6 (#454) [rtd-command-info] start-time: 2023-05-15T15:46:03.281592Z, end-time: 2023-05-15T15:46:03.344490Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2023-05-15T15:46:08.534424Z, end-time: 2023-05-15T15:46:08.604474Z, duration: 0, exit-code: 0 asdf global python 3.9.15 [rtd-command-info] start-time: 2023-05-15T15:46:09.156642Z, end-time: 2023-05-15T15:46:10.200673Z, duration: 1, exit-code: 0 python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH created virtual environment CPython3.9.15.final.0-64 in 705ms creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/canonical-checkbox/envs/stable, clear=False, no_vcs_ignore=False, global=False) seeder FromAppData(download=False, pip=bundle, setuptools=bundle, wheel=bundle, via=copy, app_data_dir=/home/docs/.local/share/virtualenv) added seed packages: pip==21.2.3, setuptools==57.4.0, wheel==0.37.0 activators BashActivator,CShellActivator,FishActivator,PowerShellActivator,PythonActivator [rtd-command-info] start-time: 2023-05-15T15:46:10.425648Z, end-time: 2023-05-15T15:46:22.156161Z, duration: 11, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip setuptools Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/canonical-checkbox/envs/stable/lib/python3.9/site-packages (21.2.3) Collecting pip Downloading pip-23.1.2-py3-none-any.whl (2.1 MB) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/canonical-checkbox/envs/stable/lib/python3.9/site-packages (57.4.0) Collecting setuptools Downloading setuptools-67.7.2-py3-none-any.whl (1.1 MB) Installing collected packages: setuptools, pip Attempting uninstall: setuptools Found existing installation: setuptools 57.4.0 Uninstalling setuptools-57.4.0: Successfully uninstalled setuptools-57.4.0 Attempting uninstall: pip Found existing installation: pip 21.2.3 Uninstalling pip-21.2.3: Successfully uninstalled pip-21.2.3 Successfully installed pip-23.1.2 setuptools-67.7.2 [rtd-command-info] start-time: 2023-05-15T15:46:22.407095Z, end-time: 2023-05-15T15:46:33.748397Z, duration: 11, 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 sphinx-rtd-theme readthedocs-sphinx-ext<2.3 Collecting pillow Downloading Pillow-9.5.0-cp39-cp39-manylinux_2_28_x86_64.whl (3.4 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.4/3.4 MB 38.3 MB/s eta 0:00:00 Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 kB 157.2 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 110.0 MB/s eta 0:00:00 Collecting recommonmark==0.5.0 Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Collecting sphinx Downloading sphinx-7.0.1-py3-none-any.whl (3.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.0/3.0 MB 132.7 MB/s eta 0:00:00 Collecting sphinx-rtd-theme Downloading sphinx_rtd_theme-1.2.0-py2.py3-none-any.whl (2.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.8/2.8 MB 135.0 MB/s eta 0:00:00 Collecting readthedocs-sphinx-ext<2.3 Downloading readthedocs_sphinx_ext-2.2.0-py2.py3-none-any.whl (11 kB) Collecting docutils>=0.11 (from recommonmark==0.5.0) Downloading docutils-0.20-py3-none-any.whl (577 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 577.9/577.9 kB 154.5 MB/s eta 0:00:00 Collecting sphinxcontrib-applehelp (from sphinx) Downloading sphinxcontrib_applehelp-1.0.4-py3-none-any.whl (120 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 120.6/120.6 kB 145.5 MB/s eta 0:00:00 Collecting sphinxcontrib-devhelp (from sphinx) Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 84.7/84.7 kB 138.2 MB/s eta 0:00:00 Collecting sphinxcontrib-jsmath (from sphinx) Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Collecting sphinxcontrib-htmlhelp>=2.0.0 (from sphinx) Downloading sphinxcontrib_htmlhelp-2.0.1-py3-none-any.whl (99 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 99.8/99.8 kB 153.9 MB/s eta 0:00:00 Collecting sphinxcontrib-serializinghtml>=1.1.5 (from sphinx) Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 94.0/94.0 kB 233.5 MB/s eta 0:00:00 Collecting sphinxcontrib-qthelp (from sphinx) Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 90.6/90.6 kB 165.0 MB/s eta 0:00:00 Collecting Jinja2>=3.0 (from sphinx) Downloading Jinja2-3.1.2-py3-none-any.whl (133 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.1/133.1 kB 169.9 MB/s eta 0:00:00 Collecting Pygments>=2.13 (from sphinx) Downloading Pygments-2.15.1-py3-none-any.whl (1.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.1/1.1 MB 159.8 MB/s eta 0:00:00 Collecting snowballstemmer>=2.0 (from sphinx) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 141.2 MB/s eta 0:00:00 Collecting babel>=2.9 (from sphinx) Downloading Babel-2.12.1-py3-none-any.whl (10.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 10.1/10.1 MB 125.4 MB/s eta 0:00:00 Collecting imagesize>=1.3 (from sphinx) Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Collecting requests>=2.25.0 (from sphinx) Downloading requests-2.30.0-py3-none-any.whl (62 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.5/62.5 kB 121.8 MB/s eta 0:00:00 Collecting packaging>=21.0 (from sphinx) Downloading packaging-23.1-py3-none-any.whl (48 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 48.9/48.9 kB 125.9 MB/s eta 0:00:00 Collecting importlib-metadata>=4.8 (from sphinx) Downloading importlib_metadata-6.6.0-py3-none-any.whl (22 kB) Collecting sphinx Downloading sphinx-6.2.1-py3-none-any.whl (3.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.0/3.0 MB 143.3 MB/s eta 0:00:00 Collecting docutils>=0.11 (from recommonmark==0.5.0) Downloading docutils-0.18.1-py2.py3-none-any.whl (570 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 570.0/570.0 kB 171.7 MB/s eta 0:00:00 Collecting sphinxcontrib-jquery!=3.0.0,>=2.0.0 (from sphinx-rtd-theme) Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.1/121.1 kB 88.0 MB/s eta 0:00:00 Collecting zipp>=0.5 (from importlib-metadata>=4.8->sphinx) Downloading zipp-3.15.0-py3-none-any.whl (6.8 kB) Collecting MarkupSafe>=2.0 (from Jinja2>=3.0->sphinx) Downloading MarkupSafe-2.1.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB) Collecting charset-normalizer<4,>=2 (from requests>=2.25.0->sphinx) Downloading charset_normalizer-3.1.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (199 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 199.2/199.2 kB 131.3 MB/s eta 0:00:00 Collecting idna<4,>=2.5 (from requests>=2.25.0->sphinx) Downloading idna-3.4-py3-none-any.whl (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.5/61.5 kB 112.6 MB/s eta 0:00:00 Collecting urllib3<3,>=1.21.1 (from requests>=2.25.0->sphinx) Downloading urllib3-2.0.2-py3-none-any.whl (123 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 123.2/123.2 kB 144.7 MB/s eta 0:00:00 Collecting certifi>=2017.4.17 (from requests>=2.25.0->sphinx) Downloading certifi-2023.5.7-py3-none-any.whl (156 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 157.0/157.0 kB 162.1 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=23753 sha256=43ed8fec3d1f9351a64c09204e15bb953bb7ca7ce0ecaccdc9d928104ea85da1 Stored in directory: /tmp/pip-ephem-wheel-cache-9u36no2r/wheels/44/dc/c7/e89296d3612588db0aa6545ee3305c23b7a48b3a9922916e1f Successfully built mock Installing collected packages: snowballstemmer, mock, commonmark, zipp, urllib3, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, Pygments, pillow, packaging, MarkupSafe, imagesize, idna, docutils, charset-normalizer, certifi, babel, alabaster, requests, Jinja2, importlib-metadata, sphinx, readthedocs-sphinx-ext, sphinxcontrib-jquery, recommonmark, sphinx-rtd-theme Successfully installed Jinja2-3.1.2 MarkupSafe-2.1.2 Pygments-2.15.1 alabaster-0.7.13 babel-2.12.1 certifi-2023.5.7 charset-normalizer-3.1.0 commonmark-0.9.1 docutils-0.18.1 idna-3.4 imagesize-1.4.1 importlib-metadata-6.6.0 mock-1.0.1 packaging-23.1 pillow-9.5.0 readthedocs-sphinx-ext-2.2.0 recommonmark-0.5.0 requests-2.30.0 snowballstemmer-2.2.0 sphinx-6.2.1 sphinx-rtd-theme-1.2.0 sphinxcontrib-applehelp-1.0.4 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-2.0.1 sphinxcontrib-jquery-4.1 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 sphinxcontrib-serializinghtml-1.1.5 urllib3-2.0.2 zipp-3.15.0 [rtd-command-info] start-time: 2023-05-15T15:46:34.032819Z, end-time: 2023-05-15T15:46:43.604193Z, duration: 9, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r checkbox-ng/docs/requirements.txt Collecting checkbox-ng (from -r checkbox-ng/docs/requirements.txt (line 1)) Downloading checkbox_ng-1.18.1-py3-none-any.whl (2.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.0/2.0 MB 52.7 MB/s eta 0:00:00 Requirement already satisfied: Jinja2>=2.7 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-checkbox/envs/stable/lib/python3.9/site-packages (from checkbox-ng->-r checkbox-ng/docs/requirements.txt (line 1)) (3.1.2) Requirement already satisfied: requests>=1.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-checkbox/envs/stable/lib/python3.9/site-packages (from checkbox-ng->-r checkbox-ng/docs/requirements.txt (line 1)) (2.30.0) Collecting urwid>=1.1.1 (from checkbox-ng->-r checkbox-ng/docs/requirements.txt (line 1)) Downloading urwid-2.1.2.tar.gz (634 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 634.6/634.6 kB 260.9 MB/s eta 0:00:00 Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting xlsxwriter (from checkbox-ng->-r checkbox-ng/docs/requirements.txt (line 1)) Downloading XlsxWriter-3.1.0-py3-none-any.whl (152 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 152.7/152.7 kB 251.6 MB/s eta 0:00:00 Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-checkbox/envs/stable/lib/python3.9/site-packages (from Jinja2>=2.7->checkbox-ng->-r checkbox-ng/docs/requirements.txt (line 1)) (2.1.2) Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-checkbox/envs/stable/lib/python3.9/site-packages (from requests>=1.0->checkbox-ng->-r checkbox-ng/docs/requirements.txt (line 1)) (3.1.0) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-checkbox/envs/stable/lib/python3.9/site-packages (from requests>=1.0->checkbox-ng->-r checkbox-ng/docs/requirements.txt (line 1)) (3.4) Requirement already satisfied: urllib3<3,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-checkbox/envs/stable/lib/python3.9/site-packages (from requests>=1.0->checkbox-ng->-r checkbox-ng/docs/requirements.txt (line 1)) (2.0.2) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-checkbox/envs/stable/lib/python3.9/site-packages (from requests>=1.0->checkbox-ng->-r checkbox-ng/docs/requirements.txt (line 1)) (2023.5.7) Building wheels for collected packages: urwid Building wheel for urwid (setup.py): started Building wheel for urwid (setup.py): finished with status 'done' Created wheel for urwid: filename=urwid-2.1.2-cp39-cp39-linux_x86_64.whl size=262809 sha256=c9681e0627431660cad2c81829da9926bb55f6c5f72b9dbcc4cb3b393b065242 Stored in directory: /tmp/pip-ephem-wheel-cache-m5xus0ms/wheels/44/ec/04/2c1080c3ee4e80e76d662ac35f0594a2a86f9df12095b05cb3 Successfully built urwid Installing collected packages: urwid, xlsxwriter, checkbox-ng Successfully installed checkbox-ng-1.18.1 urwid-2.1.2 xlsxwriter-3.1.0 [rtd-command-info] start-time: 2023-05-15T15:46:45.163425Z, end-time: 2023-05-15T15:46:45.227642Z, duration: 0, exit-code: 0 cat checkbox-ng/docs/conf.py #!/usr/bin/env python3 # -*- coding: utf-8 -*- # # CheckboxNG documentation build configuration file, created by # sphinx-quickstart on Wed Feb 13 11:18:39 2013. # # This file is execfile()d with the current directory set to its containing # dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import os import sys try: import plainbox except ImportError as exc: raise SystemExit("plainbox has to be importable") else: # Inject mock modules so that we can build the # documentation without having the real stuff available from plainbox.vendor import mock for mod_name in ['xlsxwriter']: sys.modules[mod_name] = mock.Mock() print("Mocked {}".format(mod_name)) try: import checkbox_ng except ImportError: raise SystemExit("checkbox_ng has to be importable") # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # sys.path.insert(0, os.path.abspath('.')) # -- General configuration --------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. # needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'sphinx.ext.intersphinx'] def check_object_path(key, url, path): if os.path.isfile(path): return {key: (url, path)} else: return {key: (url, None)} intersphinx_mapping = {} intersphinx_mapping.update( check_object_path( 'python', 'http://docs.python.org/', '/usr/share/doc/python{}/html/objects.inv'.format( '.'.join([str(x) for x in sys.version_info[0:2]])))) # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. # source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = 'Checkbox' copyright = '2013-2021, Checkbox Developers' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = "{0[0]}.{0[1]}".format(checkbox_ng.__version__.split('.')) # The full version, including alpha/beta/rc tags. release = checkbox_ng.__version__ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: # today = '' # Else, today_fmt is used as the format for a strftime call. # today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = [] # The reST default role (used for this markup: `text`) to use for all # documents. # default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. # add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). # add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. # show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. # modindex_common_prefix = [] # -- Options for HTML output ------------------------------------------------- # html_theme_path = ['_templates'] html_theme = 'alabaster' html_theme_options = { 'github_button': 'false', 'page_width': '1040px', 'sidebar_width': '320px', 'sidebar_link': '#E95420', 'sidebar_link_underscore': '#E95420', 'link': '#E95420', 'link_hover': '#E95420', 'font_family': "'Ubuntu', sans-serif", 'head_font_family': "'Ubuntu', sans-serif", 'code_font_family': "'Ubuntu Mono', monospace", 'code_font_size': '1em' } # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". # html_title = None # A shorter title for the navigation bar. Default is the same as html_title. # html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. # html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. # html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". #html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. # html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True # Custom sidebar templates, maps document names to template names. html_sidebars = { '**': [ 'about.html', 'navigation.html', 'relations.html', 'searchbox.html' ] } # Additional templates that should be rendered to pages, maps page names to # template names. # html_additional_pages = {} # If false, no module index is generated. # html_domain_indices = True # If false, no index is generated. # html_use_index = True # If true, the index is split into individual pages for each letter. # html_split_index = False # If true, links to the reST sources are added to the pages. # html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. # html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. # html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. # html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). # html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'CheckboxNGdoc' # -- Options for LaTeX output ------------------------------------------------ latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # 'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. # 'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, # documentclass [howto/manual]). latex_documents = [ ('index', 'CheckboxNG.tex', 'CheckboxNG Documentation', 'Checkbox Developers', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. # latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. # latex_use_parts = False # If true, show page references after internal links. # latex_show_pagerefs = False # If true, show URL addresses after external links. # latex_show_urls = False # Documents to append as an appendix to all manuals. # latex_appendices = [] # If false, no module index is generated. # latex_domain_indices = True # -- Options for manual page output ------------------------------------------ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'checkbox_ng', 'Checkbox Documentation', ['Checkbox Developers'], 1), ('stack', 'checkbox-stack', 'description of the checkbox stack', ['Checkbox Developers'], 1), ] # If true, show URL addresses after external links. man_show_urls = True # -- Options for Texinfo output ---------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', 'Checkbox', 'Checkbox Documentation', 'Checkbox Developers', 'Checkbox', 'Checkbox is a flexible test automation software. It’s the main tool used in Ubuntu Certification program.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. # texinfo_appendices = [] # If false, no module index is generated. # texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. # texinfo_show_urls = 'footnote' ########################################################################### # 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: html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} # This following legacy behavior will gradually be sliced out until its deprecated and removed. # Skipped for Sphinx 6+ # Skipped by internal Feature flag SKIP_SPHINX_HTML_THEME_PATH # Skipped by all new projects since SKIP_SPHINX_HTML_THEME_PATH's introduction (jan 2023) if ( using_rtd_theme and version_info < (6,0) and not False ): theme = importlib.import_module('sphinx_rtd_theme') if 'html_theme_path' in globals(): html_theme_path.append(theme.get_html_theme_path()) else: html_theme_path = [theme.get_html_theme_path()] # Define websupport2_base_url and websupport2_static_url 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': "stable", 'version_slug': "stable", 'MEDIA_URL': "https://media.readthedocs.com/media/", 'STATIC_URL': "https://assets.readthedocs.com/", 'PRODUCTION_DOMAIN': "readthedocs.com", 'proxied_static_path': "/_/static/", 'versions': [ ], 'downloads': [ ], 'subprojects': [ ], 'slug': 'canonical-checkbox', 'name': u'checkbox', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': 'https://canonical-checkbox.readthedocs-hosted.com/en/latest/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/checkbox-ng/docs/', 'api_host': 'https://readthedocs.com', 'github_user': 'canonical', 'proxied_api_host': '/_', 'github_repo': 'checkbox', 'github_version': '67e872915bc2934d2938817064be9600355b3091', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': '67e872915bc2934d2938817064be9600355b3091', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': '67e872915bc2934d2938817064be9600355b3091', 'display_gitlab': False, 'READTHEDOCS': True, 'using_theme': (html_theme == "default"), 'new_theme': (html_theme == "sphinx_rtd_theme"), 'source_suffix': SUFFIX, 'ad_free': False, 'docsearch_disabled': False, 'user_analytics_code': '', 'global_analytics_code': 'UA-17997319-2', 'commit': '67e87291', } # 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 'tag' == 'external': extensions.insert(1, "readthedocs_ext.external_version_warning") readthedocs_vcs_url = 'None' readthedocs_build_url = 'https://readthedocs.com/projects/canonical-checkbox/builds/1473627/' 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: 2023-05-15T15:46:45.506546Z, end-time: 2023-05-15T15:46:48.643940Z, duration: 3, exit-code: 0 python -m sphinx -T -E -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html Running Sphinx v6.2.1 Mocked xlsxwriter making output directory... done loading intersphinx inventory from http://docs.python.org/objects.inv... intersphinx inventory has moved: http://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv building [mo]: targets for 0 po files that are out of date writing output... building [html]: targets for 27 source files that are out of date updating environment: [new config] 27 added, 0 changed, 0 removed reading sources... [ 3%] bugs reading sources... [ 7%] configs reading sources... [ 11%] contributing reading sources... [ 14%] custom-app reading sources... [ 18%] glossary reading sources... [ 22%] index reading sources... [ 25%] launcher-tutorial reading sources... [ 29%] nested-test-plan reading sources... [ 33%] remote reading sources... [ 37%] side-loading reading sources... [ 40%] slave-daemon reading sources... [ 44%] snappy reading sources... [ 48%] stack reading sources... [ 51%] testing-snappy reading sources... [ 55%] tutorials reading sources... [ 59%] understanding reading sources... [ 62%] units/category reading sources... [ 66%] units/exporter reading sources... [ 70%] units/index reading sources... [ 74%] units/job reading sources... [ 77%] units/manifest-entry reading sources... [ 81%] units/packaging-meta-data reading sources... [ 85%] units/resource reading sources... [ 88%] units/rfc822 reading sources... [ 92%] units/template reading sources... [ 96%] units/test-plan reading sources... [100%] using looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 3%] bugs writing output... [ 7%] configs writing output... [ 11%] contributing writing output... [ 14%] custom-app writing output... [ 18%] glossary writing output... [ 22%] index writing output... [ 25%] launcher-tutorial writing output... [ 29%] nested-test-plan writing output... [ 33%] remote writing output... [ 37%] side-loading writing output... [ 40%] slave-daemon writing output... [ 44%] snappy writing output... [ 48%] stack writing output... [ 51%] testing-snappy writing output... [ 55%] tutorials writing output... [ 59%] understanding writing output... [ 62%] units/category writing output... [ 66%] units/exporter writing output... [ 70%] units/index writing output... [ 74%] units/job writing output... [ 77%] units/manifest-entry writing output... [ 81%] units/packaging-meta-data writing output... [ 85%] units/resource writing output... [ 88%] units/rfc822 writing output... [ 92%] units/template writing output... [ 96%] units/test-plan writing output... [100%] using generating indices... genindex done highlighting module code... writing additional pages... search done copying images... [ 6%] _images/checkbox.png copying images... [ 13%] _images/checkbox-test-report.png copying images... [ 20%] _images/checkbox-snappy-3-select-jobs.png copying images... [ 26%] _images/interrupt.png copying images... [ 33%] _images/SnappyProvider1.png copying images... [ 40%] _images/SnappyProvider2.png copying images... [ 46%] _images/SnappyProvider3.png copying images... [ 53%] _images/SnappyProvider4.png copying images... [ 60%] _images/checkbox-snappy-1-test-plan.png copying images... [ 66%] _images/checkbox-snappy-2-resume-session.png copying images... [ 73%] _images/checkbox-snappy-4-user-interact-job.png copying images... [ 80%] _images/checkbox-snappy-5-rerun-jobs.png copying images... [ 86%] _images/checkbox-snappy-6-test-results.png copying images... [ 93%] _images/cc2.png copying images... [100%] _images/cc3.png copying static files... done copying extra files... done dumping search index in English (code: en)... done dumping object inventory... done Updating searchtools for Read the Docs search... build succeeded. The HTML pages are in ../../_readthedocs/html.