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.

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

Cap the version Sphinx below 4.4.0 #775

Merged
merged 2 commits into from Jan 19, 2022
Merged

Conversation

ssbarnea
Copy link
Member

@ssbarnea ssbarnea commented Jan 19, 2022

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 'https://github.com/containers/podman/issues/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 #776

@ssbarnea ssbarnea marked this pull request as ready for review January 19, 2022 16:41
@cidrblock cidrblock mentioned this pull request Jan 19, 2022
@cidrblock cidrblock added the gate label Jan 19, 2022
Copy link
Contributor

@ansible-zuul ansible-zuul bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@cidrblock cidrblock added gate and removed gate labels Jan 19, 2022
@webknjaz webknjaz changed the title chore: pin down sphinx < 4.4.0 Cap the version Sphinx below 4.4.0 Jan 19, 2022
docs/requirements.in Outdated Show resolved Hide resolved
Co-authored-by: Sviatoslav Sydorenko <webknjaz@redhat.com>
@ansible-zuul ansible-zuul bot removed the gate label Jan 19, 2022
@webknjaz
Copy link
Member

@ssbarnea please fill out the PR description with something more meaningful than a contextless reference to another location.

@cidrblock
Copy link
Collaborator

I am responsible for the poor description here.

@cidrblock cidrblock self-assigned this Jan 19, 2022
@cidrblock cidrblock added gate and removed gate labels Jan 19, 2022
@cidrblock cidrblock closed this Jan 19, 2022
@cidrblock cidrblock reopened this Jan 19, 2022
@cidrblock cidrblock added gate and removed gate labels Jan 19, 2022
@ansible-zuul ansible-zuul bot merged commit d0c81b2 into ansible:main Jan 19, 2022
cidrblock pushed a commit to cidrblock/ansible-navigator that referenced this pull request Jan 19, 2022
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>
cidrblock pushed a commit to cidrblock/ansible-navigator that referenced this pull request Jan 20, 2022
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>
@ssbarnea ssbarnea deleted the fix/docs branch September 27, 2022 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants