Use antsibull sphinx extension (#73170)

* Use antsibull sphinx extension.

* Require antsibull 0.34.0.
pull/75078/head
Felix Fontein 3 years ago committed by GitHub
parent 58f26388be
commit 2c0f050b4f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -1,7 +1,7 @@
# pip packages required to build docsite
# tested June 9 2021
antsibull==0.33.0
antsibull==0.34.0
docutils==0.16
# check unordered lists when testing more recent docutils versions
# see https://github.com/readthedocs/sphinx_rtd_theme/issues/1115

@ -3,7 +3,7 @@
# if you want known good versions of these dependencies
# use known_good_reqs.txt instead
antsibull >= 0.25.0
antsibull >= 0.34.0
docutils == 0.16 # pin for now until the problem with unordered lists is fixed
# see https://github.com/readthedocs/sphinx_rtd_theme/issues/1115jinja2==3.0.1
jinja2

@ -43,7 +43,12 @@ AUTHOR = 'Ansible, Inc'
# 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']
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.

@ -43,7 +43,12 @@ AUTHOR = 'Ansible, Inc'
# 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']
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.

@ -43,7 +43,12 @@ AUTHOR = 'Ansible, Inc'
# 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']
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.

@ -43,7 +43,12 @@ AUTHOR = 'Ansible, Inc'
# 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']
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.

Loading…
Cancel
Save