tag of individual pages, and used in the navigation bar as the "topmost" element. # It defaults to '<project> v<revision> documentation'. html_title = "Acquia Docs" # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = "foundation" html_theme_path = ['_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 = { 'topbar_site': False, 'topbar_page': False, 'topbar_relations': False, 'stylesheet': 'custom.css' } # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] html_favicon = '_static/favicon.ico' # Custom sidebar templates, must be a dictionary that maps document names # to template names. # # This is required for the alabaster theme # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars html_sidebars = { '**': [ 'globaltoc.html' ] } # Added in DOC-17365 based on an email thread with ReadTheDocs, this directive # should allow us to use a custom 404 page in HTML format. It lives in the # same directory as conf.py. # PUB-16852 adds in the google ID file. html_extra_path = ['404.html', 'google7e6dbd00fff28985.html','search.html'] # Added in PUB-16852 as part of installing the sphinx-sitemap package. # https://pypi.org/project/sphinx-sitemap/ says to # - add this line # - add the package to the extensions array in this file # - add the package to the requirements.txt file for Read the Docs to require it site_url = "https://docs.acquia.com/" # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. htmlhelp_basename = 'AcquiaDocsdoc' # -- 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 = [ (master_doc, 'AcquiaDocs.tex', 'Acquia Docs Documentation', 'Acquia Technical Publications team', 'manual'), ] # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ (master_doc, 'acquiadocs', 'Acquia Docs Documentation', [author], 1) ] # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'AcquiaDocs', 'Acquia Docs Documentation', author, 'AcquiaDocs', 'One line description of project.', 'Miscellaneous'), ] # -- Options for Epub output ---------------------------------------------- # Bibliographic Dublin Core info. epub_title = project epub_author = author epub_publisher = author epub_copyright = copyright # The unique identifier of the text. This can be a ISBN number # or the project homepage. # # epub_identifier = '' # A unique identification for the text. # # epub_uid = '' # A list of files that should not be packed into the epub file. epub_exclude_files = ['search.html'] # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'https://docs.python.org/': None} # -- Test substitutions via rst_epilog ----------------------------------- rst_epilog = open('_includes/acquia-products.txt', 'r').read() rst_epilog += open('_includes/acquia-logos.txt', 'r').read() rst_epilog += open('_includes/acquia-images.txt', 'r').read() ########################################################################### # 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': [ ("stable", "/en/stable/"), ], 'downloads': [ ("html", "//docs.acquia.com/_/downloads/en/stable/htmlzip/"), ], 'subprojects': [ ], 'slug': 'acquia-docs', 'name': u'Docs', 'rtd_language': u'en', 'programming_language': u'php', 'canonical_url': 'https://docs.acquia.com/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/docs/', 'api_host': 'https://readthedocs.com', 'github_user': 'acquia', 'proxied_api_host': '/_', 'github_repo': 'docs', 'github_version': '21d8701312d2a31b92ba366a06db077bfe901689', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': '21d8701312d2a31b92ba366a06db077bfe901689', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': '21d8701312d2a31b92ba366a06db077bfe901689', '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': '21d87013', } # 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/acquia-docs/builds/1416989/' 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(['

