Skip to content

Cylc Config Metadata Directive#81

Draft
wxtim wants to merge 1 commit intocylc:masterfrom
wxtim:metadata
Draft

Cylc Config Metadata Directive#81
wxtim wants to merge 1 commit intocylc:masterfrom
wxtim:metadata

Conversation

@wxtim
Copy link
Copy Markdown
Member

@wxtim wxtim commented Aug 1, 2024 •
edited
Loading

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
wxtim
wxtim commented Aug 1, 2024
View reviewed changes
Comment thread cylc/sphinx_ext/metadata/__init__.py Outdated
# Load Global Config:
if conf_path:
env = os.environ
sub = run(
Copy link
Copy Markdown
Member Author

@wxtim wxtim Aug 1, 2024

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
Copy Markdown
Member

@oliver-sanders oliver-sanders Aug 20, 2024

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.

@wxtim wxtim mentioned this pull request Aug 1, 2024
Draft
8 tasks
oliver-sanders
oliver-sanders reviewed Aug 1, 2024
View reviewed changes
Comment thread conf.py Outdated
oliver-sanders
oliver-sanders reviewed Aug 1, 2024
View reviewed changes
Comment thread cylc/sphinx_ext/metadata/__init__.py Outdated
oliver-sanders
oliver-sanders reviewed Aug 1, 2024
View reviewed changes
Comment thread etc/flow.cylc Outdated
oliver-sanders
oliver-sanders reviewed Aug 1, 2024
View reviewed changes
Comment thread etc/flow/global.cylc Outdated
@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.

Sign in to view

@wxtim wxtim marked this pull request as ready for review August 20, 2024 12:02
@wxtim wxtim requested a review from oliver-sanders August 20, 2024 12:02
oliver-sanders
oliver-sanders reviewed Aug 20, 2024
View reviewed changes
Comment thread cylc/sphinx_ext/cylc_lang/__init__.py Outdated
Comment thread cylc/sphinx_ext/cylc_lang/autodocumenters.py Outdated
Comment thread cylc/sphinx_ext/cylc_lang/autodocumenters.py Outdated
Comment thread cylc/sphinx_ext/cylc_lang/autodocumenters.py Outdated
Comment thread cylc/sphinx_ext/cylc_lang/autodocumenters.py Outdated
Comment thread cylc/sphinx_ext/cylc_lang/autodocumenters.py Outdated
Comment thread cylc/sphinx_ext/metadata/__init__.py Outdated
Comment thread etc/flow.cylc Outdated
Comment thread etc/flow.cylc Outdated
Comment thread etc/flow.cylc Outdated
@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 oliver-sanders August 22, 2024 08:17
wxtim
wxtim commented Aug 22, 2024
View reviewed changes
Comment thread cylc/sphinx_ext/cylc_lang/__init__.py
wxtim
wxtim commented Aug 23, 2024
View reviewed changes
Comment thread cylc/sphinx_ext/cylc_lang/autodocumenters.py Outdated
wxtim
wxtim commented Aug 23, 2024
View reviewed changes
Comment thread cylc/sphinx_ext/cylc_lang/autodocumenters.py Outdated
@wxtim wxtim requested a review from MetRonnie August 23, 2024 09:59
@MetRonnie
Copy link
Copy Markdown
Member

MetRonnie commented Aug 23, 2024

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

@wxtim
Copy link
Copy Markdown
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
@oliver-sanders oliver-sanders added this to the pending milestone Apr 11, 2025
@MetRonnie MetRonnie removed their request for review July 11, 2025 10:53
@oliver-sanders
Copy link
Copy Markdown
Member

oliver-sanders commented Feb 19, 2026

(unassigning this to re-focus my review queue, feel free to re-assign when undrafted)

@oliver-sanders oliver-sanders removed their request for review February 19, 2026 12:53
@wxtim
Basic Metadata Writing extension
91ed5de 
fixed up some naming

Add some unit testing for standalone functions in autodoc

Refactored autodocumenters, fixed a bug.

more testing

update python version

tests for the global config autodoc

remove commented code
@wxtim
Copy link
Copy Markdown
Member Author

wxtim commented Mar 9, 2026

Tests will fail until cylc/cylc-flow#6275 merged. Tests will pass locally if you have that branch checked out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@oliver-sanders oliver-sanders oliver-sanders left review comments

@MetRonnie MetRonnie MetRonnie left review comments

Assignees

@wxtim wxtim

Labels

None yet

Projects

None yet

Milestone

pending

Development

Successfully merging this pull request may close these issues.

3 participants

@wxtim @MetRonnie @oliver-sanders