Cylc Config Metadata Directive - Githubissues

cylc / cylc-sphinx-extensions

Sphinx extensions for documenting Cylc projects.

https://cylc.github.io/cylc-sphinx-extensions/

GNU General Public License v3.0

4 stars 8 forks source link

Cylc Config Metadata Directive #81

Open wxtim opened 4 months ago

wxtim commented 4 months ago

Requires https://github.com/cylc/cylc-flow/pull/6275

Writes basic metadata directives to document with

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

.. cylc_metadata::
   :global: set a CYLC_SITE_CONF_PATH

Check List

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

MetRonnie commented 3 months ago

https://github.com/cylc/cylc-sphinx-extensions/pull/85 will help with tests failures, but will still fail due to hieroglyph

wxtim commented 3 months ago

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

PR will never work without https://github.com/cylc/cylc-flow/pull/6275 anyway.