Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use antsibull sphinx extension #73170

Merged
merged 2 commits into from Jun 23, 2021
Merged

Use antsibull sphinx extension #73170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3418f9d
Use antsibull sphinx extension.
felixfontein Jan 9, 2021
aa58de3
Require antsibull 0.34.0.
felixfontein Jun 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docsite/known_good_reqs.txt
View file
Open in desktop
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/docsite/requirements.txt
View file
Open in desktop
Expand Up @@ -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
Expand Down
7 changes: 6 additions & 1 deletion docs/docsite/sphinx_conf/2.10_conf.py
View file
Open in desktop
Expand Up @@ -43,7 +43,12 @@
# 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.
Expand Down
7 changes: 6 additions & 1 deletion docs/docsite/sphinx_conf/all_conf.py
View file
Open in desktop
Expand Up @@ -43,7 +43,12 @@
# 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.
Expand Down
7 changes: 6 additions & 1 deletion docs/docsite/sphinx_conf/ansible_conf.py
View file
Open in desktop
Expand Up @@ -43,7 +43,12 @@
# 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.
Expand Down
7 changes: 6 additions & 1 deletion docs/docsite/sphinx_conf/core_conf.py
View file
Open in desktop
Expand Up @@ -43,7 +43,12 @@
# 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.
Expand Down