added support for make html-noapi and html-quick for the docs build#4333
Merged
bjlittle merged 2 commits intoSciTools:mainfrom Sep 21, 2021
Merged
added support for make html-noapi and html-quick for the docs build#4333bjlittle merged 2 commits intoSciTools:mainfrom
bjlittle merged 2 commits intoSciTools:mainfrom
Conversation
Member
|
Nice - I often build the docs just to check I haven't messed up the whatsnew syntax! I had found the |
bjlittle
approved these changes
Sep 21, 2021
tkknight
added a commit
to tkknight/iris
that referenced
this pull request
Sep 22, 2021
* main: (94 commits) added support for make html-noapi and html-quick for the docs build (SciTools#4333) Refactor some netcdf save code (SciTools#4301) [pre-commit.ci] pre-commit autoupdate (SciTools#4329) Update to loading docs to cover absence of 'or' for constraints (SciTools#4321) update latest.rst.template (SciTools#4323) stable cartopy feature download (SciTools#4328) Skip TestConstrainedLoad if data missing (SciTools#4319) Add 'Good First Issue' label to reasons an issue doesn't go stale (SciTools#4317) Gallery: simplify quiver example (SciTools#4120) Improve styling in a minor way in docs (SciTools#4314) bump version (SciTools#4310) Made clear we only test on Linux. (SciTools#4309) Updated environment lockfiles (SciTools#4308) Include Discussions in Getting Involved. (SciTools#4307) Fixed text to show as link. (SciTools#4305) [pre-commit.ci] pre-commit autoupdate (SciTools#4299) Updated environment lockfiles (SciTools#4298) cartopy feature download (SciTools#4304) Mesh Loading (AVD-1813) (SciTools#4262) reset whatsnew latest (SciTools#4288) ...
6 tasks
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
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.
🚀 Pull Request
Description
Small quality of life change when working on improving the Iris documentation (developers use only). I would typically comment out the iris docs sphinx extensions when editing the documentation and skip the gallery builds to allow for faster builds. I would still of course do a complete clean and full build as a final test.
The PR introduces to new make targets for the Iris docs:
make html-noapi. This will skip the API doc creationmake html-quick. This will skip the API doc creation and also skip the gallery creation.Consult Iris pull request check list