FIX make sphinx docs work on Windows #206
Merged
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
Member
|
Surprisingly, it looks as though this works for bash shell on Windows too 👍 I think we should add one extra check: if |
Member
|
Agreed that we should eventually fully replace the make/make.bat with the spin cmd, but this is a good fix for now; thanks! |
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.
makedoes not exist on Windows in general sospin docsdoes not work on Windows.This small patch seems to be a reasonable way to make it more likely than
spin docsworks on Windows. I tested this on a Windows VM and it seems to work fine. The debug information is useful as well (i.e.cd docis explicitly mentioned):As noted in scikit-learn/scikit-learn#29012 (comment)
make.batis generated bysphinx-quickstartand some projects still have it. scikit-learn has it and I think it is supposed to work, although we don't have that many developers on Windows.numpyandmatplotlibstill havemake.batas well.Something else that I may take a closer look at one point in scikit-learn would be to actually not use the
Makefileat all for most useful doc-related functionalities and implement them as spin custom command. This is probably a bit of work (in particulardoc/Makefilehas some quirks related to environment variables in CI and different OS) and not high-priority right now.