summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFelix Fontein <felix@fontein.de>2021-06-29 17:23:50 +0200
committerGitHub <noreply@github.com>2021-06-29 10:23:50 -0500
commit49950fa875a9d7f98d1824dfcc78a850de36326e (patch)
treeb61e52e02610b5dcb705088e5ed5c9f174d40749 /docs
parente137398a8458f45e7679bc7ca7b607da5878af22 (diff)
downloadansible-49950fa875a9d7f98d1824dfcc78a850de36326e.tar.gz
Use antsibull sphinx extension (#73170) (#75100)
* Use antsibull sphinx extension. * Require antsibull 0.34.0. (cherry picked from commit 2c0f050b4f81188d77c2f52524c8132e2048d4c7)
Diffstat (limited to 'docs')
-rw-r--r--docs/docsite/known_good_reqs.txt2
-rw-r--r--docs/docsite/requirements.txt2
-rw-r--r--docs/docsite/sphinx_conf/2.10_conf.py7
-rw-r--r--docs/docsite/sphinx_conf/all_conf.py7
-rw-r--r--docs/docsite/sphinx_conf/ansible_conf.py7
-rw-r--r--docs/docsite/sphinx_conf/core_conf.py7
6 files changed, 26 insertions, 6 deletions
diff --git a/docs/docsite/known_good_reqs.txt b/docs/docsite/known_good_reqs.txt
index 347d2d15f7..19251591e1 100644
--- a/docs/docsite/known_good_reqs.txt
+++ b/docs/docsite/known_good_reqs.txt
@@ -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
diff --git a/docs/docsite/requirements.txt b/docs/docsite/requirements.txt
index 251503fa7b..84395e615b 100644
--- a/docs/docsite/requirements.txt
+++ b/docs/docsite/requirements.txt
@@ -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
diff --git a/docs/docsite/sphinx_conf/2.10_conf.py b/docs/docsite/sphinx_conf/2.10_conf.py
index dfb06a1463..7e3327e711 100644
--- a/docs/docsite/sphinx_conf/2.10_conf.py
+++ b/docs/docsite/sphinx_conf/2.10_conf.py
@@ -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.
diff --git a/docs/docsite/sphinx_conf/all_conf.py b/docs/docsite/sphinx_conf/all_conf.py
index 1d4fa9c829..5c0bca9fe3 100644
--- a/docs/docsite/sphinx_conf/all_conf.py
+++ b/docs/docsite/sphinx_conf/all_conf.py
@@ -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.
diff --git a/docs/docsite/sphinx_conf/ansible_conf.py b/docs/docsite/sphinx_conf/ansible_conf.py
index 9f9ce6d4b7..e312c5638e 100644
--- a/docs/docsite/sphinx_conf/ansible_conf.py
+++ b/docs/docsite/sphinx_conf/ansible_conf.py
@@ -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.
diff --git a/docs/docsite/sphinx_conf/core_conf.py b/docs/docsite/sphinx_conf/core_conf.py
index d4971cc8d1..9a8a655548 100644
--- a/docs/docsite/sphinx_conf/core_conf.py
+++ b/docs/docsite/sphinx_conf/core_conf.py
@@ -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.