From f7aaa07843c030d678ab5f24b807a953d0d64f76 Mon Sep 17 00:00:00 2001 From: Don Naro Date: Tue, 24 Oct 2023 09:23:10 +0100 Subject: [PATCH] [stable-2.13] Unify the Sphinx's `conf.py` files (#651) * Unify the Sphinx's `conf.py` files Previously, these files needed pre-processing and be symlinked. But they all are almost identical. So now, the differing sections in the config are governed by the tags passed to `sphinx-build`. This allows to reduce duplication and errors related to forgetting to update some of the configs but not the others. It removes the need to do pre-processing, meaning less mandatory disk operations before invoking the build process. * versions for stable-2.13 * intersphinx mappings for stable-2.13 --------- Co-authored-by: Sviatoslav Sydorenko --- .gitignore | 1 - docs/docsite/Makefile | 39 +- docs/docsite/Makefile.sphinx | 3 +- .../core_lang_conf.py => rst/conf.py} | 150 ++++++-- docs/docsite/sphinx_conf/2.10_conf.py | 307 --------------- docs/docsite/sphinx_conf/all_conf.py | 307 --------------- docs/docsite/sphinx_conf/ansible_conf.py | 317 ---------------- docs/docsite/sphinx_conf/core_conf.py | 356 ------------------ 8 files changed, 152 insertions(+), 1328 deletions(-) rename docs/docsite/{sphinx_conf/core_lang_conf.py => rst/conf.py} (60%) delete mode 100644 docs/docsite/sphinx_conf/2.10_conf.py delete mode 100644 docs/docsite/sphinx_conf/all_conf.py delete mode 100644 docs/docsite/sphinx_conf/ansible_conf.py delete mode 100644 docs/docsite/sphinx_conf/core_conf.py diff --git a/.gitignore b/.gitignore index 90c1935f4d..b3bb5851d2 100644 --- a/.gitignore +++ b/.gitignore @@ -32,7 +32,6 @@ docs/man/man3/* docs/docsite/_build docs/docsite/*.html docs/docsite/htmlout -docs/docsite/rst/conf.py docs/docsite/rst/index.rst docs/docsite/rst/cli/ansible-*.rst docs/docsite/rst/cli/ansible.rst diff --git a/docs/docsite/Makefile b/docs/docsite/Makefile index 20d2cb86e1..a3f24435c2 100644 --- a/docs/docsite/Makefile +++ b/docs/docsite/Makefile @@ -85,11 +85,9 @@ ansible_structure: echo "Creating symlinks in ansible_structure"; \ ln -sf ../rst/ansible_index.rst rst/index.rst; \ ln -sf ../dev_guide/ansible_index.rst rst/dev_guide/index.rst; \ - ln -sf ../sphinx_conf/ansible_conf.py rst/conf.py; \ else \ echo 'Creating symlinks for older ansible in ansible_structure'; \ ln -sf ../rst/2.10_index.rst rst/index.rst; \ - ln -sf ../sphinx_conf/2.10_conf.py rst/conf.py; \ fi # Symlink the relevant index into place for building core docs @@ -97,22 +95,15 @@ core_structure: @echo "Creating symlinks in core_structure" -ln -sf ../rst/core_index.rst rst/index.rst -ln -sf ../dev_guide/core_index.rst rst/dev_guide/index.rst -# set up the correct core conf.py to use for English vs a translated language -ifdef LANGOPTS - -ln -sf ../sphinx_conf/core_lang_conf.py rst/conf.py -else - -ln -sf ../sphinx_conf/core_conf.py rst/conf.py -endif # Symlink the relevant index into place for building core translated docs gettext_structure: @echo "Creating symlinks in gettext_structure" -ln -sf ../rst/core_index.rst rst/index.rst -ln -sf ../rst/dev_guide/core_index.rst rst/dev_guide/index.rst - -ln -sf ../sphinx_conf/all_conf.py rst/conf.py gettext: gettext_structure gettext_generate_rst - CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx gettext + CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx 'DOCS_VARIANTS=-t all' gettext # if msgcat is installed handle all indexes, otherwise use the index from gettext_structure. -msgcat "$(POTDIR)/core_index.pot" "$(POTDIR)/ansible_index.pot" "$(POTDIR)/2.10_index.pot" > "$(POTDIR)/tmp_index.pot" && mv "$(POTDIR)/tmp_index.pot" "$(POTDIR)/index.pot" rm "$(POTDIR)/core_index.pot" "$(POTDIR)/ansible_index.pot" "$(POTDIR)/2.10_index.pot" @@ -132,24 +123,40 @@ else endif htmldocs: ansible_structure generate_rst - CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx html + if $(PYTHON) -c "import sys, packaging.version as p; sys.exit(not p.Version('$(MAJOR_VERSION)') > p.Version('2.10'))" ; then \ + CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx 'DOCS_VARIANTS=-t ansible' html; \ + else \ + CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx 'DOCS_VARIANTS=-t 2.10' html; \ + fi core_htmldocs: core_structure core_generate_rst - CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx html +ifdef LANGOPTS + CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx 'DOCS_VARIANTS=-t core_lang' html +else + CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx 'DOCS_VARIANTS=-t core' html +endif singlehtmldocs: ansible_structure generate_rst - CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx singlehtml + if $(PYTHON) -c "import sys, packaging.version as p; sys.exit(not p.Version('$(MAJOR_VERSION)') > p.Version('2.10'))" ; then \ + CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx 'DOCS_VARIANTS=-t ansible' singlehtml; \ + else \ + CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx 'DOCS_VARIANTS=-t 2.10' singlehtml; \ + fi core_singlehtmldocs: core_structure core_generate_rst - CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx singlehtml +ifdef LANGOPTS + CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx 'DOCS_VARIANTS=-t core_lang' singlehtml +else + CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx 'DOCS_VARIANTS=-t core' singlehtml +endif # Note: The linkcheckdocs and htmlsingle targets depend on gettext_structure # because that one does not exclude any rst files in its conf.py. linkcheckdocs: gettext_structure generate_rst - CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx linkcheck + CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx 'DOCS_VARIANTS=-t all' linkcheck htmlsingle: assertrst gettext_structure - sphinx-build -j $(CPUS) -b html -d $(BUILDDIR)/doctrees ./rst $(BUILDDIR)/html rst/$(rst) + sphinx-build -j $(CPUS) -b html -t all -d $(BUILDDIR)/doctrees ./rst $(BUILDDIR)/html rst/$(rst) @echo "Output is in $(BUILDDIR)/html/$(rst:.rst=.html)" webdocs: docs diff --git a/docs/docsite/Makefile.sphinx b/docs/docsite/Makefile.sphinx index 3bae705c6d..069bff18b6 100644 --- a/docs/docsite/Makefile.sphinx +++ b/docs/docsite/Makefile.sphinx @@ -2,9 +2,10 @@ # # You can set these variables from the command line. +DOCS_VARIANTS ?= SPHINXCONFDIR = rst LANGOPTS ?= -SPHINXOPTS ?= -j $(CPUS) -n -w rst_warnings -c "$(SPHINXCONFDIR)" $(LANGOPTS) +SPHINXOPTS ?= -j $(CPUS) -n -w rst_warnings -c "$(SPHINXCONFDIR)" $(DOCS_VARIANTS) $(LANGOPTS) SPHINXBUILD = sphinx-build SPHINXPROJ = sdfsdf SOURCEDIR = rst diff --git a/docs/docsite/sphinx_conf/core_lang_conf.py b/docs/docsite/rst/conf.py similarity index 60% rename from docs/docsite/sphinx_conf/core_lang_conf.py rename to docs/docsite/rst/conf.py index 78a4ffdcad..85dab07224 100644 --- a/docs/docsite/sphinx_conf/core_lang_conf.py +++ b/docs/docsite/rst/conf.py @@ -32,7 +32,22 @@ sys.path.insert(0, os.path.join('ansible', 'lib')) # the repository version needs to be the one that is loaded: sys.path.insert(0, os.path.abspath(os.path.join('..', '..', '..', 'lib'))) -VERSION = '2.13_ja' +KNOWN_TAGS = {'all', 'ansible', 'core', 'core_lang', '2.10'} + +applied_tags_count = sum( + int(tags.has(known_tag_name)) for known_tag_name in KNOWN_TAGS +) +assert applied_tags_count == 1, ( + 'Exactly one of the following tags expected: {", ".join(tags)}'. + format(tags=KNOWN_TAGS) +) + +VERSION = ( + '2.13' if tags.has('core_lang') or tags.has('core') else + '6' if tags.has('ansible') or tags.has('all') else + '2.10' if tags.has('2.10') + else '' +) AUTHOR = 'Ansible, Inc' @@ -90,10 +105,12 @@ today_fmt = '%B %d, %Y' # A list of glob-style patterns that should be excluded when looking # for source files. -exclude_patterns = [ +exclude_patterns = [] if tags.has('all') else [ '2.10_index.rst', 'ansible_index.rst', 'core_index.rst', +] +exclude_patterns += [] if tags.has('all') else [ 'network', 'scenario_guides', 'community/collection_contributors/test_index.rst', @@ -138,7 +155,17 @@ exclude_patterns = [ 'roadmap/ROADMAP_2_8.rst', 'roadmap/ROADMAP_2_9.rst', 'roadmap/COLLECTIONS*' -] +] if tags.has('core_lang') or tags.has('core') else [ + 'porting_guides/core_porting_guides', +] if tags.has('ansible') else [ + 'dev_guide/ansible_index.rst', + 'dev_guide/core_index.rst', + 'dev_guide/core_branches_and_tags.rst', + 'porting_guides/core_porting_guides.rst', + 'porting_guides/porting_guide_base_2.10.rst', + 'porting_guides/porting_guide_core_*', + 'roadmap/index.rst', +] if tags.has('2.10') else '' # The reST default role (used for this markup: `text`) to use for all # documents. @@ -202,15 +229,30 @@ html_context = { 'github_cli_repo': 'ansible', 'github_cli_version': 'devel', 'current_version': version, - 'latest_version': '2.15', + 'latest_version': ( + 'devel' if tags.has('all') else + '2.15' if tags.has('core_lang') or tags.has('core') else + '2.10' if tags.has('2.10') else + '8' if tags.has('ansible') + else '' + ), # list specifically out of order to make latest work - 'available_versions': ('2.15_ja', '2.14_ja', '2.13_ja',), + 'available_versions': ( + ('devel',) if tags.has('all') else + ('2.15_ja', '2.14_ja', '2.13_ja',) if tags.has('core_lang') else + ('2.15', '2.14', '2.13', 'devel',) if tags.has('core') else + ('latest', '2.9', '2.9_ja', '2.8', 'devel') if tags.has('2.10') else + ('latest', '2.9', 'devel') if tags.has('ansible') + else '' + ), } # Add extra CSS styles to the resulting HTML pages html_css_files = [ 'css/core-color-scheme.css', -] +] if ( + tags.has('core_lang') or tags.has('core') +) else [] if tags.has('all') or tags.has('2.10') or tags.has('ansible') else [] # The style sheet to use for HTML and HTML Help pages. A file of that name # must exist either in Sphinx' static/ path, or in one of the custom paths @@ -219,7 +261,12 @@ html_css_files = [ # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -html_title = 'Ansible Core Documentation' +html_title = ( + 'Ansible Core Documentation' if ( + tags.has('all') or tags.has('core_lang') or tags.has('core') + ) else 'Ansible Documentation' if tags.has('2.10') or tags.has('ansible') + else '' +) # A shorter title for the navigation bar. Default is the same as html_title. html_short_title = 'Documentation' @@ -303,7 +350,11 @@ notfound_no_urls_prefix = False # (source start file, target name, title, author, document class # [howto/manual]). latex_documents = [ - ('index', 'ansible.tex', 'Ansible Documentation', AUTHOR, 'manual'), + ( + 'index', 'ansible.tex', 'Ansible Documentation', AUTHOR, 'manual', + ) if tags.has('core_lang') else ( + 'index', 'ansible.tex', 'Ansible 2.2 Documentation', AUTHOR, 'manual', + ), ] # The name of an image file (relative to this directory) to place at the top of @@ -333,21 +384,74 @@ autoclass_content = 'both' # name: ('http://UPSTREAM_URL', (None, 'path/to/local/cache.inv')) # # The update script depends on this format so deviating from this (for instance, adding a third -# location for the mappning to live) will confuse it. -intersphinx_mapping = {'python': ('https://docs.python.org/2/', (None, '../python2.inv')), - 'python3': ('https://docs.python.org/3/', (None, '../python3.inv')), - 'jinja2': ('http://jinja.palletsprojects.com/', (None, '../jinja2.inv')), - 'ansible_6': ('https://docs.ansible.com/ansible/6/', (None, '../ansible_6.inv')), - 'ansible_5': ('https://docs.ansible.com/ansible/5/', (None, '../ansible_5.inv')), - 'ansible_4': ('https://docs.ansible.com/ansible/4/', (None, '../ansible_4.inv')), - 'ansible_3': ('https://docs.ansible.com/ansible/3/', (None, '../ansible_3.inv')), - 'ansible_2_10': ('https://docs.ansible.com/ansible/2.10/', (None, '../ansible_2_10.inv')), - 'ansible_2_9': ('https://docs.ansible.com/ansible/2.9/', (None, '../ansible_2_9.inv')), - 'ansible_2_8': ('https://docs.ansible.com/ansible/2.8/', (None, '../ansible_2_8.inv')), - 'ansible_2_7': ('https://docs.ansible.com/ansible/2.7/', (None, '../ansible_2_7.inv')), - 'ansible_2_6': ('https://docs.ansible.com/ansible/2.6/', (None, '../ansible_2_6.inv')), - 'ansible_2_5': ('https://docs.ansible.com/ansible/2.5/', (None, '../ansible_2_5.inv')), - } +# location for the mapping to live) will confuse it. +intersphinx_mapping = { + 'python': ('https://docs.python.org/2/', None, None), + 'python3': ('https://docs.python.org/3/', None, None), + 'jinja2': ('http://jinja.palletsprojects.com/', None, None), + 'ansible_6': ('https://docs.ansible.com/ansible/6/', (None, '../ansible_6.inv')), + 'ansible_5': ('https://docs.ansible.com/ansible/5/', (None, '../ansible_5.inv')), + 'ansible_4': ('https://docs.ansible.com/ansible/4/', (None, '../ansible_4.inv')), + 'ansible_3': ('https://docs.ansible.com/ansible/3/', (None, '../ansible_3.inv')), + 'ansible_2_10': ('https://docs.ansible.com/ansible/2.10/', (None, '../ansible_2_10.inv')), + 'ansible_2_9': ('https://docs.ansible.com/ansible/2.9/', (None, '../ansible_2_9.inv')), + 'ansible_2_8': ('https://docs.ansible.com/ansible/2.8/', (None, '../ansible_2_8.inv')), + 'ansible_2_7': ('https://docs.ansible.com/ansible/2.7/', (None, '../ansible_2_7.inv')), + 'ansible_2_6': ('https://docs.ansible.com/ansible/2.6/', (None, '../ansible_2_6.inv')), + 'ansible_2_5': ('https://docs.ansible.com/ansible/2.5/', (None, '../ansible_2_5.inv')), +} if tags.has('all') else { + 'python': ('https://docs.python.org/2/', None, None), + 'python3': ('https://docs.python.org/3/', None, None), + 'jinja2': ('http://jinja.palletsprojects.com/', None, None), + 'ansible_6': ('https://docs.ansible.com/ansible/6/', (None, '../ansible_6.inv')), + 'ansible_5': ('https://docs.ansible.com/ansible/5/', (None, '../ansible_5.inv')), + 'ansible_4': ('https://docs.ansible.com/ansible/4/', (None, '../ansible_4.inv')), + 'ansible_3': ('https://docs.ansible.com/ansible/3/', (None, '../ansible_3.inv')), + 'ansible_2_10': ('https://docs.ansible.com/ansible/2.10/', (None, '../ansible_2_10.inv')), + 'ansible_2_9': ('https://docs.ansible.com/ansible/2.9/', (None, '../ansible_2_9.inv')), + 'ansible_2_8': ('https://docs.ansible.com/ansible/2.8/', (None, '../ansible_2_8.inv')), + 'ansible_2_7': ('https://docs.ansible.com/ansible/2.7/', (None, '../ansible_2_7.inv')), + 'ansible_2_6': ('https://docs.ansible.com/ansible/2.6/', (None, '../ansible_2_6.inv')), + 'ansible_2_5': ('https://docs.ansible.com/ansible/2.5/', (None, '../ansible_2_5.inv')), +} if tags.has('core_lang') else { + 'python': ('https://docs.python.org/2/', (None, None)), + 'python3': ('https://docs.python.org/3/', (None, None)), + 'jinja2': ('http://jinja.palletsprojects.com/', (None, None)), + 'ansible_6': ('https://docs.ansible.com/ansible/6/', (None, '../ansible_6.inv')), + 'ansible_5': ('https://docs.ansible.com/ansible/5/', (None, '../ansible_5.inv')), + 'ansible_4': ('https://docs.ansible.com/ansible/4/', (None, '../ansible_4.inv')), + 'ansible_3': ('https://docs.ansible.com/ansible/3/', (None, '../ansible_3.inv')), + 'ansible_2_10': ('https://docs.ansible.com/ansible/2.10/', (None, '../ansible_2_10.inv')), + 'ansible_2_9': ('https://docs.ansible.com/ansible/2.9/', (None, '../ansible_2_9.inv')), + 'ansible_2_8': ('https://docs.ansible.com/ansible/2.8/', (None, '../ansible_2_8.inv')), + 'ansible_2_7': ('https://docs.ansible.com/ansible/2.7/', (None, '../ansible_2_7.inv')), + 'ansible_2_6': ('https://docs.ansible.com/ansible/2.6/', (None, '../ansible_2_6.inv')), + 'ansible_2_5': ('https://docs.ansible.com/ansible/2.5/', (None, '../ansible_2_5.inv')), +} if tags.has('core') else { + 'python': ('https://docs.python.org/2/', (None, '../python2.inv')), + 'python3': ('https://docs.python.org/3/', (None, '../python3.inv')), + 'jinja2': ('http://jinja.palletsprojects.com/', (None, '../jinja2.inv')), + 'ansible_2_10': ('https://docs.ansible.com/ansible/2.10/', (None, '../ansible_2_10.inv')), + 'ansible_2_9': ('https://docs.ansible.com/ansible/2.9/', (None, '../ansible_2_9.inv')), + 'ansible_2_8': ('https://docs.ansible.com/ansible/2.8/', (None, '../ansible_2_8.inv')), + 'ansible_2_7': ('https://docs.ansible.com/ansible/2.7/', (None, '../ansible_2_7.inv')), + 'ansible_2_6': ('https://docs.ansible.com/ansible/2.6/', (None, '../ansible_2_6.inv')), + 'ansible_2_5': ('https://docs.ansible.com/ansible/2.5/', (None, '../ansible_2_5.inv')), +} if tags.has('2.10') else { + 'python': ('https://docs.python.org/2/', None, None), + 'python3': ('https://docs.python.org/3/', None, None), + 'jinja2': ('http://jinja.palletsprojects.com/', None, None), + 'ansible_6': ('https://docs.ansible.com/ansible/6/', (None, '../ansible_6.inv')), + 'ansible_5': ('https://docs.ansible.com/ansible/5/', (None, '../ansible_5.inv')), + 'ansible_4': ('https://docs.ansible.com/ansible/4/', (None, '../ansible_4.inv')), + 'ansible_3': ('https://docs.ansible.com/ansible/3/', (None, '../ansible_3.inv')), + 'ansible_2_10': ('https://docs.ansible.com/ansible/2.10/', (None, '../ansible_2_10.inv')), + 'ansible_2_9': ('https://docs.ansible.com/ansible/2.9/', (None, '../ansible_2_9.inv')), + 'ansible_2_8': ('https://docs.ansible.com/ansible/2.8/', (None, '../ansible_2_8.inv')), + 'ansible_2_7': ('https://docs.ansible.com/ansible/2.7/', (None, '../ansible_2_7.inv')), + 'ansible_2_6': ('https://docs.ansible.com/ansible/2.6/', (None, '../ansible_2_6.inv')), + 'ansible_2_5': ('https://docs.ansible.com/ansible/2.5/', (None, '../ansible_2_5.inv')), +} if tags.has('ansible') else {} # linckchecker settings linkcheck_ignore = [ diff --git a/docs/docsite/sphinx_conf/2.10_conf.py b/docs/docsite/sphinx_conf/2.10_conf.py deleted file mode 100644 index 808dd53ec0..0000000000 --- a/docs/docsite/sphinx_conf/2.10_conf.py +++ /dev/null @@ -1,307 +0,0 @@ -# -*- coding: utf-8 -*- -# -# documentation build configuration file, created by -# sphinx-quickstart on Sat Sep 27 13:23:22 2008-2009. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# The contents of this file are pickled, so don't put values in the namespace -# that aren't pickleable (module imports are okay, they're removed -# automatically). -# -# All configuration values have a default value; values that are commented out -# serve to show the default value. - -from __future__ import (absolute_import, division, print_function) -__metaclass__ = type - -import sys -import os - -# If your extensions are in another directory, add it here. If the directory -# is relative to the documentation root, use os.path.abspath to make it -# absolute, like shown here. -# sys.path.append(os.path.abspath('some/directory')) -# -sys.path.insert(0, os.path.join('ansible', 'lib')) - -# We want sphinx to document the ansible modules contained in this repository, -# not those that may happen to be installed in the version -# of Python used to run sphinx. When sphinx loads in order to document, -# the repository version needs to be the one that is loaded: -sys.path.insert(0, os.path.abspath(os.path.join('..', '..', '..', 'lib'))) - -VERSION = '2.10' -AUTHOR = 'Ansible, Inc' - - -# General configuration -# --------------------- - -# Add any Sphinx extension module names here, as strings. -# They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -# TEST: 'sphinxcontrib.fulltoc' -extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', - 'notfound.extension', - 'sphinx_antsibull_ext', # provides CSS for the plugin/module docs generated by antsibull -] - -# Later on, add 'sphinx.ext.viewcode' to the list if you want to have -# colorized code generated too for references. - - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['../.templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The master toctree document. -root_doc = master_doc = 'index' # Sphinx 4+ / 3- - -# General substitutions. -project = 'Ansible' -copyright = "Ansible project contributors" - -# The default replacements for |version| and |release|, also used in various -# other places throughout the built documents. -# -# The short X.Y version. -version = VERSION -# The full version, including alpha/beta/rc tags. -release = VERSION - -# 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 documents that shouldn't be included in the build. -# unused_docs = [] - -# List of directories, relative to source directories, that shouldn't be -# searched for source files. -# exclude_dirs = [] - -# A list of glob-style patterns that should be excluded when looking -# for source files. -exclude_patterns = [ - '2.10_index.rst', - 'ansible_index.rst', - 'core_index.rst', - 'porting_guides/core_porting_guides', -] - -# 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 = 'ansible' - -highlight_language = 'YAML+Jinja' - -# Substitutions, variables, entities, & shortcuts for text which do not need to link to anything. -# For titles which should be a link, use the intersphinx anchors set at the index, chapter, and section levels, such as qi_start_: -# |br| is useful for formatting fields inside of tables -# |_| is a nonbreaking space; similarly useful inside of tables -rst_epilog = """ -.. |br| raw:: html - -
-.. |_| unicode:: 0xA0 - :trim: -""" - - -# Options for HTML output -# ----------------------- - -html_theme_path = [] -html_theme = 'sphinx_ansible_theme' -html_show_sphinx = False - -html_theme_options = { - 'canonical_url': "https://docs.ansible.com/ansible/latest/", - 'hubspot_id': '330046', - 'satellite_tracking': True, - 'show_extranav': True, - 'swift_id': 'yABGvz2N8PwcwBxyfzUc', - 'tag_manager_id': 'GTM-PSB293', - 'vcs_pageview_mode': 'edit' -} - -html_context = { - 'display_github': 'True', - 'show_sphinx': False, - 'is_eol': False, - 'github_user': 'ansible', - 'github_repo': 'ansible-documentation', - 'github_version': 'devel/docs/docsite/rst/', - 'github_module_version': 'devel/lib/ansible/modules/', - 'github_root_dir': 'devel/lib/ansible', - 'github_cli_repo': 'ansible', - 'github_cli_version': 'devel', - 'current_version': version, - 'latest_version': '2.10', - # list specifically out of order to make latest work - 'available_versions': ('latest', '2.9', '2.9_ja', '2.8', 'devel'), -} - -# Add extra CSS styles to the resulting HTML pages -html_css_files = [] - -# The style sheet to use for HTML and HTML Help pages. A file of that name -# must exist either in Sphinx' static/ path, or in one of the custom paths -# given in html_static_path. -# html_style = 'solar.css' - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -html_title = 'Ansible Documentation' - -# A shorter title for the navigation bar. Default is the same as html_title. -html_short_title = 'Documentation' - -# The name of an image file (within the static path) to place at the top of -# the sidebar. -# html_logo = - -# 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 = 'favicon.ico' - -# 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 = {} - -# 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_use_modindex = 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, the reST sources are included in the HTML build as _sources/. -html_copy_source = False - -# 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 = 'https://docs.ansible.com/ansible/latest' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = '' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'Poseidodoc' - -# Configuration for sphinx-notfound-pages -# with no 'notfound_template' and no 'notfound_context' set, -# the extension builds 404.rst into a location-agnostic 404 page -# -# default is `en` - using this for the sub-site: -notfound_default_language = "ansible" -# default is `latest`: -# setting explicitly - docsite serves up /ansible/latest/404.html -# so keep this set to `latest` even on the `devel` branch -# then no maintenance is needed when we branch a new stable_x.x -notfound_default_version = "latest" -# makes default setting explicit: -notfound_no_urls_prefix = False - -# Options for LaTeX output -# ------------------------ - -# The paper size ('letter' or 'a4'). -# latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -# latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, document class -# [howto/manual]). -latex_documents = [ - ('index', 'ansible.tex', 'Ansible 2.2 Documentation', AUTHOR, '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 - -# Additional stuff for the LaTeX preamble. -# latex_preamble = '' - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_use_modindex = True - -autoclass_content = 'both' - -# Note: Our strategy for intersphinx mappings is to have the upstream build location as the -# canonical source and then cached copies of the mapping stored locally in case someone is building -# when disconnected from the internet. We then have a script to update the cached copies. -# -# Because of that, each entry in this mapping should have this format: -# name: ('http://UPSTREAM_URL', (None, 'path/to/local/cache.inv')) -# -# The update script depends on this format so deviating from this (for instance, adding a third -# location for the mappning to live) will confuse it. -intersphinx_mapping = {'python': ('https://docs.python.org/2/', (None, '../python2.inv')), - 'python3': ('https://docs.python.org/3/', (None, '../python3.inv')), - 'jinja2': ('http://jinja.palletsprojects.com/', (None, '../jinja2.inv')), - 'ansible_2_10': ('https://docs.ansible.com/ansible/2.10/', (None, '../ansible_2_10.inv')), - 'ansible_2_9': ('https://docs.ansible.com/ansible/2.9/', (None, '../ansible_2_9.inv')), - 'ansible_2_8': ('https://docs.ansible.com/ansible/2.8/', (None, '../ansible_2_8.inv')), - 'ansible_2_7': ('https://docs.ansible.com/ansible/2.7/', (None, '../ansible_2_7.inv')), - 'ansible_2_6': ('https://docs.ansible.com/ansible/2.6/', (None, '../ansible_2_6.inv')), - 'ansible_2_5': ('https://docs.ansible.com/ansible/2.5/', (None, '../ansible_2_5.inv')), - } - -# linckchecker settings -linkcheck_ignore = [ -] -linkcheck_workers = 25 -# linkcheck_anchors = False diff --git a/docs/docsite/sphinx_conf/all_conf.py b/docs/docsite/sphinx_conf/all_conf.py deleted file mode 100644 index ffba97ffe6..0000000000 --- a/docs/docsite/sphinx_conf/all_conf.py +++ /dev/null @@ -1,307 +0,0 @@ -# -*- coding: utf-8 -*- -# -# documentation build configuration file, created by -# sphinx-quickstart on Sat Sep 27 13:23:22 2008-2009. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# The contents of this file are pickled, so don't put values in the namespace -# that aren't pickleable (module imports are okay, they're removed -# automatically). -# -# All configuration values have a default value; values that are commented out -# serve to show the default value. - -from __future__ import (absolute_import, division, print_function) -__metaclass__ = type - -import sys -import os - -# If your extensions are in another directory, add it here. If the directory -# is relative to the documentation root, use os.path.abspath to make it -# absolute, like shown here. -# sys.path.append(os.path.abspath('some/directory')) -# -sys.path.insert(0, os.path.join('ansible', 'lib')) - -# We want sphinx to document the ansible modules contained in this repository, -# not those that may happen to be installed in the version -# of Python used to run sphinx. When sphinx loads in order to document, -# the repository version needs to be the one that is loaded: -sys.path.insert(0, os.path.abspath(os.path.join('..', '..', '..', 'lib'))) - -VERSION = 'devel' -AUTHOR = 'Ansible, Inc' - - -# General configuration -# --------------------- - -# Add any Sphinx extension module names here, as strings. -# They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -# TEST: 'sphinxcontrib.fulltoc' -extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', - 'notfound.extension', - 'sphinx_antsibull_ext', # provides CSS for the plugin/module docs generated by antsibull -] - -# Later on, add 'sphinx.ext.viewcode' to the list if you want to have -# colorized code generated too for references. - - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['../.templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The master toctree document. -root_doc = master_doc = 'index' # Sphinx 4+ / 3- - -# General substitutions. -project = 'Ansible' -copyright = "Ansible project contributors" - -# The default replacements for |version| and |release|, also used in various -# other places throughout the built documents. -# -# The short X.Y version. -version = VERSION -# The full version, including alpha/beta/rc tags. -release = VERSION - -# 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 documents that shouldn't be included in the build. -# unused_docs = [] - -# List of directories, relative to source directories, that shouldn't be -# searched for source files. -# exclude_dirs = [] - -# A list of glob-style patterns that should be excluded 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 = 'ansible' - -highlight_language = 'YAML+Jinja' - -# Substitutions, variables, entities, & shortcuts for text which do not need to link to anything. -# For titles which should be a link, use the intersphinx anchors set at the index, chapter, and section levels, such as qi_start_: -# |br| is useful for formatting fields inside of tables -# |_| is a nonbreaking space; similarly useful inside of tables -rst_epilog = """ -.. |br| raw:: html - -
-.. |_| unicode:: 0xA0 - :trim: -""" - - -# Options for HTML output -# ----------------------- - -html_theme_path = [] -html_theme = 'sphinx_ansible_theme' -html_show_sphinx = False - -html_theme_options = { - 'canonical_url': "https://docs.ansible.com/ansible/latest/", - 'hubspot_id': '330046', - 'satellite_tracking': True, - 'show_extranav': True, - 'swift_id': 'yABGvz2N8PwcwBxyfzUc', - 'tag_manager_id': 'GTM-PSB293', - 'vcs_pageview_mode': 'edit' -} - -html_context = { - 'display_github': 'True', - 'show_sphinx': False, - 'is_eol': False, - 'github_user': 'ansible', - 'github_repo': 'ansible-documentation', - 'github_version': 'devel/docs/docsite/rst/', - 'github_module_version': 'devel/lib/ansible/modules/', - 'github_root_dir': 'devel/lib/ansible', - 'github_cli_repo': 'ansible', - 'github_cli_version': 'devel', - 'current_version': version, - 'latest_version': 'devel', - # list specifically out of order to make latest work - 'available_versions': ('devel',), -} - -# Add extra CSS styles to the resulting HTML pages -html_css_files = [] - -# The style sheet to use for HTML and HTML Help pages. A file of that name -# must exist either in Sphinx' static/ path, or in one of the custom paths -# given in html_static_path. -# html_style = 'solar.css' - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -html_title = 'Ansible Core Documentation' - -# A shorter title for the navigation bar. Default is the same as html_title. -html_short_title = 'Documentation' - -# The name of an image file (within the static path) to place at the top of -# the sidebar. -# html_logo = - -# 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 = 'favicon.ico' - -# 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 = {} - -# 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_use_modindex = 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, the reST sources are included in the HTML build as _sources/. -html_copy_source = False - -# 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 = 'https://docs.ansible.com/ansible/latest' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = '' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'Poseidodoc' - -# Configuration for sphinx-notfound-pages -# with no 'notfound_template' and no 'notfound_context' set, -# the extension builds 404.rst into a location-agnostic 404 page -# -# default is `en` - using this for the sub-site: -notfound_default_language = "ansible" -# default is `latest`: -# setting explicitly - docsite serves up /ansible/latest/404.html -# so keep this set to `latest` even on the `devel` branch -# then no maintenance is needed when we branch a new stable_x.x -notfound_default_version = "latest" -# makes default setting explicit: -notfound_no_urls_prefix = False - -# Options for LaTeX output -# ------------------------ - -# The paper size ('letter' or 'a4'). -# latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -# latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, document class -# [howto/manual]). -latex_documents = [ - ('index', 'ansible.tex', 'Ansible 2.2 Documentation', AUTHOR, '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 - -# Additional stuff for the LaTeX preamble. -# latex_preamble = '' - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_use_modindex = True - -autoclass_content = 'both' - -# Note: Our strategy for intersphinx mappings is to have the upstream build location as the -# canonical source and then cached copies of the mapping stored locally in case someone is building -# when disconnected from the internet. We then have a script to update the cached copies. -# -# Because of that, each entry in this mapping should have this format: -# name: ('http://UPSTREAM_URL', (None, 'path/to/local/cache.inv')) -# -# The update script depends on this format so deviating from this (for instance, adding a third -# location for the mappning to live) will confuse it. -intersphinx_mapping = {'python': ('https://docs.python.org/2/', (None, '../python2.inv')), - 'python3': ('https://docs.python.org/3/', (None, '../python3.inv')), - 'jinja2': ('http://jinja.palletsprojects.com/', (None, '../jinja2.inv')), - 'ansible_6': ('https://docs.ansible.com/ansible/6/', (None, '../ansible_6.inv')), - 'ansible_5': ('https://docs.ansible.com/ansible/5/', (None, '../ansible_5.inv')), - 'ansible_4': ('https://docs.ansible.com/ansible/4/', (None, '../ansible_4.inv')), - 'ansible_3': ('https://docs.ansible.com/ansible/3/', (None, '../ansible_3.inv')), - 'ansible_2_10': ('https://docs.ansible.com/ansible/2.10/', (None, '../ansible_2_10.inv')), - 'ansible_2_9': ('https://docs.ansible.com/ansible/2.9/', (None, '../ansible_2_9.inv')), - 'ansible_2_8': ('https://docs.ansible.com/ansible/2.8/', (None, '../ansible_2_8.inv')), - 'ansible_2_7': ('https://docs.ansible.com/ansible/2.7/', (None, '../ansible_2_7.inv')), - 'ansible_2_6': ('https://docs.ansible.com/ansible/2.6/', (None, '../ansible_2_6.inv')), - 'ansible_2_5': ('https://docs.ansible.com/ansible/2.5/', (None, '../ansible_2_5.inv')), - } - -# linckchecker settings -linkcheck_ignore = [ -] -linkcheck_workers = 25 -# linkcheck_anchors = False diff --git a/docs/docsite/sphinx_conf/ansible_conf.py b/docs/docsite/sphinx_conf/ansible_conf.py deleted file mode 100644 index 079ca8d511..0000000000 --- a/docs/docsite/sphinx_conf/ansible_conf.py +++ /dev/null @@ -1,317 +0,0 @@ -# -*- coding: utf-8 -*- -# -# documentation build configuration file, created by -# sphinx-quickstart on Sat Sep 27 13:23:22 2008-2009. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# The contents of this file are pickled, so don't put values in the namespace -# that aren't pickleable (module imports are okay, they're removed -# automatically). -# -# All configuration values have a default value; values that are commented out -# serve to show the default value. - -from __future__ import (absolute_import, division, print_function) -__metaclass__ = type - -import sys -import os - -# If your extensions are in another directory, add it here. If the directory -# is relative to the documentation root, use os.path.abspath to make it -# absolute, like shown here. -# sys.path.append(os.path.abspath('some/directory')) -# -sys.path.insert(0, os.path.join('ansible', 'lib')) - -# We want sphinx to document the ansible modules contained in this repository, -# not those that may happen to be installed in the version -# of Python used to run sphinx. When sphinx loads in order to document, -# the repository version needs to be the one that is loaded: -sys.path.insert(0, os.path.abspath(os.path.join('..', '..', '..', 'lib'))) - -VERSION = '6' -AUTHOR = 'Ansible, Inc' - - -# General configuration -# --------------------- - -# Add any Sphinx extension module names here, as strings. -# They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -# TEST: 'sphinxcontrib.fulltoc' -extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', - 'notfound.extension', - 'sphinx_antsibull_ext', # provides CSS for the plugin/module docs generated by antsibull -] - -# Later on, add 'sphinx.ext.viewcode' to the list if you want to have -# colorized code generated too for references. - - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['../.templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The master toctree document. -root_doc = master_doc = 'index' # Sphinx 4+ / 3- - -# General substitutions. -project = 'Ansible' -copyright = "Ansible project contributors" - -# The default replacements for |version| and |release|, also used in various -# other places throughout the built documents. -# -# The short X.Y version. -version = VERSION -# The full version, including alpha/beta/rc tags. -release = VERSION - -# 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 documents that shouldn't be included in the build. -# unused_docs = [] - -# List of directories, relative to source directories, that shouldn't be -# searched for source files. -# exclude_dirs = [] - -# A list of glob-style patterns that should be excluded when looking -# for source files. -exclude_patterns = [ - '2.10_index.rst', - 'ansible_index.rst', - 'core_index.rst', - 'dev_guide/ansible_index.rst', - 'dev_guide/core_index.rst', - 'dev_guide/core_branches_and_tags.rst', - 'porting_guides/core_porting_guides.rst', - 'porting_guides/porting_guide_base_2.10.rst', - 'porting_guides/porting_guide_core_*', - 'roadmap/index.rst', -] - -# 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 = 'ansible' - -highlight_language = 'YAML+Jinja' - -# Substitutions, variables, entities, & shortcuts for text which do not need to link to anything. -# For titles which should be a link, use the intersphinx anchors set at the index, chapter, and section levels, such as qi_start_: -# |br| is useful for formatting fields inside of tables -# |_| is a nonbreaking space; similarly useful inside of tables -rst_epilog = """ -.. |br| raw:: html - -
-.. |_| unicode:: 0xA0 - :trim: -""" - - -# Options for HTML output -# ----------------------- - -html_theme_path = [] -html_theme = 'sphinx_ansible_theme' -html_show_sphinx = False - -html_theme_options = { - 'canonical_url': "https://docs.ansible.com/ansible/latest/", - 'hubspot_id': '330046', - 'satellite_tracking': True, - 'show_extranav': True, - 'swift_id': 'yABGvz2N8PwcwBxyfzUc', - 'tag_manager_id': 'GTM-PSB293', - 'vcs_pageview_mode': 'edit' -} - -html_context = { - 'display_github': 'True', - 'show_sphinx': False, - 'is_eol': True, - 'github_user': 'ansible', - 'github_repo': 'ansible-documentation', - 'github_version': 'devel/docs/docsite/rst/', - 'github_module_version': 'devel/lib/ansible/modules/', - 'github_root_dir': 'devel/lib/ansible', - 'github_cli_repo': 'ansible', - 'github_cli_version': 'devel', - 'current_version': version, - 'latest_version': '6', - # list specifically out of order to make latest work - 'available_versions': ('latest', '2.9', 'devel'), -} - -# Add extra CSS styles to the resulting HTML pages -html_css_files = [] - -# The style sheet to use for HTML and HTML Help pages. A file of that name -# must exist either in Sphinx' static/ path, or in one of the custom paths -# given in html_static_path. -# html_style = 'solar.css' - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -html_title = 'Ansible Documentation' - -# A shorter title for the navigation bar. Default is the same as html_title. -html_short_title = 'Documentation' - -# The name of an image file (within the static path) to place at the top of -# the sidebar. -# html_logo = - -# 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 = 'favicon.ico' - -# 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 = {} - -# 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_use_modindex = 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, the reST sources are included in the HTML build as _sources/. -html_copy_source = False - -# 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 = 'https://docs.ansible.com/ansible/latest' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = '' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'Poseidodoc' - -# Configuration for sphinx-notfound-pages -# with no 'notfound_template' and no 'notfound_context' set, -# the extension builds 404.rst into a location-agnostic 404 page -# -# default is `en` - using this for the sub-site: -notfound_default_language = "ansible" -# default is `latest`: -# setting explicitly - docsite serves up /ansible/latest/404.html -# so keep this set to `latest` even on the `devel` branch -# then no maintenance is needed when we branch a new stable_x.x -notfound_default_version = "latest" -# makes default setting explicit: -notfound_no_urls_prefix = False - -# Options for LaTeX output -# ------------------------ - -# The paper size ('letter' or 'a4'). -# latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -# latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, document class -# [howto/manual]). -latex_documents = [ - ('index', 'ansible.tex', 'Ansible 2.2 Documentation', AUTHOR, '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 - -# Additional stuff for the LaTeX preamble. -# latex_preamble = '' - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_use_modindex = True - -autoclass_content = 'both' - -# Note: Our strategy for intersphinx mappings is to have the upstream build location as the -# canonical source and then cached copies of the mapping stored locally in case someone is building -# when disconnected from the internet. We then have a script to update the cached copies. -# -# Because of that, each entry in this mapping should have this format: -# name: ('http://UPSTREAM_URL', (None, 'path/to/local/cache.inv')) -# -# The update script depends on this format so deviating from this (for instance, adding a third -# location for the mappning to live) will confuse it. -intersphinx_mapping = {'python': ('https://docs.python.org/2/', (None, '../python2.inv')), - 'python3': ('https://docs.python.org/3/', (None, '../python3.inv')), - 'jinja2': ('http://jinja.palletsprojects.com/', (None, '../jinja2.inv')), - 'ansible_6': ('https://docs.ansible.com/ansible/6/', (None, '../ansible_6.inv')), - 'ansible_5': ('https://docs.ansible.com/ansible/5/', (None, '../ansible_5.inv')), - 'ansible_4': ('https://docs.ansible.com/ansible/4/', (None, '../ansible_4.inv')), - 'ansible_3': ('https://docs.ansible.com/ansible/3/', (None, '../ansible_3.inv')), - 'ansible_2_10': ('https://docs.ansible.com/ansible/2.10/', (None, '../ansible_2_10.inv')), - 'ansible_2_9': ('https://docs.ansible.com/ansible/2.9/', (None, '../ansible_2_9.inv')), - 'ansible_2_8': ('https://docs.ansible.com/ansible/2.8/', (None, '../ansible_2_8.inv')), - 'ansible_2_7': ('https://docs.ansible.com/ansible/2.7/', (None, '../ansible_2_7.inv')), - 'ansible_2_6': ('https://docs.ansible.com/ansible/2.6/', (None, '../ansible_2_6.inv')), - 'ansible_2_5': ('https://docs.ansible.com/ansible/2.5/', (None, '../ansible_2_5.inv')), - } - -# linckchecker settings -linkcheck_ignore = [ -] -linkcheck_workers = 25 -# linkcheck_anchors = False diff --git a/docs/docsite/sphinx_conf/core_conf.py b/docs/docsite/sphinx_conf/core_conf.py deleted file mode 100644 index 980bd57eda..0000000000 --- a/docs/docsite/sphinx_conf/core_conf.py +++ /dev/null @@ -1,356 +0,0 @@ -# -*- coding: utf-8 -*- -# -# documentation build configuration file, created by -# sphinx-quickstart on Sat Sep 27 13:23:22 2008-2009. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# The contents of this file are pickled, so don't put values in the namespace -# that aren't pickleable (module imports are okay, they're removed -# automatically). -# -# All configuration values have a default value; values that are commented out -# serve to show the default value. - -from __future__ import (absolute_import, division, print_function) -__metaclass__ = type - -import sys -import os - -# If your extensions are in another directory, add it here. If the directory -# is relative to the documentation root, use os.path.abspath to make it -# absolute, like shown here. -# sys.path.append(os.path.abspath('some/directory')) -# -sys.path.insert(0, os.path.join('ansible', 'lib')) - -# We want sphinx to document the ansible modules contained in this repository, -# not those that may happen to be installed in the version -# of Python used to run sphinx. When sphinx loads in order to document, -# the repository version needs to be the one that is loaded: -sys.path.insert(0, os.path.abspath(os.path.join('..', '..', '..', 'lib'))) - -VERSION = '2.13' -AUTHOR = 'Ansible, Inc' - - -# General configuration -# --------------------- - -# Add any Sphinx extension module names here, as strings. -# They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -# TEST: 'sphinxcontrib.fulltoc' -extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', - 'notfound.extension', - 'sphinx_antsibull_ext', # provides CSS for the plugin/module docs generated by antsibull -] - -# Later on, add 'sphinx.ext.viewcode' to the list if you want to have -# colorized code generated too for references. - - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['../.templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The master toctree document. -root_doc = master_doc = 'index' # Sphinx 4+ / 3- - -# General substitutions. -project = 'Ansible' -copyright = "Ansible project contributors" - -# The default replacements for |version| and |release|, also used in various -# other places throughout the built documents. -# -# The short X.Y version. -version = VERSION -# The full version, including alpha/beta/rc tags. -release = VERSION - -# 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 documents that shouldn't be included in the build. -# unused_docs = [] - -# List of directories, relative to source directories, that shouldn't be -# searched for source files. -# exclude_dirs = [] - -# A list of glob-style patterns that should be excluded when looking -# for source files. -exclude_patterns = [ - '2.10_index.rst', - 'ansible_index.rst', - 'core_index.rst', - 'network', - 'scenario_guides', - 'community/collection_contributors/test_index.rst', - 'community/collection_contributors/collection_integration_about.rst', - 'community/collection_contributors/collection_integration_updating.rst', - 'community/collection_contributors/collection_integration_add.rst', - 'community/collection_contributors/collection_test_pr_locally.rst', - 'community/collection_contributors/collection_integration_tests.rst', - 'community/collection_contributors/collection_integration_running.rst', - 'community/collection_contributors/collection_reviewing.rst', - 'community/collection_contributors/collection_unit_tests.rst', - 'community/maintainers.rst', - 'community/contributions_collections.rst', - 'community/create_pr_quick_start.rst', - 'community/reporting_collections.rst', - 'community/contributing_maintained_collections.rst', - 'community/collection_development_process.rst', - 'community/collection_contributors/collection_release_without_branches.rst', - 'community/collection_contributors/collection_release_with_branches.rst', - 'community/collection_contributors/collection_releasing.rst', - 'community/maintainers_guidelines.rst', - 'community/maintainers_workflow.rst', - 'community/steering/community_steering_committee.rst', - 'community/steering/steering_committee_membership.rst', - 'community/steering/steering_committee_past_members.rst', - 'community/steering/steering_index.rst', - 'dev_guide/ansible_index.rst', - 'dev_guide/core_index.rst', - 'dev_guide/platforms/aws_guidelines.rst', - 'dev_guide/platforms/openstack_guidelines.rst', - 'dev_guide/platforms/ovirt_dev_guide.rst', - 'dev_guide/platforms/vmware_guidelines.rst', - 'dev_guide/platforms/vmware_rest_guidelines.rst', - 'porting_guides/porting_guides.rst', - 'porting_guides/porting_guide_[1-9]*', - 'roadmap/index.rst', - 'roadmap/ansible_roadmap_index.rst', - 'roadmap/old_roadmap_index.rst', - 'roadmap/ROADMAP_2_5.rst', - 'roadmap/ROADMAP_2_6.rst', - 'roadmap/ROADMAP_2_7.rst', - 'roadmap/ROADMAP_2_8.rst', - 'roadmap/ROADMAP_2_9.rst', - 'roadmap/COLLECTIONS*' -] - -# 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 = 'ansible' - -highlight_language = 'YAML+Jinja' - -# Substitutions, variables, entities, & shortcuts for text which do not need to link to anything. -# For titles which should be a link, use the intersphinx anchors set at the index, chapter, and section levels, such as qi_start_: -# |br| is useful for formatting fields inside of tables -# |_| is a nonbreaking space; similarly useful inside of tables -rst_epilog = """ -.. |br| raw:: html - -
-.. |_| unicode:: 0xA0 - :trim: -""" - - -# Options for HTML output -# ----------------------- - -html_theme_path = [] -html_theme = 'sphinx_ansible_theme' -html_show_sphinx = False - -html_theme_options = { - 'canonical_url': "https://docs.ansible.com/ansible/latest/", - 'hubspot_id': '330046', - 'satellite_tracking': True, - 'show_extranav': True, - 'swift_id': 'yABGvz2N8PwcwBxyfzUc', - 'tag_manager_id': 'GTM-PSB293', - 'vcs_pageview_mode': 'edit' -} - -html_context = { - 'display_github': 'True', - 'show_sphinx': False, - 'is_eol': False, - 'github_user': 'ansible', - 'github_repo': 'ansible-documentation', - 'github_version': 'devel/docs/docsite/rst/', - 'github_module_version': 'devel/lib/ansible/modules/', - 'github_root_dir': 'devel/lib/ansible', - 'github_cli_repo': 'ansible', - 'github_cli_version': 'devel', - 'current_version': version, - 'latest_version': '2.15', - # list specifically out of order to make latest work - 'available_versions': ('2.15', '2.14', '2.13', 'devel',), -} - -# Add extra CSS styles to the resulting HTML pages -html_css_files = [ - 'css/core-color-scheme.css', -] - -# The style sheet to use for HTML and HTML Help pages. A file of that name -# must exist either in Sphinx' static/ path, or in one of the custom paths -# given in html_static_path. -# html_style = 'solar.css' - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -html_title = 'Ansible Core Documentation' - -# A shorter title for the navigation bar. Default is the same as html_title. -html_short_title = 'Documentation' - -# The name of an image file (within the static path) to place at the top of -# the sidebar. -# html_logo = - -# 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 = 'favicon.ico' - -# 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 = {} - -# 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_use_modindex = 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, the reST sources are included in the HTML build as _sources/. -html_copy_source = False - -# 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 = 'https://docs.ansible.com/ansible/latest' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = '' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'Poseidodoc' - -# Configuration for sphinx-notfound-pages -# with no 'notfound_template' and no 'notfound_context' set, -# the extension builds 404.rst into a location-agnostic 404 page -# -# default is `en` - using this for the sub-site: -notfound_default_language = "ansible" -# default is `latest`: -# setting explicitly - docsite serves up /ansible/latest/404.html -# so keep this set to `latest` even on the `devel` branch -# then no maintenance is needed when we branch a new stable_x.x -notfound_default_version = "latest" -# makes default setting explicit: -notfound_no_urls_prefix = False - -# Options for LaTeX output -# ------------------------ - -# The paper size ('letter' or 'a4'). -# latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -# latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, document class -# [howto/manual]). -latex_documents = [ - ('index', 'ansible.tex', 'Ansible 2.2 Documentation', AUTHOR, '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 - -# Additional stuff for the LaTeX preamble. -# latex_preamble = '' - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_use_modindex = True - -autoclass_content = 'both' - -# Note: Our strategy for intersphinx mappings is to have the upstream build location as the -# canonical source and then cached copies of the mapping stored locally in case someone is building -# when disconnected from the internet. We then have a script to update the cached copies. -# -# Because of that, each entry in this mapping should have this format: -# name: ('http://UPSTREAM_URL', (None, 'path/to/local/cache.inv')) -# -# The update script depends on this format so deviating from this (for instance, adding a third -# location for the mappning to live) will confuse it. -intersphinx_mapping = {'python': ('https://docs.python.org/2/', (None, '../python2.inv')), - 'python3': ('https://docs.python.org/3/', (None, '../python3.inv')), - 'jinja2': ('http://jinja.palletsprojects.com/', (None, '../jinja2.inv')), - 'ansible_6': ('https://docs.ansible.com/ansible/6/', (None, '../ansible_6.inv')), - 'ansible_5': ('https://docs.ansible.com/ansible/5/', (None, '../ansible_5.inv')), - 'ansible_4': ('https://docs.ansible.com/ansible/4/', (None, '../ansible_4.inv')), - 'ansible_3': ('https://docs.ansible.com/ansible/3/', (None, '../ansible_3.inv')), - 'ansible_2_10': ('https://docs.ansible.com/ansible/2.10/', (None, '../ansible_2_10.inv')), - 'ansible_2_9': ('https://docs.ansible.com/ansible/2.9/', (None, '../ansible_2_9.inv')), - 'ansible_2_8': ('https://docs.ansible.com/ansible/2.8/', (None, '../ansible_2_8.inv')), - 'ansible_2_7': ('https://docs.ansible.com/ansible/2.7/', (None, '../ansible_2_7.inv')), - 'ansible_2_6': ('https://docs.ansible.com/ansible/2.6/', (None, '../ansible_2_6.inv')), - 'ansible_2_5': ('https://docs.ansible.com/ansible/2.5/', (None, '../ansible_2_5.inv')), - } - -# linckchecker settings -linkcheck_ignore = [ -] -linkcheck_workers = 25 -# linkcheck_anchors = False