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.

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

uis: auto-document Traitlets configurations #222

Closed
oliver-sanders opened this issue Mar 22, 2021 · 1 comment · Fixed by #385 or cylc/cylc-uiserver#300
Closed

uis: auto-document Traitlets configurations #222

oliver-sanders opened this issue Mar 22, 2021 · 1 comment · Fixed by #385 or cylc/cylc-uiserver#300
Assignees
Labels
infrastructure Build system, Sphinx extensions, Deployment etc

Comments

@oliver-sanders
Copy link
Member

The UIS now has some configurations.

We should be able to auto-document these, see https://traitlets.readthedocs.io/en/stable/config-api.html#traitlets.config.Application.document_config_options

@oliver-sanders oliver-sanders added the infrastructure Build system, Sphinx extensions, Deployment etc label Mar 22, 2021
@oliver-sanders oliver-sanders self-assigned this Aug 17, 2021
@oliver-sanders
Copy link
Member Author

Easy enough to do, only issue is that it only documents application defaults as opposed to traitlet defaults which means it gets the defaults all wrong which is highly confusing.

Blocked pending investigation in cylc-uiserver to see if we can move the defaults (of configurable=True traits only) out of @default methods into the traits (via the default kwarg).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure Build system, Sphinx extensions, Deployment etc
Projects
None yet
2 participants