Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Upgrade to Read the Docs and Sphinx for documentation #36

Closed
simonw opened this issue Mar 15, 2021 · 3 comments
Closed

Upgrade to Read the Docs and Sphinx for documentation #36

simonw opened this issue Mar 15, 2021 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@simonw
Copy link
Owner

simonw commented Mar 15, 2021

What with widgets and security configuration and suchlike this is already growing beyond what makes sense to put in a README.
@simonw simonw added the documentation Improvements or additions to documentation label Mar 15, 2021
@simonw
Copy link
Owner Author

simonw commented Mar 16, 2021

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
Copy link
Owner Author

simonw commented Mar 16, 2021

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

simonw added a commit that referenced this issue Mar 16, 2021
@simonw
Started building documentation with Myst, refs #36
7161401
simonw added a commit that referenced this issue Mar 16, 2021
@simonw
Read The Docs configuration, refs #36
122a074
simonw added a commit that referenced this issue Mar 16, 2021
@simonw
Python 3.8 for Read The Docs, refs #36
25a815c
@simonw
Copy link
Owner Author

simonw commented Mar 16, 2021

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

@simonw simonw closed this as completed in d6be11f Mar 16, 2021
@simonw simonw mentioned this issue Mar 16, 2021
Open
simonw added a commit that referenced this issue Mar 19, 2021
@simonw
Release 0.4a0
bd19486 
Refs #27, #29, #31, #32, #36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@simonw