Make doc compiling under windows workable #5245
Closed
Conversation
This file contains hidden or 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
doc/source/io.rst
Outdated
There was a problem hiding this comment.
I don't think this should be in here. Normal users who read the docs on the website shoudn't be bothered with that I think.
|
2 things:
|
|
@jtratner like this? |
The doc generation failed under windows due to problems with sphinx and encoded umlauts in code (see links in #5142). The workaround is to replace the offending text with one which does not fail (but which makes the example a bit pointless), build the docs and restore the old text.
On windows, these generated files are often left over due to "file in use" errors. Remove them after the doc build has finished.
|
Please remove this PR, I think I found the real cause of the failing doc builds |
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
The doc generation failed under windows due to problems with sphinx
and encoded umlauts in code (see links in
#5142).
The workaround is to replace the offending text with one which does not fail
(but which makes the example a bit pointless), build the docs and restore the
old text.
Closes: #5142