mirror of
https://github.com/ansible/awx.git
synced 2026-01-09 23:12:08 -03:30
8c4be1c529
* Update docs replacements to AWX (#15349) Update replacements to AWX Signed-off-by: Sandra McCann <samccann@redhat.com> (cherry picked from commit 9979fc659efbf4d54a39f9f36912d5ed7b0fa6cd) * Remove remnants of controller terms from quickstart docs (#15350) Remove remnants of controller terms from quickstart Signed-off-by: Sandra McCann <samccann@redhat.com> (cherry picked from commit 864a30e3d451e6daf39421a598f725419f105101) * Remove references to translated versions of the docs (#15354) remove references to translated versions of the docs Signed-off-by: Sandra McCann <samccann@redhat.com> Co-authored-by: TVo <thavo@redhat.com> (cherry picked from commit 5f42db67e6fbcffa8e5b26553d41273b7730344c) * update terminology (#15357) * update terminology Replace some instances of Tower with AWX and remove some references to enterprise left over from the migration of RST content from the Automation Controller docs. * Update docs/docsite/rst/userguide/overview.rst Co-authored-by: TVo <thavo@redhat.com> --------- Co-authored-by: TVo <thavo@redhat.com> (cherry picked from commit f1448fced1411b9d7cce19a0ad91df992e447014) * Replaced all references of downstream docs to upstream docs (#15388) * Replaced all references of downstream docs to upstream docs. * Update README.md Co-authored-by: Don Naro <dnaro@redhat.com> * Update README.md.j2 Co-authored-by: Don Naro <dnaro@redhat.com> * Update README.md.j2 Co-authored-by: Don Naro <dnaro@redhat.com> * Incorpor'd review feedback from @oraNod and @samccann * Updated with agreed link (for now) until further change is needed. --------- Co-authored-by: Don Naro <dnaro@redhat.com> (cherry picked from commit 018f235a645163ee820ff33b47a70194fabeea66) * Re-do PR #14685 for alt-text inventories. (#15394) (cherry picked from commit 6d0c47fdd0f0ca00c06afb5db5bd49c8da995a50) * Docs: add Communication guide (#15469) * Docs: add Communication guide * Update docs/docsite/rst/contributor/communication.rst Co-authored-by: Don Naro <dnaro@redhat.com> * Update docs/docsite/rst/contributor/communication.rst --------- Co-authored-by: Don Naro <dnaro@redhat.com> (cherry picked from commit 79c1921ea480ae26b0d7faf6e1a8e89b61f76c30) --------- Co-authored-by: Don Naro <dnaro@redhat.com> Co-authored-by: TVo <thavo@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
96 lines
2.6 KiB
Python
96 lines
2.6 KiB
Python
import sys
|
|
import os
|
|
import shlex
|
|
|
|
from datetime import datetime
|
|
from importlib import import_module
|
|
|
|
sys.path.insert(0, os.path.abspath('./rst/rest_api/_swagger'))
|
|
|
|
project = u'Ansible AWX'
|
|
copyright = u'2023, Red Hat'
|
|
author = u'Red Hat'
|
|
|
|
pubdateshort = '2023-08-04'
|
|
pubdate = datetime.strptime(pubdateshort, '%Y-%m-%d').strftime('%B %d, %Y')
|
|
|
|
# The name for this set of Sphinx documents. If None, it defaults to
|
|
# "<project> v<release> documentation".
|
|
# html_title = None
|
|
html_title = 'Ansible AWX community documentation'
|
|
|
|
# A shorter title for the navigation bar. Default is the same as html_title.
|
|
# html_short_title = None
|
|
html_short_title = 'AWX community documentation'
|
|
|
|
htmlhelp_basename = 'AWX_docs'
|
|
|
|
# include the swagger extension to build rest api reference
|
|
#'swagger',
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.doctest',
|
|
'sphinx.ext.intersphinx',
|
|
'sphinx.ext.todo',
|
|
'sphinx.ext.coverage',
|
|
'sphinx.ext.ifconfig',
|
|
'sphinx_ansible_theme',
|
|
'swagger',
|
|
]
|
|
|
|
html_theme = 'sphinx_ansible_theme'
|
|
html_theme_path = ["_static"]
|
|
|
|
pygments_style = "ansible"
|
|
highlight_language = "YAML+Jinja"
|
|
|
|
source_suffix = '.rst'
|
|
master_doc = 'index'
|
|
|
|
version = 'latest'
|
|
shortversion = 'latest'
|
|
# The full version, including alpha/beta/rc tags.
|
|
release = 'AWX latest'
|
|
|
|
language = 'en'
|
|
|
|
locale_dirs = ['locale/'] # path is example but recommended.
|
|
gettext_compact = False # optional.
|
|
|
|
rst_epilog = """
|
|
.. |atqi| replace:: *AWX Quick Installation Guide*
|
|
.. |atqs| replace:: *AWX Quick Setup Guide*
|
|
.. |atir| replace:: *AWX Installation and Reference Guide*
|
|
.. |ata| replace:: *AWX Administration Guide*
|
|
.. |atu| replace:: *AWX User Guide*
|
|
.. |atumg| replace:: *AWX Upgrade and Migration Guide*
|
|
.. |atapi| replace:: *AWX API Guide*
|
|
.. |atrn| replace:: *AWX Release Notes*
|
|
.. |aa| replace:: Ansible Automation
|
|
.. |AA| replace:: Automation Analytics
|
|
.. |aap| replace:: Ansible Automation Platform
|
|
.. |ab| replace:: ansible-builder
|
|
.. |ap| replace:: Automation Platform
|
|
.. |at| replace:: AWX
|
|
.. |At| replace:: AWX
|
|
.. |ah| replace:: Automation Hub
|
|
.. |EE| replace:: Execution Environment
|
|
.. |EEs| replace:: Execution Environments
|
|
.. |Ee| replace:: Execution environment
|
|
.. |Ees| replace:: Execution environments
|
|
.. |ee| replace:: execution environment
|
|
.. |ees| replace:: execution environments
|
|
.. |versionshortest| replace:: v%s
|
|
.. |pubdateshort| replace:: %s
|
|
.. |pubdate| replace:: %s
|
|
.. |rhel| replace:: Red Hat Enterprise Linux
|
|
.. |rhaa| replace:: Red Hat Ansible Automation
|
|
.. |rhaap| replace:: Red Hat Ansible Automation Platform
|
|
.. |RHAT| replace:: Red Hat Ansible Automation Platform controller
|
|
|
|
""" % (
|
|
version,
|
|
pubdateshort,
|
|
pubdate,
|
|
)
|