Read the Docs build information Build id: 598686 Project: advanced-micro-devices-demo Version: latest Commit: 93aaa58a53f9457cf7b4a4efbbb54fd75653abc1 Date: 2021-03-24T17:33:05.617602Z State: finished Success: False [rtd-command-info] start-time: 2021-03-24T17:33:07.098750Z, end-time: 2021-03-24T17:33:09.746248Z, duration: 2, exit-code: 0 git clone --no-single-branch --depth 50 https://github.com/RadeonOpenCompute/ROCm_Documentation . Cloning into '.'... [rtd-command-info] start-time: 2021-03-24T17:33:09.912418Z, end-time: 2021-03-24T17:33:10.335901Z, duration: 0, exit-code: 0 git checkout --force origin/master Note: checking out 'origin/master'. You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by performing another checkout. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -b with the checkout command again. Example: git checkout -b HEAD is now at 93aaa58 Update HIP_API_Guide.rst [rtd-command-info] start-time: 2021-03-24T17:33:10.476723Z, end-time: 2021-03-24T17:33:10.549699Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2021-03-24T17:33:11.935138Z, end-time: 2021-03-24T17:33:16.055489Z, duration: 4, exit-code: 0 python3.7 -mvirtualenv --system-site-packages Using base prefix '/home/docs/.pyenv/versions/3.7.9' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/bin/python3.7 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2021-03-24T17:33:16.198537Z, end-time: 2021-03-24T17:33:17.832998Z, duration: 1, 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/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (21.0.1) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (54.2.0) [rtd-command-info] start-time: 2021-03-24T17:33:17.942843Z, end-time: 2021-03-24T17:33:28.102070Z, duration: 10, exit-code: 0 python -m pip install --upgrade --no-cache-dir -I mock==1.0.1 pillow==5.4.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.8.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<2.2 Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) Collecting pillow==5.4.1 Downloading Pillow-5.4.1-cp37-cp37m-manylinux1_x86_64.whl (2.0 MB) Collecting alabaster!=0.7.5,<0.8,>=0.7 Downloading alabaster-0.7.12-py2.py3-none-any.whl (14 kB) Collecting commonmark==0.8.1 Downloading commonmark-0.8.1-py2.py3-none-any.whl (47 kB) Collecting recommonmark==0.5.0 Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Collecting sphinx<2 Downloading Sphinx-1.8.5-py2.py3-none-any.whl (3.1 MB) Collecting sphinx-rtd-theme<0.5 Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB) Collecting readthedocs-sphinx-ext<2.2 Downloading readthedocs_sphinx_ext-2.1.4-py2.py3-none-any.whl (29 kB) Collecting future Downloading future-0.18.2.tar.gz (829 kB) Collecting docutils>=0.11 Downloading docutils-0.16-py2.py3-none-any.whl (548 kB) Collecting requests Downloading requests-2.25.1-py2.py3-none-any.whl (61 kB) Collecting Jinja2>=2.9 Downloading Jinja2-2.11.3-py2.py3-none-any.whl (125 kB) Collecting six>=1.5 Downloading six-1.15.0-py2.py3-none-any.whl (10 kB) Collecting Pygments>=2.0 Downloading Pygments-2.8.1-py3-none-any.whl (983 kB) Collecting babel!=2.0,>=1.3 Downloading Babel-2.9.0-py2.py3-none-any.whl (8.8 MB) Collecting packaging Downloading packaging-20.9-py2.py3-none-any.whl (40 kB) Collecting imagesize Downloading imagesize-1.2.0-py2.py3-none-any.whl (4.8 kB) Collecting sphinxcontrib-websupport Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB) Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.1.0-py2.py3-none-any.whl (93 kB) Collecting setuptools Downloading setuptools-54.2.0-py3-none-any.whl (785 kB) Collecting pytz>=2015.7 Downloading pytz-2021.1-py2.py3-none-any.whl (510 kB) Collecting MarkupSafe>=0.23 Downloading MarkupSafe-1.1.1-cp37-cp37m-manylinux2010_x86_64.whl (33 kB) Collecting chardet<5,>=3.0.2 Downloading chardet-4.0.0-py2.py3-none-any.whl (178 kB) Collecting certifi>=2017.4.17 Downloading certifi-2020.12.5-py2.py3-none-any.whl (147 kB) Collecting urllib3<1.27,>=1.21.1 Downloading urllib3-1.26.4-py2.py3-none-any.whl (153 kB) Collecting idna<3,>=2.5 Downloading idna-2.10-py2.py3-none-any.whl (58 kB) Collecting pyparsing>=2.0.2 Downloading pyparsing-2.4.7-py2.py3-none-any.whl (67 kB) Collecting sphinxcontrib-serializinghtml Downloading sphinxcontrib_serializinghtml-1.1.4-py2.py3-none-any.whl (89 kB) Building wheels for collected packages: mock, future Building wheel for mock (setup.py): started Building wheel for mock (setup.py): finished with status 'done' Created wheel for mock: filename=mock-1.0.1-py3-none-any.whl size=23755 sha256=e9aa20032be3ac6ae1e51290a3950071c6452dbe0c9027d9ea2a462e294193c4 Stored in directory: /tmp/pip-ephem-wheel-cache-2chjevzd/wheels/7a/94/b1/0fdc5339a5bd487a5cc15421ec200d9ba3e2aa7190e4a727f1 Building wheel for future (setup.py): started Building wheel for future (setup.py): finished with status 'done' Created wheel for future: filename=future-0.18.2-py3-none-any.whl size=491059 sha256=3f27c3ee8cf2940dfceb25c885ff9fc379b759c5f70bc29c1f5ae73d8396fbef Stored in directory: /tmp/pip-ephem-wheel-cache-2chjevzd/wheels/56/b0/fe/4410d17b32f1f0c3cf54cdfb2bc04d7b4b8f4ae377e2229ba0 Successfully built mock future Installing collected packages: urllib3, sphinxcontrib-serializinghtml, pytz, pyparsing, MarkupSafe, idna, chardet, certifi, sphinxcontrib-websupport, snowballstemmer, six, setuptools, requests, Pygments, packaging, Jinja2, imagesize, future, docutils, babel, alabaster, sphinx, commonmark, sphinx-rtd-theme, recommonmark, readthedocs-sphinx-ext, pillow, mock ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts. matplotlib 3.3.2 requires pillow>=6.2.0, but you have pillow 5.4.1 which is incompatible. Successfully installed Jinja2-2.11.3 MarkupSafe-1.1.1 Pygments-2.8.1 alabaster-0.7.12 babel-2.9.0 certifi-2020.12.5 chardet-4.0.0 commonmark-0.8.1 docutils-0.16 future-0.18.2 idna-2.10 imagesize-1.2.0 mock-1.0.1 packaging-20.9 pillow-5.4.1 pyparsing-2.4.7 pytz-2021.1 readthedocs-sphinx-ext-2.1.4 recommonmark-0.5.0 requests-2.25.1 setuptools-54.2.0 six-1.15.0 snowballstemmer-2.1.0 sphinx-1.8.5 sphinx-rtd-theme-0.4.3 sphinxcontrib-serializinghtml-1.1.4 sphinxcontrib-websupport-1.2.4 urllib3-1.26.4 [rtd-command-info] start-time: 2021-03-24T17:33:28.222321Z, end-time: 2021-03-24T17:33:31.513444Z, duration: 3, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r requirements.txt Collecting breathe==4.26.0 Downloading breathe-4.26.0-py3-none-any.whl (80 kB) Collecting sphinxcontrib-bibtex Downloading sphinxcontrib_bibtex-2.2.0-py3-none-any.whl (31 kB) Requirement already satisfied: six>=1.9 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (from breathe==4.26.0->-r requirements.txt (line 1)) (1.15.0) Requirement already satisfied: docutils>=0.12 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (from breathe==4.26.0->-r requirements.txt (line 1)) (0.16) Collecting Sphinx<3.5,>=3.0 Downloading Sphinx-3.4.3-py3-none-any.whl (2.9 MB) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (from Sphinx<3.5,>=3.0->breathe==4.26.0->-r requirements.txt (line 1)) (54.2.0) Collecting sphinxcontrib-htmlhelp Downloading sphinxcontrib_htmlhelp-1.0.3-py2.py3-none-any.whl (96 kB) Collecting sphinxcontrib-qthelp Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (from Sphinx<3.5,>=3.0->breathe==4.26.0->-r requirements.txt (line 1)) (1.2.0) Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (from Sphinx<3.5,>=3.0->breathe==4.26.0->-r requirements.txt (line 1)) (2.11.3) Collecting sphinxcontrib-jsmath Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Collecting sphinxcontrib-devhelp Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (from Sphinx<3.5,>=3.0->breathe==4.26.0->-r requirements.txt (line 1)) (2.8.1) Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (from Sphinx<3.5,>=3.0->breathe==4.26.0->-r requirements.txt (line 1)) (20.9) Requirement already satisfied: sphinxcontrib-serializinghtml in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (from Sphinx<3.5,>=3.0->breathe==4.26.0->-r requirements.txt (line 1)) (1.1.4) Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (from Sphinx<3.5,>=3.0->breathe==4.26.0->-r requirements.txt (line 1)) (2.1.0) Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (from Sphinx<3.5,>=3.0->breathe==4.26.0->-r requirements.txt (line 1)) (2.25.1) Requirement already satisfied: babel>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (from Sphinx<3.5,>=3.0->breathe==4.26.0->-r requirements.txt (line 1)) (2.9.0) Collecting sphinxcontrib-applehelp Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (from Sphinx<3.5,>=3.0->breathe==4.26.0->-r requirements.txt (line 1)) (0.7.12) Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (from babel>=1.3->Sphinx<3.5,>=3.0->breathe==4.26.0->-r requirements.txt (line 1)) (2021.1) Requirement already satisfied: MarkupSafe>=0.23 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (from Jinja2>=2.3->Sphinx<3.5,>=3.0->breathe==4.26.0->-r requirements.txt (line 1)) (1.1.1) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->Sphinx<3.5,>=3.0->breathe==4.26.0->-r requirements.txt (line 1)) (2020.12.5) Requirement already satisfied: urllib3<1.27,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->Sphinx<3.5,>=3.0->breathe==4.26.0->-r requirements.txt (line 1)) (1.26.4) Requirement already satisfied: idna<3,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->Sphinx<3.5,>=3.0->breathe==4.26.0->-r requirements.txt (line 1)) (2.10) Requirement already satisfied: chardet<5,>=3.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->Sphinx<3.5,>=3.0->breathe==4.26.0->-r requirements.txt (line 1)) (4.0.0) Collecting pybtex>=0.20 Downloading pybtex-0.24.0-py2.py3-none-any.whl (561 kB) Collecting pybtex-docutils>=1.0.0 Downloading pybtex_docutils-1.0.0-py3-none-any.whl (4.7 kB) Collecting PyYAML>=3.01 Downloading PyYAML-5.4.1-cp37-cp37m-manylinux1_x86_64.whl (636 kB) Collecting latexcodec>=1.0.4 Downloading latexcodec-2.0.1-py2.py3-none-any.whl (18 kB) Requirement already satisfied: pyparsing>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-demo/envs/latest/lib/python3.7/site-packages (from packaging->Sphinx<3.5,>=3.0->breathe==4.26.0->-r requirements.txt (line 1)) (2.4.7) Installing collected packages: PyYAML, latexcodec, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, pybtex, Sphinx, pybtex-docutils, sphinxcontrib-bibtex, breathe Attempting uninstall: Sphinx Found existing installation: Sphinx 1.8.5 Uninstalling Sphinx-1.8.5: Successfully uninstalled Sphinx-1.8.5 Successfully installed PyYAML-5.4.1 Sphinx-3.4.3 breathe-4.26.0 latexcodec-2.0.1 pybtex-0.24.0 pybtex-docutils-1.0.0 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-bibtex-2.2.0 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-1.0.3 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 [rtd-command-info] start-time: 2021-03-24T17:33:32.465378Z, end-time: 2021-03-24T17:33:32.533942Z, duration: 0, exit-code: 0 cat conf.py #!/usr/bin/env python3 # -*- coding: utf-8 -*- # # ReadTheDocs-Breathe documentation build configuration file, created by # sphinx-quickstart on Mon Feb 10 20:03:57 2014. # # 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 sys import os # 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('.')) # hack for readthedocs to cause it to run doxygen first # https://github.com/rtfd/readthedocs.org/issues/388 on_rtd = os.environ.get('READTHEDOCS', None) == 'True' if on_rtd: from subprocess import call call('./run_doxygen.sh;', shell=True) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' html_theme_options = { 'display_version': False} # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. #Added sphinx.ext.ifconfig from michealjones from now on mj extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.viewcode', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'breathe', ] # Breathe extension variables breathe_projects = { "ReadTheDocs-Breathe": "xml/", "rocr": "rocrxml/", "rocBLAS": "rocBLASxml/", "rocFFT": "rocFFTxml/", "rocALUTION": "rocALUTIONxml/", "rocSPARSE": "rocSPARSExml/", "rocSOLVER": "rocSOLVERxml/", } breathe_default_project = "ReadTheDocs-Breathe" #Added from mj # Configuration for mathjax extension # # Set path for mathjax js to a https URL as sometimes the Breathe docs are displayed under https # and we can't load an http mathjax file from an https view of the docs. So we change to a https # mathjax file which we can load from http or https. We break the url over two lines. #mathjax_path = 'https://c328740.ssl.cf1.rackcdn.com/' \ # 'mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML' mathjax_path="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" # 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 = 'ROCm Documentation' copyright = '2021, Advanced Micro Devices, Inc. All rights reserved.' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = '1.0' # The full version, including alpha/beta/rc tags. release = '1.0.0' # 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 = ['_build'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # The reST default role (used for this markup: `text`) to use for all # documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. #keep_warnings = False # -- 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' # To resolve spacing issue in APIs # 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 = 'ROCmlogo.jpg' # 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_css_files = [ "amdstyles.css", ] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. #html_extra_path = [] # If not '', 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 = {} # 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 = False # 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 = 'ReadTheDocs-Breathedoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', # Latex figure (float) alignment # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ ('index', 'ReadTheDocs-Breathe.tex', 'ReadTheDocs-Breathe Documentation', 'Thomas Edvalson', '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 # -- Hack for making rtd to run multiple Doxyfiles ------------------------ # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'readthedocs-breathe', 'ReadTheDocs-Breathe Documentation', ['Thomas Edvalson'], 1) ] # If true, show URL addresses after external links. #man_show_urls = False # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', 'ReadTheDocs-Breathe', 'ReadTheDocs-Breathe Documentation', 'Thomas Edvalson', 'ReadTheDocs-Breathe', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False ########################################################################### # auto-created readthedocs.org specific configuration # ########################################################################### # # The following code was added during an automated build on readthedocs.org # It is auto created and injected for every build. The result is based on the # conf.py.tmpl file found in the readthedocs.org codebase: # https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl # # Note: this file should't rely on extra depencies. import importlib import sys import os.path # Borrowed from six. PY3 = sys.version_info[0] == 3 string_types = str if PY3 else basestring from sphinx import version_info # Get suffix for proper linking to GitHub # This is deprecated in Sphinx 1.3+, # as each page can have its own suffix if globals().get('source_suffix', False): if isinstance(source_suffix, string_types): SUFFIX = source_suffix elif isinstance(source_suffix, (list, tuple)): # Sphinx >= 1.3 supports list/tuple to define multiple suffixes SUFFIX = source_suffix[0] elif isinstance(source_suffix, dict): # Sphinx >= 1.8 supports a mapping dictionary for multiple suffixes SUFFIX = list(source_suffix.keys())[0] # make a ``list()`` for py2/py3 compatibility else: # default to .rst SUFFIX = '.rst' else: SUFFIX = '.rst' # Add RTD Static Path. Add to the end because it overwrites previous files. if not 'html_static_path' in globals(): html_static_path = [] if os.path.exists('_static'): html_static_path.append('_static') # Add RTD Theme only if they aren't overriding it already using_rtd_theme = ( ( 'html_theme' in globals() and html_theme in ['default'] and # Allow people to bail with a hack of having an html_style 'html_style' not in globals() ) or 'html_theme' not in globals() ) if using_rtd_theme: theme = importlib.import_module('sphinx_rtd_theme') html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} if 'html_theme_path' in globals(): html_theme_path.append(theme.get_html_theme_path()) else: html_theme_path = [theme.get_html_theme_path()] if globals().get('websupport2_base_url', False): websupport2_base_url = 'https://readthedocs.com/websupport' websupport2_static_url = 'https://assets.readthedocs.com/' #Add project information to the template context. context = { 'using_theme': using_rtd_theme, 'html_theme': html_theme, 'current_version': "latest", 'version_slug': "latest", 'MEDIA_URL': "https://media.readthedocs.com/media/", 'STATIC_URL': "https://assets.readthedocs.com/", 'PRODUCTION_DOMAIN': "readthedocs.com", 'versions': [ ("latest", "/en/latest/"), ], 'downloads': [ ("pdf", "//rocmdocs.amd.com/_/downloads/en/latest/pdf/"), ("epub", "//rocmdocs.amd.com/_/downloads/en/latest/epub/"), ], 'subprojects': [ ("advanced-micro-devices-rocsparse", "https://rocmdocs.amd.com/projects/advanced-micro-devices-rocsparse/en/latest/"), ], 'slug': 'advanced-micro-devices-demo', 'name': u'ROCm Documentation', 'rtd_language': u'en', 'programming_language': u'cpp', 'canonical_url': 'https://rocmdocs.amd.com/en/latest/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/', 'api_host': 'https://readthedocs.com', 'github_user': 'RadeonOpenCompute', 'proxied_api_host': '/_', 'github_repo': 'ROCm_Documentation', 'github_version': 'master', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'master', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': 'master', 'display_gitlab': False, 'READTHEDOCS': True, 'using_theme': (html_theme == "default"), 'new_theme': (html_theme == "sphinx_rtd_theme"), 'source_suffix': SUFFIX, 'ad_free': False, 'docsearch_disabled': False, 'user_analytics_code': '', 'global_analytics_code': 'UA-17997319-2', 'commit': '93aaa58a', } # For sphinx >=1.8 we can use html_baseurl to set the canonical URL. # https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl if version_info >= (1, 8): if not globals().get('html_baseurl'): html_baseurl = context['canonical_url'] context['canonical_url'] = None if 'html_context' in globals(): html_context.update(context) else: html_context = context # Add custom RTD extension if 'extensions' in globals(): # Insert at the beginning because it can interfere # with other extensions. # See https://github.com/rtfd/readthedocs.org/pull/4054 extensions.insert(0, "readthedocs_ext.readthedocs") else: extensions = ["readthedocs_ext.readthedocs"] # Add External version warning banner to the external version documentation if 'branch' == 'external': extensions.insert(1, "readthedocs_ext.external_version_warning") readthedocs_vcs_url = 'None' readthedocs_build_url = 'https://readthedocs.com/projects/advanced-micro-devices-demo/builds/598686/' 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'])