-
Notifications
You must be signed in to change notification settings - Fork 10
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
Where should xtriggers be documented? #4
Comments
Good question! I would say document it here, but maybe users would prefer to have everything in the Cylc User Guide, without having to refer to other documentation? We will have the same issue with |
I think it is fine to have the general xtrigger documentation in the main repo - i.e. what is an xtrigger, how does it work, and what are the built-in ones (if any? just clock, I think we were discussing...) because the server program has the internal machinery to support xtriggers. Documentation for how to use specific xtriggers that live in this repo, however, should be in this repo. We'd still have to decide what form that should take though ... maybe text/markdown is sufficient for this? |
Sounds good to me. We could have some small text/markdown documents, and perhaps even the API generated documentation if useful. +1 |
Sounds good. I would go with markdown at least initially because it is simple and it should be sufficient. If it grows too large and hard to use, then moving to sphinx could be revisited. |
Markdown it is. |
To though in a spanner:
|
@ColemanTom to throw in another spanner, we are about to move the User Guide to the new cylc/cylc-doc repo. Have decided to do this because the documentation will have to span multiple separate components of cylc-8. |
I would say document xtriggers in docstrings in the source code and auto-document them in Sphinx from the new cylc/cylc-doc repo. BTW moving the repo isn't a barrier to auto-documentation. |
OK, looks like we have a consensus. Closing this question here as "resolved", moving the issue into the Cylc Docs repository: |
Whilst looking at #2 I wondered about documentation. That pull request moves some xtriggers from cylc-flow into this repository, but their documentation is still part of the core cylc-flow doco. Should all specific xtrigger doco be pulled into this repository, and cylc-flow doco has a link to this only?
The text was updated successfully, but these errors were encountered: