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

Cylc Config Metadata Directive #81

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Conversation

wxtim
Copy link
Member

@wxtim wxtim commented Aug 1, 2024

Requires cylc/cylc-flow#6275

Writes basic metadata directives to document with

.. cylc_metadata::
   :source: /path/to/workflow

.. cylc_metadata::
   :global: set a CYLC_SITE_CONF_PATH

image

Check List

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.
  • Contains logically grouped changes (else tidy your branch by rebase).
  • Does not contain off-topic changes (use other PRs for other changes).
  • Applied any dependency changes to both setup.cfg (and conda-environment.yml if present).
  • Tests are included (or explain why tests are not needed).
  • Changelog entry included if this is a change that can affect users
  • Cylc-Doc pull request opened if required at cylc/cylc-doc/pull/XXXX.
  • If this is a bug fix, PR should be raised against the relevant ?.?.x branch.

@wxtim wxtim self-assigned this Aug 1, 2024
@wxtim wxtim added documentation Improvements or additions to documentation enhancement labels Aug 1, 2024
# Load Global Config:
if conf_path:
env = os.environ
sub = run(
Copy link
Member Author

Choose a reason for hiding this comment

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

Subprocess is used to decouple licences.

Copy link
Member

Choose a reason for hiding this comment

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

The --json approach is a nice way to handle this.

conf.py Outdated Show resolved Hide resolved
etc/flow.cylc Outdated Show resolved Hide resolved
etc/flow/global.cylc Outdated Show resolved Hide resolved
@wxtim wxtim marked this pull request as draft August 5, 2024 12:06
@wxtim wxtim force-pushed the metadata branch 2 times, most recently from 42c67be to 26b2152 Compare August 19, 2024 08:39
MetRonnie

This comment was marked as outdated.

@wxtim wxtim marked this pull request as ready for review August 20, 2024 12:02
cylc/sphinx_ext/cylc_lang/__init__.py Outdated Show resolved Hide resolved
cylc/sphinx_ext/cylc_lang/autodocumenters.py Outdated Show resolved Hide resolved
cylc/sphinx_ext/cylc_lang/autodocumenters.py Outdated Show resolved Hide resolved
cylc/sphinx_ext/cylc_lang/autodocumenters.py Outdated Show resolved Hide resolved
cylc/sphinx_ext/cylc_lang/autodocumenters.py Outdated Show resolved Hide resolved
cylc/sphinx_ext/cylc_lang/autodocumenters.py Outdated Show resolved Hide resolved
cylc/sphinx_ext/metadata/__init__.py Outdated Show resolved Hide resolved
etc/flow.cylc Outdated Show resolved Hide resolved
etc/flow.cylc Outdated Show resolved Hide resolved
etc/flow.cylc Outdated Show resolved Hide resolved
@oliver-sanders oliver-sanders removed enhancement documentation Improvements or additions to documentation labels Aug 20, 2024
@wxtim wxtim marked this pull request as draft August 20, 2024 16:01
@wxtim wxtim marked this pull request as ready for review August 22, 2024 08:17
@wxtim wxtim requested a review from MetRonnie August 23, 2024 09:59
@MetRonnie
Copy link
Member

#85 will help with tests failures, but will still fail due to hieroglyph

@wxtim
Copy link
Member Author

wxtim commented Aug 23, 2024

#85 will help with tests failures, but will still fail due to hieroglyph

PR will never work without cylc/cylc-flow#6275 anyway.

@wxtim wxtim marked this pull request as draft October 4, 2024 13:21
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.

3 participants