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

Unpin sphinx #776

Closed
cidrblock opened this issue Jan 19, 2022 · 0 comments · Fixed by #1160
Closed

Unpin sphinx #776

cidrblock opened this issue Jan 19, 2022 · 0 comments · Fixed by #1160
Labels
bug Researched, reproducible, committed to fix good first issue Bugs ideal for the first time, good for newcomers contributors

Comments

@cidrblock
Copy link
Collaborator

in docs/requirements.in

the latest version of sphinx was causing the following errors:

try uncapping and see if the error remains, other wise look at issue below for a way to avoid it

/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)

Related: sphinx-doc/sphinx#10112
Related: #775

@cidrblock cidrblock added the bug Researched, reproducible, committed to fix label Jan 19, 2022
@cidrblock cidrblock added the good first issue Bugs ideal for the first time, good for newcomers contributors label Jan 19, 2022
ansible-zuul bot pushed a commit that referenced this issue 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 #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 issue 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 issue 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Researched, reproducible, committed to fix good first issue Bugs ideal for the first time, good for newcomers contributors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant