Autodocument post-install plugins #236
Conversation
src/plugins/post-install/index.rst
Outdated
| Post-Install Plugins | ||
| ==================== | ||
|
|
||
| .. automodule:: cylc.flow.post_install |
There was a problem hiding this comment.
Build failure seems to be due to google-style docstrings. But actually, I don't think we need the Python functions documented at all? Surely we just need the module docstring? Is there a way to do that?
There was a problem hiding this comment.
Is there a way to do that?
https://github.com/cylc/cylc-flow/pull/4142/files#r607893197
There was a problem hiding this comment.
Looks like Napoleon was not enabled on this repo, not sure why. One line change to enable it - https://github.com/metomi/rose/blob/380315e4785b7319ad3b73d985afbcd2fad858fe/sphinx/conf.py#L38
There was a problem hiding this comment.
If I add Napoleon, I start getting errors, possibly because we need https://github.com/agronholm/sphinx-autodoc-typehints
But I guess this isn't needed for this PR, as I've removed the documenting of the log_vc_info members anyway
|
Will undraft when cylc/cylc-flow#4142 is merged |
|
Docs build with no errors, could do with some more info in the docs - https://github.com/cylc/cylc-flow/pull/4142/files#r620134018 |
|
The only test failure is the tutorial suite |
Document the new
log_vc_infopost-install plugin (cylc/cylc-flow#4142)