Read the Docs build information Build id: 1416989 Project: acquia-docs Version: stable Commit: 21d8701312d2a31b92ba366a06db077bfe901689 Date: 2023-04-17T14:18:44.139657Z State: cancelled Success: False [rtd-command-info] start-time: 2023-04-17T14:19:36.058657Z, end-time: 2023-04-17T14:19:51.465278Z, duration: 15, exit-code: 0 git clone --no-single-branch --depth 50 git@github.com:acquia/docs.git . Cloning into '.'... Warning: Permanently added 'github.com,192.30.255.112' (ECDSA) to the list of known hosts. [rtd-command-info] start-time: 2023-04-17T14:19:51.694306Z, end-time: 2023-04-17T14:19:52.112477Z, duration: 0, exit-code: 0 git checkout --force 21d8701312d2a31b92ba366a06db077bfe901689 Note: switching to '21d8701312d2a31b92ba366a06db077bfe901689'. 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 21d870131 Merge pull request #6953 from Sidhartha10/feature/DOC-26553 [rtd-command-info] start-time: 2023-04-17T14:19:52.379773Z, end-time: 2023-04-17T14:19:52.460162Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2023-04-17T14:19:53.896502Z, end-time: 2023-04-17T14:19:58.359304Z, duration: 4, exit-code: 0 python3.7 -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH Using base prefix '/home/docs/.pyenv/versions/3.7.9' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/acquia-docs/envs/stable/bin/python3.7 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/acquia-docs/envs/stable/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2023-04-17T14:19:58.562215Z, end-time: 2023-04-17T14:20:00.180577Z, 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/acquia-docs/envs/stable/lib/python3.7/site-packages (23.1) Collecting setuptools<58.3.0 Downloading setuptools-58.2.0-py3-none-any.whl (946 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 946.1/946.1 kB 32.0 MB/s eta 0:00:00 Installing collected packages: setuptools Attempting uninstall: setuptools Found existing installation: setuptools 67.6.1 Uninstalling setuptools-67.6.1: Successfully uninstalled setuptools-67.6.1 Successfully installed setuptools-58.2.0 [rtd-command-info] start-time: 2023-04-17T14:20:00.493970Z, end-time: 2023-04-17T14:20:07.129072Z, duration: 6, exit-code: 0 python -m pip install --upgrade --no-cache-dir pillow mock==1.0.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.9.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<2.3 jinja2<3.1.0 Collecting pillow Downloading Pillow-9.5.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.3 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.3/3.3 MB 55.6 MB/s eta 0:00:00 Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 kB 255.4 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 185.9 MB/s eta 0:00:00 Collecting recommonmark==0.5.0 Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Collecting sphinx<2 Downloading Sphinx-1.8.6-py2.py3-none-any.whl (3.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.1/3.1 MB 195.6 MB/s eta 0:00:00 Collecting sphinx-rtd-theme<0.5 Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 6.4/6.4 MB 183.1 MB/s eta 0:00:00 Collecting readthedocs-sphinx-ext<2.3 Downloading readthedocs_sphinx_ext-2.2.0-py2.py3-none-any.whl (11 kB) Collecting jinja2<3.1.0 Downloading Jinja2-3.0.3-py3-none-any.whl (133 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.6/133.6 kB 215.3 MB/s eta 0:00:00 Collecting docutils>=0.11 (from recommonmark==0.5.0) Downloading docutils-0.19-py3-none-any.whl (570 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 570.5/570.5 kB 246.5 MB/s eta 0:00:00 Collecting six>=1.5 (from sphinx<2) Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Collecting Pygments>=2.0 (from sphinx<2) Downloading Pygments-2.15.0-py3-none-any.whl (1.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.1/1.1 MB 258.2 MB/s eta 0:00:00 Collecting docutils>=0.11 (from recommonmark==0.5.0) Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 575.5/575.5 kB 239.8 MB/s eta 0:00:00 Collecting snowballstemmer>=1.1 (from sphinx<2) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 208.9 MB/s eta 0:00:00 Collecting babel!=2.0,>=1.3 (from sphinx<2) Downloading Babel-2.12.1-py3-none-any.whl (10.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 10.1/10.1 MB 201.8 MB/s eta 0:00:00 Collecting imagesize (from sphinx<2) Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Collecting requests>=2.0.0 (from sphinx<2) Downloading requests-2.28.2-py3-none-any.whl (62 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.8/62.8 kB 148.8 MB/s eta 0:00:00 Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/acquia-docs/envs/stable/lib/python3.7/site-packages (from sphinx<2) (58.2.0) Collecting packaging (from sphinx<2) Downloading packaging-23.1-py3-none-any.whl (48 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 48.9/48.9 kB 186.2 MB/s eta 0:00:00 Collecting sphinxcontrib-websupport (from sphinx<2) Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB) Collecting MarkupSafe>=2.0 (from jinja2<3.1.0) Downloading MarkupSafe-2.1.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB) Collecting pytz>=2015.7 (from babel!=2.0,>=1.3->sphinx<2) Downloading pytz-2023.3-py2.py3-none-any.whl (502 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 502.3/502.3 kB 241.9 MB/s eta 0:00:00 Collecting charset-normalizer<4,>=2 (from requests>=2.0.0->sphinx<2) Downloading charset_normalizer-3.1.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (171 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 171.0/171.0 kB 236.6 MB/s eta 0:00:00 Collecting idna<4,>=2.5 (from requests>=2.0.0->sphinx<2) Downloading idna-3.4-py3-none-any.whl (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.5/61.5 kB 191.2 MB/s eta 0:00:00 Collecting urllib3<1.27,>=1.21.1 (from requests>=2.0.0->sphinx<2) Downloading urllib3-1.26.15-py2.py3-none-any.whl (140 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 140.9/140.9 kB 223.5 MB/s eta 0:00:00 Collecting certifi>=2017.4.17 (from requests>=2.0.0->sphinx<2) Downloading certifi-2022.12.7-py3-none-any.whl (155 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 155.3/155.3 kB 225.2 MB/s eta 0:00:00 Collecting sphinxcontrib-serializinghtml (from sphinxcontrib-websupport->sphinx<2) Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 94.0/94.0 kB 210.7 MB/s eta 0:00:00 Building wheels for collected packages: mock Building wheel for mock (setup.py): started Building wheel for mock (setup.py): finished with status 'done' Created wheel for mock: filename=mock-1.0.1-py3-none-any.whl size=23772 sha256=e4a891e1a36b88b6a27449a3c840320d1b4e3f099f02f194c3cb6ede74b500e8 Stored in directory: /tmp/pip-ephem-wheel-cache-xrwa2ygk/wheels/7a/94/b1/0fdc5339a5bd487a5cc15421ec200d9ba3e2aa7190e4a727f1 Successfully built mock Installing collected packages: snowballstemmer, pytz, mock, commonmark, urllib3, sphinxcontrib-serializinghtml, six, Pygments, pillow, packaging, MarkupSafe, imagesize, idna, docutils, charset-normalizer, certifi, babel, alabaster, sphinxcontrib-websupport, requests, jinja2, sphinx, readthedocs-sphinx-ext, sphinx-rtd-theme, recommonmark Successfully installed MarkupSafe-2.1.2 Pygments-2.15.0 alabaster-0.7.13 babel-2.12.1 certifi-2022.12.7 charset-normalizer-3.1.0 commonmark-0.9.1 docutils-0.17.1 idna-3.4 imagesize-1.4.1 jinja2-3.0.3 mock-1.0.1 packaging-23.1 pillow-9.5.0 pytz-2023.3 readthedocs-sphinx-ext-2.2.0 recommonmark-0.5.0 requests-2.28.2 six-1.16.0 snowballstemmer-2.2.0 sphinx-1.8.6 sphinx-rtd-theme-0.4.3 sphinxcontrib-serializinghtml-1.1.5 sphinxcontrib-websupport-1.2.4 urllib3-1.26.15 [rtd-command-info] start-time: 2023-04-17T14:20:07.380726Z, end-time: 2023-04-17T14:20:26.194092Z, duration: 18, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r requirements.txt Collecting alabaster==0.7.12 (from -r requirements.txt (line 2)) Downloading alabaster-0.7.12-py2.py3-none-any.whl (14 kB) Collecting argh==0.26.2 (from -r requirements.txt (line 3)) Downloading argh-0.26.2-py2.py3-none-any.whl (30 kB) Collecting babel==2.7.0 (from -r requirements.txt (line 4)) Downloading Babel-2.7.0-py2.py3-none-any.whl (8.4 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 8.4/8.4 MB 134.4 MB/s eta 0:00:00 Collecting certifi==2019.6.16 (from -r requirements.txt (line 5)) Downloading certifi-2019.6.16-py2.py3-none-any.whl (157 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 157.1/157.1 kB 222.5 MB/s eta 0:00:00 Collecting chardet==3.0.4 (from -r requirements.txt (line 6)) Downloading chardet-3.0.4-py2.py3-none-any.whl (133 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.4/133.4 kB 224.2 MB/s eta 0:00:00 Collecting docutils==0.15.2 (from -r requirements.txt (line 7)) Downloading docutils-0.15.2-py3-none-any.whl (547 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 547.6/547.6 kB 256.7 MB/s eta 0:00:00 Collecting idna==2.6 (from -r requirements.txt (line 8)) Downloading idna-2.6-py2.py3-none-any.whl (56 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 56.5/56.5 kB 187.3 MB/s eta 0:00:00 Collecting imagesize==1.1.0 (from -r requirements.txt (line 9)) Downloading imagesize-1.1.0-py2.py3-none-any.whl (4.4 kB) Collecting jinja2==2.10.1 (from -r requirements.txt (line 10)) Downloading Jinja2-2.10.1-py2.py3-none-any.whl (124 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 124.9/124.9 kB 220.5 MB/s eta 0:00:00 Collecting livereload==2.6.1 (from -r requirements.txt (line 11)) Downloading livereload-2.6.1-py2.py3-none-any.whl (23 kB) Collecting markupsafe==1.1.1 (from -r requirements.txt (line 12)) Downloading MarkupSafe-1.1.1-cp37-cp37m-manylinux2010_x86_64.whl (33 kB) Collecting pathtools==0.1.2 (from -r requirements.txt (line 13)) Downloading pathtools-0.1.2.tar.gz (11 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting port-for==0.3.1 (from -r requirements.txt (line 14)) Downloading port-for-0.3.1.tar.gz (18 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting pygments==2.4.2 (from -r requirements.txt (line 15)) Downloading Pygments-2.4.2-py2.py3-none-any.whl (883 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 883.1/883.1 kB 252.2 MB/s eta 0:00:00 Collecting pytz==2019.2 (from -r requirements.txt (line 16)) Downloading pytz-2019.2-py2.py3-none-any.whl (508 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 508.9/508.9 kB 248.5 MB/s eta 0:00:00 Collecting pyyaml==5.1.2 (from -r requirements.txt (line 17)) Downloading PyYAML-5.1.2.tar.gz (265 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 265.0/265.0 kB 243.3 MB/s eta 0:00:00 Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting requests==2.18.4 (from -r requirements.txt (line 18)) Downloading requests-2.18.4-py2.py3-none-any.whl (88 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 88.7/88.7 kB 206.2 MB/s eta 0:00:00 Collecting six==1.12.0 (from -r requirements.txt (line 19)) Downloading six-1.12.0-py2.py3-none-any.whl (10 kB) Collecting snowballstemmer==1.9.0 (from -r requirements.txt (line 20)) Downloading snowballstemmer-1.9.0.tar.gz (76 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 76.9/76.9 kB 206.3 MB/s eta 0:00:00 Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting sphinx-autobuild==0.7.1 (from -r requirements.txt (line 21)) Downloading sphinx-autobuild-0.7.1.tar.gz (14 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting sphinx-sitemap==1.0.2 (from -r requirements.txt (line 22)) Downloading sphinx-sitemap-1.0.2.tar.gz (4.7 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting sphinx-tabs==1.1.11 (from -r requirements.txt (line 23)) Downloading sphinx-tabs-1.1.11.tar.gz (21 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting sphinx==1.6.5 (from -r requirements.txt (line 24)) Downloading Sphinx-1.6.5-py2.py3-none-any.whl (1.9 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.9/1.9 MB 232.9 MB/s eta 0:00:00 Collecting sphinxcontrib-fulltoc==1.2.0 (from -r requirements.txt (line 25)) Downloading sphinxcontrib-fulltoc-1.2.0.tar.gz (13 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting sphinxcontrib-websupport==1.1.2 (from -r requirements.txt (line 26)) Downloading sphinxcontrib_websupport-1.1.2-py2.py3-none-any.whl (39 kB) Collecting tornado==6.0.3 (from -r requirements.txt (line 27)) Downloading tornado-6.0.3.tar.gz (482 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 482.4/482.4 kB 239.9 MB/s eta 0:00:00 Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting urllib3==1.22 (from -r requirements.txt (line 28)) Downloading urllib3-1.22-py2.py3-none-any.whl (132 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 132.3/132.3 kB 211.9 MB/s eta 0:00:00 Collecting watchdog==0.9.0 (from -r requirements.txt (line 29)) Downloading watchdog-0.9.0.tar.gz (85 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 85.5/85.5 kB 207.6 MB/s eta 0:00:00 Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/acquia-docs/envs/stable/lib/python3.7/site-packages (from sphinx==1.6.5->-r requirements.txt (line 24)) (58.2.0) Building wheels for collected packages: pathtools, port-for, pyyaml, snowballstemmer, sphinx-autobuild, sphinx-sitemap, sphinx-tabs, sphinxcontrib-fulltoc, tornado, watchdog Building wheel for pathtools (setup.py): started Building wheel for pathtools (setup.py): finished with status 'done' Created wheel for pathtools: filename=pathtools-0.1.2-py3-none-any.whl size=8808 sha256=04078e191b668ce324a64d959f5ca26383b44ae21156cf921eb8097c63834578 Stored in directory: /tmp/pip-ephem-wheel-cache-sjfumjec/wheels/3e/31/09/fa59cef12cdcfecc627b3d24273699f390e71828921b2cbba2 Building wheel for port-for (setup.py): started Building wheel for port-for (setup.py): finished with status 'done' Created wheel for port-for: filename=port_for-0.3.1-py3-none-any.whl size=19623 sha256=e846ef97ddbc09c959757f105b326d5c16126a9bd64d54eb57a34eeafba2fd85 Stored in directory: /tmp/pip-ephem-wheel-cache-sjfumjec/wheels/a0/3a/de/2fee22649fd79d152f8726b86b9dec6fd35924e71d8e4c2bf2 Building wheel for pyyaml (setup.py): started Building wheel for pyyaml (setup.py): finished with status 'done' Created wheel for pyyaml: filename=PyYAML-5.1.2-cp37-cp37m-linux_x86_64.whl size=44117 sha256=f20f542ebf0c1bfc1bfe9bdcebf4badfcd82720a3effad6831488dce521df571 Stored in directory: /tmp/pip-ephem-wheel-cache-sjfumjec/wheels/23/b9/73/57aaccb6957d94ed63f474b51a9f7f992c5eff4635052c0557 Building wheel for snowballstemmer (setup.py): started Building wheel for snowballstemmer (setup.py): finished with status 'done' Created wheel for snowballstemmer: filename=snowballstemmer-1.9.0-py3-none-any.whl size=93831 sha256=e7eb8486e8da0520761e8fe5d91d7b12ce490c1b301f0787988fd5a0f66a7f6f Stored in directory: /tmp/pip-ephem-wheel-cache-sjfumjec/wheels/bb/f4/05/5206042fdf39c55e94131ac203541f48ceedc203e9a61b3b62 Building wheel for sphinx-autobuild (setup.py): started Building wheel for sphinx-autobuild (setup.py): finished with status 'done' Created wheel for sphinx-autobuild: filename=sphinx_autobuild-0.7.1-py3-none-any.whl size=10093 sha256=b5339b2aee4724adc2c8ca6a4f3003085e761a0d3a59cca61ba6cc1fa62cc9c6 Stored in directory: /tmp/pip-ephem-wheel-cache-sjfumjec/wheels/b5/33/11/03f2a5fbd63cd60617cbb411d619008e8e4e0100aa3b21ecda Building wheel for sphinx-sitemap (setup.py): started Building wheel for sphinx-sitemap (setup.py): finished with status 'done' Created wheel for sphinx-sitemap: filename=sphinx_sitemap-1.0.2-py3-none-any.whl size=4789 sha256=d9f56d099bc6c03a05336ca33752a425a2512c20de39fbd88e23f597d9932cd7 Stored in directory: /tmp/pip-ephem-wheel-cache-sjfumjec/wheels/ae/c4/a3/341c6e32293c3eff4c404fc3371874fdbc3a6f8462854ad488 Building wheel for sphinx-tabs (setup.py): started Building wheel for sphinx-tabs (setup.py): finished with status 'done' Created wheel for sphinx-tabs: filename=sphinx_tabs-1.1.11-py3-none-any.whl size=26175 sha256=5302d084bd48ecd98c3eedef69ac520df30b9418fe539c3315ee1821524ffe06 Stored in directory: /tmp/pip-ephem-wheel-cache-sjfumjec/wheels/df/a9/bb/e47313e1cce93fcf2a092aa62ff223d6274d028fffa8c393c6 Building wheel for sphinxcontrib-fulltoc (setup.py): started Building wheel for sphinxcontrib-fulltoc (setup.py): finished with status 'done' Created wheel for sphinxcontrib-fulltoc: filename=sphinxcontrib_fulltoc-1.2.0-py2.py3-none-any.whl size=8736 sha256=2dc934c4d0157556aeb8cfe41203951afa24fd7243d34e7289cd3a711adea7eb Stored in directory: /tmp/pip-ephem-wheel-cache-sjfumjec/wheels/e4/d6/1d/eb3277f5b89e14249b3a5d0a3c92c7a582d4b54050dbfda16e Building wheel for tornado (setup.py): started Building wheel for tornado (setup.py): finished with status 'done' Created wheel for tornado: filename=tornado-6.0.3-cp37-cp37m-linux_x86_64.whl size=424163 sha256=8746ef00e1b8f88139037127c5458522961872a73d4c3ec87882c54fe68c664b Stored in directory: /tmp/pip-ephem-wheel-cache-sjfumjec/wheels/d0/31/2c/9406ed59f0dcdce0c453a8664124d738551590e74fc087f604 Building wheel for watchdog (setup.py): started Building wheel for watchdog (setup.py): finished with status 'done' Created wheel for watchdog: filename=watchdog-0.9.0-py3-none-any.whl size=73687 sha256=44a226e4bd033f11d052d57883f0c184747929df082650c2ba6fdd60f9528f8d Stored in directory: /tmp/pip-ephem-wheel-cache-sjfumjec/wheels/11/13/28/f1224b6031ddfaf72de630b6369c7ea0c59f1e3c3ce600d365 Successfully built pathtools port-for pyyaml snowballstemmer sphinx-autobuild sphinx-sitemap sphinx-tabs sphinxcontrib-fulltoc tornado watchdog Installing collected packages: urllib3, sphinxcontrib-fulltoc, snowballstemmer, pytz, port-for, pathtools, idna, chardet, certifi, argh, alabaster, tornado, sphinxcontrib-websupport, six, requests, pyyaml, pygments, markupsafe, imagesize, docutils, babel, watchdog, livereload, jinja2, sphinx-autobuild, sphinx, sphinx-tabs, sphinx-sitemap Attempting uninstall: urllib3 Found existing installation: urllib3 1.26.15 Uninstalling urllib3-1.26.15: Successfully uninstalled urllib3-1.26.15 Attempting uninstall: snowballstemmer Found existing installation: snowballstemmer 2.2.0 Uninstalling snowballstemmer-2.2.0: Successfully uninstalled snowballstemmer-2.2.0 Attempting uninstall: pytz Found existing installation: pytz 2023.3 Uninstalling pytz-2023.3: Successfully uninstalled pytz-2023.3 Attempting uninstall: idna Found existing installation: idna 3.4 Uninstalling idna-3.4: Successfully uninstalled idna-3.4 Attempting uninstall: certifi Found existing installation: certifi 2022.12.7 Uninstalling certifi-2022.12.7: Successfully uninstalled certifi-2022.12.7 Attempting uninstall: alabaster Found existing installation: alabaster 0.7.13 Uninstalling alabaster-0.7.13: Successfully uninstalled alabaster-0.7.13 Attempting uninstall: sphinxcontrib-websupport Found existing installation: sphinxcontrib-websupport 1.2.4 Uninstalling sphinxcontrib-websupport-1.2.4: Successfully uninstalled sphinxcontrib-websupport-1.2.4 Attempting uninstall: six Found existing installation: six 1.16.0 Uninstalling six-1.16.0: Successfully uninstalled six-1.16.0 Attempting uninstall: requests Found existing installation: requests 2.28.2 Uninstalling requests-2.28.2: Successfully uninstalled requests-2.28.2 Attempting uninstall: pygments Found existing installation: Pygments 2.15.0 Uninstalling Pygments-2.15.0: Successfully uninstalled Pygments-2.15.0 Attempting uninstall: markupsafe Found existing installation: MarkupSafe 2.1.2 Uninstalling MarkupSafe-2.1.2: Successfully uninstalled MarkupSafe-2.1.2 Attempting uninstall: imagesize Found existing installation: imagesize 1.4.1 Uninstalling imagesize-1.4.1: Successfully uninstalled imagesize-1.4.1 Attempting uninstall: docutils Found existing installation: docutils 0.17.1 Uninstalling docutils-0.17.1: Successfully uninstalled docutils-0.17.1 Attempting uninstall: babel Found existing installation: Babel 2.12.1 Uninstalling Babel-2.12.1: Successfully uninstalled Babel-2.12.1 Attempting uninstall: jinja2 Found existing installation: Jinja2 3.0.3 Uninstalling Jinja2-3.0.3: Successfully uninstalled Jinja2-3.0.3 Attempting uninstall: sphinx Found existing installation: Sphinx 1.8.6 Uninstalling Sphinx-1.8.6: Successfully uninstalled Sphinx-1.8.6 Successfully installed alabaster-0.7.12 argh-0.26.2 babel-2.7.0 certifi-2019.6.16 chardet-3.0.4 docutils-0.15.2 idna-2.6 imagesize-1.1.0 jinja2-2.10.1 livereload-2.6.1 markupsafe-1.1.1 pathtools-0.1.2 port-for-0.3.1 pygments-2.4.2 pytz-2019.2 pyyaml-5.1.2 requests-2.18.4 six-1.12.0 snowballstemmer-1.9.0 sphinx-1.6.5 sphinx-autobuild-0.7.1 sphinx-sitemap-1.0.2 sphinx-tabs-1.1.11 sphinxcontrib-fulltoc-1.2.0 sphinxcontrib-websupport-1.1.2 tornado-6.0.3 urllib3-1.22 watchdog-0.9.0 [rtd-command-info] start-time: 2023-04-17T14:20:28.051863Z, end-time: 2023-04-17T14:20:28.119430Z, duration: 0, exit-code: 0 cat docs/conf.py #!/usr/bin/env python3 # -*- coding: utf-8 -*- # # Acquia Docs documentation build configuration file, created by # sphinx-quickstart on Wed Nov 8 15:51:11 2017. # # 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. # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # # import os # import sys # sys.path.insert(0, os.path.abspath('../')) # -- 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.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'sphinxcontrib.fulltoc', 'sphinx_sitemap', 'sphinx_tabs.tabs' ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] source_suffix = '.rst' # The master toctree document. master_doc = 'index' # General information about the project. project = 'Acquia Docs' copyright = '2018 Acquia Inc.' author = 'Acquia Inc.' # 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. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language = 'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store','_acquia-templates', 'Makefile'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'rrt' # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True # -- Options for HTML output ---------------------------------------------- # The "title" for HTML documentation generated with Sphinx’s own templates. This is appended to the # tag of individual pages, and used in the navigation bar as the "topmost" element. # It defaults to '<project> v<revision> documentation'. html_title = "Acquia Docs" # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = "foundation" html_theme_path = ['_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 = { 'topbar_site': False, 'topbar_page': False, 'topbar_relations': False, 'stylesheet': 'custom.css' } # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] html_favicon = '_static/favicon.ico' # Custom sidebar templates, must be a dictionary that maps document names # to template names. # # This is required for the alabaster theme # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars html_sidebars = { '**': [ 'globaltoc.html' ] } # Added in DOC-17365 based on an email thread with ReadTheDocs, this directive # should allow us to use a custom 404 page in HTML format. It lives in the # same directory as conf.py. # PUB-16852 adds in the google ID file. html_extra_path = ['404.html', 'google7e6dbd00fff28985.html','search.html'] # Added in PUB-16852 as part of installing the sphinx-sitemap package. # https://pypi.org/project/sphinx-sitemap/ says to # - add this line # - add the package to the extensions array in this file # - add the package to the requirements.txt file for Read the Docs to require it site_url = "https://docs.acquia.com/" # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. htmlhelp_basename = 'AcquiaDocsdoc' # -- 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 = [ (master_doc, 'AcquiaDocs.tex', 'Acquia Docs Documentation', 'Acquia Technical Publications team', 'manual'), ] # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ (master_doc, 'acquiadocs', 'Acquia Docs Documentation', [author], 1) ] # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'AcquiaDocs', 'Acquia Docs Documentation', author, 'AcquiaDocs', 'One line description of project.', 'Miscellaneous'), ] # -- Options for Epub output ---------------------------------------------- # Bibliographic Dublin Core info. epub_title = project epub_author = author epub_publisher = author epub_copyright = copyright # The unique identifier of the text. This can be a ISBN number # or the project homepage. # # epub_identifier = '' # A unique identification for the text. # # epub_uid = '' # A list of files that should not be packed into the epub file. epub_exclude_files = ['search.html'] # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'https://docs.python.org/': None} # -- Test substitutions via rst_epilog ----------------------------------- rst_epilog = open('_includes/acquia-products.txt', 'r').read() rst_epilog += open('_includes/acquia-logos.txt', 'r').read() rst_epilog += open('_includes/acquia-images.txt', 'r').read() ########################################################################### # 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': [ ("stable", "/en/stable/"), ], 'downloads': [ ("html", "//docs.acquia.com/_/downloads/en/stable/htmlzip/"), ], 'subprojects': [ ], 'slug': 'acquia-docs', 'name': u'Docs', 'rtd_language': u'en', 'programming_language': u'php', 'canonical_url': 'https://docs.acquia.com/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/docs/', 'api_host': 'https://readthedocs.com', 'github_user': 'acquia', 'proxied_api_host': '/_', 'github_repo': 'docs', 'github_version': '21d8701312d2a31b92ba366a06db077bfe901689', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': '21d8701312d2a31b92ba366a06db077bfe901689', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': '21d8701312d2a31b92ba366a06db077bfe901689', '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': '21d87013', } # 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/acquia-docs/builds/1416989/' 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'])