Fix documentation local build #3349
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
|
Thank you very much @codeandfire (sorry for the trouble with the improperly formatted examples). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of changes
The docs were not building locally due to the following warnings:
.gitattributes,.gitignoreetc. 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.extlinksextension seems have to recently started emitting the following warning:userentry in theextlinksdefined indocs/conf.py, the caption string is'@'. I have fixed this by changing the caption string to'@%s'.Pull Request Checklist
changelog.d/.(See documentation for details)