search

cylc / cylc-doc

Documentation (User Guide, Cheat Sheets, etc.) for the Cylc Workflow Engine.
https://cylc.github.io/cylc-doc/
GNU General Public License v3.0
8 stars 19 forks source link

Autodoc built-in xtrigger functions #673

Closed MetRonnie closed 4 months ago

MetRonnie commented 7 months ago

The debug arg is not around anymore. By autofunction'ing, these will always be valid. The downside is pulling in the docstring is quite verbose...

Requirements check-list

oliver-sanders commented 7 months ago

Note, this PR will conflict with https://github.com/cylc/cylc-doc/pull/671 which also auto-documents xtriggers, but in the plugins section (the xtriggers section is more appropriate).

We could probably do with pulling any relevant text out of cylc-doc and into the xtrigger docstrings to keep it all together?

For maintainability, I think we should probably go along the same lines at the job runner handlers and put the autosummary or autodoc directive in the cylc-flow code, then autodocument the init file, WDYT:

https://github.com/cylc/cylc-flow/blob/master/cylc/flow/job_runner_handlers/__init__.py

oliver-sanders commented 5 months ago

Closes https://github.com/cylc/cylc-doc/issues/106

MetRonnie commented 4 months ago

Superseded by #686