reference: environment variables section #884
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
* Use the `envvar` directive to document environment variables, closes cylc#226 * Cross reference env vars throughout the docs, addresses cylc#124 * Copy the environment variable documentation from the Cylc wrapper script into the environment variable reference, addresses cylc#558 * Improve job env var documentation and cross link into the Cylc configuration reference where appropriate, addresses cylc#124
wxtim
reviewed
Nov 19, 2025
8 tasks
wxtim
approved these changes
Nov 19, 2025
Member
wxtim
left a comment
wxtim
left a comment
There was a problem hiding this comment.
Looks good.
- Tested at myserver/doc/cylc/cylc-doc.884/html/index.html
- Follow up PR: Use these changes in
cylc-flow/cylc/flow/cfgspeccylc/cylc-flow#7092
Member
|
Please merge or request a second review... |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Have been meaning to get around to this for the last ~5 years 🤦!
envvardirective to document environment variables, closes document environment variables #226Environment variables how have hyperlink anchors (so we can send references to them in support) and are crosslinked throughout the docs. We can also link them (via intersphinx) from other Sphinx projects (e.g, internal docs).
Requirements check-list
CONTRIBUTING.mdand added my name as a Code Contributor.