-
Notifications
You must be signed in to change notification settings - Fork 250
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
Use MkDocs autodoc to generate documentation #1159
Comments
Ended up using MkDocs instead of Sphinx because:
|
Running into a weird issue where using Google style docstrings with mkdocstrings causes it to spuriously create sections where it shouldn't e.g.
The workaround is to delete the trailing colon. |
The regular expression that creates the undesired sections / admonitions is here. As far as I can tell, there is no way to disable it. The workarounds are to avoid the regex e.g. by adding |
We want dataclass documentation as well, as discussed in #1117 |
As noted in #1209, we need to add more schemas for dataclasses e.g. |
MkDocs is used now so I will close this issue. There's more documentation to write, but that should be in different issues. |
In particular, we want to generate documentation for built-in scenarios, models, adapters, etc. Auto-generating the documentation will make it easier to keep things in sync.
The text was updated successfully, but these errors were encountered: