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

Update extlinks strings to use a format string #555

Merged
merged 1 commit into from
Jun 5, 2022

Conversation

mayeut
Copy link
Member

@mayeut mayeut commented Jun 5, 2022

Sphinx 4 added a new way of specifying extlinks "caption string" (instead of "prefix string")
Sphinx 5 added a deprecation warning when still using the "prefix string" notation which fails the build:

Running Sphinx v5.0.1
Warning, treated as error:
extlinks: Sphinx-6.0 will require a caption string to contain exactly one '%s' and all other '%' need to be escaped as '%%'.

Sphinx 4 added a new way of specifying extlinks "caption string" (instead of "prefix string")
Sphinx 5 added a deprecation warning when still using the "prefix string" notation which fails the build:
```
Running Sphinx v5.0.1
Warning, treated as error:
extlinks: Sphinx-6.0 will require a caption string to contain exactly one '%s' and all other '%' need to be escaped as '%%'.
```
@pradyunsg pradyunsg changed the title fix(doc): update extlinks to use a caption string Update extlinks strings to use a format string Jun 5, 2022
@pradyunsg pradyunsg merged commit 0ffdf31 into pypa:main Jun 5, 2022
@mayeut mayeut deleted the fix-docs branch June 5, 2022 22:10
hrnciar pushed a commit to hrnciar/packaging that referenced this pull request Jul 1, 2022
This addresses a warning in Sphinx 5, regarding the missing` %s` in
these strings.

```
extlinks: Sphinx-6.0 will require a caption string to contain exactly one '%s' and all other '%' need to be escaped as '%%'.
```
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.

2 participants