search

reactive-python / reactpy-django

It's React, but in Python. Now with Django integration.
https://reactive-python.github.io/reactpy-django/
MIT License
328 stars 18 forks source link

Use mkdocstrings for documenting Python code #94

Open Archmonger opened 2 years ago

Archmonger commented 2 years ago

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: