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

Build the sphinx documentation on windows #1891

Merged
merged 6 commits into from
Jun 21, 2024

Conversation

Manangka
Copy link
Contributor

@Manangka Manangka commented Jun 21, 2024

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:

pixi install
pixi run update-flopy
pixi run get-exes
pixi run setup builddir
pixi run build builddir
pixi run benchmark
pixi run sphinx

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 required

Checklist of items for pull request

  • Closed issue #xxxx
  • Referenced issue or pull request #xxxx
  • Added new test or modified an existing test
  • Ran black on new and modified autotests
  • Formatted new and modified Fortran source files with fprettify
  • Added doxygen comments to new and modified procedures
  • Updated meson files, makefiles, and Visual Studio project files for new source files
  • Updated definition files
  • Updated develop.tex with a plain-language description of the bug fix, change, feature; required for changes that may affect users
  • Updated input and output guide
  • Removed checklist items not relevant to this pull request

For additional information see instructions for contributing and instructions for developing.

@Manangka Manangka marked this pull request as ready for review June 21, 2024 11:08
@Manangka Manangka requested a review from wpbonelli June 21, 2024 11:08
pixi.toml Show resolved Hide resolved
pixi.toml Outdated Show resolved Hide resolved
Copy link
Contributor

@wpbonelli wpbonelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a note re: the custom install task. All else looks great to me.

@wpbonelli wpbonelli merged commit 02b605f into MODFLOW-USGS:develop Jun 21, 2024
17 of 18 checks passed
wpbonelli pushed a commit that referenced this pull request Jun 25, 2024
#1891 removed `requirements.rtd.txt` in favor of creating a pixi rtd environment. However ReadTheDocs doesn't support pixi and requires either pip or conda. Restore requirements.rtd.txt to satisfy that requirement.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants