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.

Sign up for GitHub

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

Jump to bottom

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

Open
oliver-sanders opened this issue Oct 3, 2022 · 0 comments
Open

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

oliver-sanders opened this issue Oct 3, 2022 · 0 comments

Comments

@oliver-sanders
Copy link
Member

Cylc workflows can be documented using [meta] sections.

We plan to integrate this information into the Cylc UI soon: cylc/cylc-ui#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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@oliver-sanders