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

Upgrade Sphinx and sphinx_rtd_theme #74194

Closed
acozine opened this issue Apr 8, 2021 · 7 comments · Fixed by #74956
Closed

Upgrade Sphinx and sphinx_rtd_theme #74194

acozine opened this issue Apr 8, 2021 · 7 comments · Fixed by #74956
Labels
affects_2.12 docs This issue/PR relates to or includes documentation. has_pr This issue has an associated PR. support:core This issue/PR relates to code supported by the Ansible Engineering Team.

Comments

@acozine
Copy link
Contributor

acozine commented Apr 8, 2021

Summary

Upgrade to at least Sphinx 2.2.2 (to avoid issues with the docs build on macs) and the latest sphinx_rtd_theme.

Issue Type

Documentation Report

Component Name

docs/docsite/requirements.txt and docs/docsite/_themes/sphinx_rtd_theme

Ansible Version

2.12

Configuration

N/A

OS / Environment

N/A

Additional Information

Once readthedocs/sphinx_rtd_theme#1115 is fixed, we can unpin the version of docutils.

Code of Conduct

I agree to follow the Ansible Code of Conduct
@acozine acozine mentioned this issue Apr 8, 2021
Merged
@ansibot
Copy link
Contributor

ansibot commented Apr 8, 2021

Files identified in the description:

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help

@ansibot ansibot added affects_2.12 docs This issue/PR relates to or includes documentation. has_pr This issue has an associated PR. needs_triage Needs a first human triage before being processed. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Apr 8, 2021
@samdoran samdoran removed the needs_triage Needs a first human triage before being processed. label Apr 8, 2021
@webknjaz
Copy link
Member

webknjaz commented Apr 8, 2021

Here's also an issue about sphinx 3.5+ compat: #73611

@samdoran
Copy link
Contributor

samdoran commented Apr 8, 2021

Related to #71395.
Sphinx issue: sphinx-doc/sphinx#6803.
"Fixed" in Sphinx >= 2.2.2 by sphinx-doc/sphinx@3bc16b0.

@samccann
Copy link
Contributor

This PR also suggests we need to be >= 3.2 - https://github.com/ansible/ansible/pull/74268/files#diff-55afa0e374c236bc768e486db6ce391902ba4db29f456b34f7c39fafd9913d3bR47

@acozine
Copy link
Contributor Author

acozine commented Apr 20, 2021

Also related to https://github.com/ansible/ansible/pull/74268/files#diff-55afa0e374c236bc768e486db6ce391902ba4db29f456b34f7c39fafd9913d3bR47.

We may want to make Sphinx >= 3.2 our goal.

@acozine
Copy link
Contributor Author

acozine commented Jun 3, 2021

Related to #74798 and #74318.

@acozine acozine mentioned this issue Jun 9, 2021
Merged
@ansibot
Copy link
Contributor

ansibot commented Jun 11, 2021

Files identified in the description:
None

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help

@ansible ansible locked and limited conversation to collaborators Jul 20, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
affects_2.12 docs This issue/PR relates to or includes documentation. has_pr This issue has an associated PR. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update docs requirements list acozine/ansible
5 participants
@webknjaz @acozine @samdoran @ansibot @samccann