search

simonw / django-sql-dashboard

Django app for building dashboards using raw SQL queries
https://django-sql-dashboard.datasette.io/
Apache License 2.0
437 stars 37 forks source link

Upgrade to Read the Docs and Sphinx for documentation #36

Closed simonw closed 3 years ago

simonw commented 3 years ago

What with widgets and security configuration and suchlike this is already growing beyond what makes sense to put in a README.

simonw commented 3 years ago

I'm going to try the markdown variant of Sphinx for this - because django-sql-dashboard already has Python markdown as a dependency and I want to offer inline documentation too (see #28). Writing the docs in markdown will allow me to share some of the same content between the inline documentation and the published docs on Read The Docs.

simonw commented 3 years ago

https://myst-parser.readthedocs.io/en/latest/using/intro.html#enable-myst-in-sphinx

simonw commented 3 years ago

https://django-sql-dashboard.readthedocs.io/en/latest/ is live now.