search

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

extension to auto-document Cylc workflows from [meta] sections #75

Open oliver-sanders opened 2 years ago

oliver-sanders commented 2 years ago

Cylc workflows can be documented using [meta] sections.

We plan to integrate this information into the Cylc UI soon: https://github.com/cylc/cylc-ui/issues/1071

However there are other cases where this information might be useful, e.g. for projects wishing to build Sphinx documentation for their workflows.

We should look at writing a simple Sphinx autodocumenter to make this easier.