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

Fix documentation local build #3349

merged 3 commits into from Jun 8, 2022


Copy link

@codeandfire codeandfire commented Jun 8, 2022

Summary of changes

The docs were not building locally due to the following warnings:

  1. The .gitattributes, .gitignore etc. example added recently to the Data Files page was using single backticks instead of double backticks, causing these filenames to be interpreted as links rather than code.
  2. The extlinks extension seems have to recently started emitting the following warning:
    WARNING: extlinks: Sphinx-6.0 will require a caption string to contain exactly one '%s' and all other '%' need to be escaped as '%%'.
    Seems the issue is with the user entry in the extlinks defined in docs/, the caption string is '@'. I have fixed this by changing the caption string to '@%s'.

Pull Request Checklist

For the `exclude_package_data` example added recently, there were single
backticks around `.gitignore`, `.gitattributes` etc. which leads to the
docs failing to build locally.
`extlinks` seems to have recently started emitting the following
warning requiring the caption string to contain exactly one `%s`. This
warning also stops the docs from building locally.
Copy link

Thank you very much @codeandfire (sorry for the trouble with the improperly formatted examples).

@codeandfire codeandfire marked this pull request as ready for review June 8, 2022 14:15
@abravalheri abravalheri merged commit 6fb4211 into pypa:main Jun 8, 2022
@codeandfire codeandfire deleted the docs-build-fix branch June 8, 2022 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
None yet

Successfully merging this pull request may close these issues.

None yet

2 participants