Current Situation
Currently, our Python APIs are manually added to the docs, which can potentially result in API <-> Docs mismatch.
Proposed Actions
Use mkdocstrings within the docs to automatically generate markdown based on Python code, type hints, and docstrings.
Implementing this is currently blocked by these issues:
Current Situation
Currently, our Python APIs are manually added to the docs, which can potentially result in API <-> Docs mismatch.
Proposed Actions
Use
mkdocstringswithin the docs to automatically generate markdown based on Python code, type hints, and docstrings.Implementing this is currently blocked by these issues:
showsettings to markdown generator mkdocstrings/mkdocstrings#466