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

Autogenerate documentation about hooks available for plugins #132

Open
yuvipanda opened this issue Aug 13, 2018 · 1 comment
Open

Autogenerate documentation about hooks available for plugins #132

yuvipanda opened this issue Aug 13, 2018 · 1 comment
Labels
needs-documentation Issue that can be solved with documentation

Comments

@yuvipanda
Copy link
Collaborator

Our hooks exist in tljh/hooks.py, and have docstrings. We should autogenerate a reference page from here.
@yuvipanda yuvipanda mentioned this issue Aug 13, 2018
Merged
2 tasks
@yuvipanda yuvipanda added the needs-documentation Issue that can be solved with documentation label May 20, 2019
@consideRatio
Copy link
Member

consideRatio commented Oct 22, 2021 •
edited
Loading

This should perhaps be done using autodoc_traits as done in various other projects in our GitHub org.

We currently don't have a reference section in our docs, I think we should add such autogenerated docs there, and that we should also add autogenerated reference docs about the config options from a JSON schema there if #725 is implemented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
needs-documentation Issue that can be solved with documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@yuvipanda @consideRatio