mirror of
https://github.com/ansible/awx.git
synced 2026-02-04 11:08:13 -03:30
Create AWX docsite with RST content (#14328)
Co-authored-by: Thanhnguyet Vo <tvo@ansible.com> Co-authored-by: TVo <thavo@redhat.com>
This commit is contained in:
90
docs/docsite/conf.py
Normal file
90
docs/docsite/conf.py
Normal file
@@ -0,0 +1,90 @@
|
||||
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',
|
||||
]
|
||||
|
||||
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:: automation controller
|
||||
.. |At| replace:: Automation controller
|
||||
.. |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)
|
||||
Reference in New Issue
Block a user