Build the sphinx documentation on windows #1891
Merged
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.
This commit enables building the sphinx documentation on windows.
The make.bat needed to do so was missing and is added in this commit.
To build the documentation from a fresh git clone you need to run these commands:
I've also cleaned the pixi.toml file. I added the git dependencies on flopy, pymake, modflowapi and modflow-devtools as pypi-dependencies. This change made it possible to remove the install task.
Furthermore I added the rtd environment to the pixi.toml. When building sphinx you now don't have to manually pip install
the requirements.rtd.txt. Instead the task will automatically use the rtd environment
Finally i updated the github pipeline files. The newly generated pixi.lock is using version 5 which needs a newer pixi version. I also removed the
pixi run install
as this is no longer requiredChecklist of items for pull request
black
on new and modified autotestsfprettify
For additional information see instructions for contributing and instructions for developing.