reactpy-django icon indicating copy to clipboard operation
reactpy-django copied to clipboard

Use mkdocstrings for documenting Python code

Open Archmonger opened this issue 3 years ago • 0 comments

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:

  • mkdocstrings/mkdocstrings#450
  • mkdocstrings/mkdocstrings#466

Archmonger avatar Aug 18 '22 06:08 Archmonger