Skip to content

Commit

Permalink
Cap the version Sphinx below 4.4.0 (ansible#775)
Browse files Browse the repository at this point in the history
Cap the version `Sphinx` below 4.4.0

The latest version of sphinx was causing the following errors, and therefore is being capped to version prior to the version causing the errors.
/home/docs/checkouts/readthedocs.org/user_builds/ansible-navigator/checkouts/774/docs/changelog.md:16: WARNING: hardcoded link 'https://github.com/twisted/towncrier' could be replaced by an extlink (try using ':gh:`twisted/towncrier`' instead)
/home/docs/checkouts/readthedocs.org/user_builds/ansible-navigator/checkouts/774/docs/installation.md:3: WARNING: hardcoded link 'containers/podman#8016' could be replaced by an extlink (try using ':gh:`containers/podman/issues/8016`' instead)

Detailed information about the changes introduced in sphinx causing the errors can be found here:
Related: sphinx-doc/sphinx#10112
The following issue was created to revert this PR once the sphinx error is fixed or can be avoided:
See ansible#776

Reviewed-by: Bradley A. Thornton <bthornto@redhat.com>
Reviewed-by: None <None>
Reviewed-by: Sviatoslav Sydorenko <webknjaz+github/profile@redhat.com>
  • Loading branch information
ssbarnea authored and cidrblock committed Jan 19, 2022
1 parent 1ae2b4d commit ad2c5a4
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/requirements.in
@@ -1,6 +1,6 @@
myst-parser[linkify] >= 0.15.1
setuptools-scm >= 6.0.1
Sphinx >= 4.1.2
Sphinx >= 4.1.2, < 4.4.0 # https://github.com/sphinx-doc/sphinx/issues/10112
sphinx-ansible-theme >= 0.8.0
sphinx-copybutton >= 0.4.0
sphinx-notfound-page >= 0.7.1
Expand Down

0 comments on commit ad2c5a4

Please sign in to comment.