-
Notifications
You must be signed in to change notification settings - Fork 23
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.
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
Enable MyST Markdown #165
Labels
documentation
Improvements or additions to documentation
Comments
abkfenris
added a commit
to abkfenris/xpublish
that referenced
this issue
Apr 7, 2023
Start of a big revamp of the docs. - Uses Pydata theme - Enables MyST markdown and converts a lot of the docs to it (rst heading levels and git conflict formatting conflict, which was a fun discovery) - Re-arranges things along the Diátaxis framework lines, or at least how they are being used in the PyData space - Adds the vision or 'Why Xpublish' page - Breaks the tutorial into sections and scaffolds sections for use of plugins Closes xpublish-community#163 xpublish-community#165 xpublish-community#162 xpublish-community#166
abkfenris
added a commit
that referenced
this issue
May 11, 2023
* Add methods to API docs and use typehints Closes #160 #161 * Use the Pydata theme for docs Closes #164 * Add methods to API docs and use typehints Closes #160 #161 * Use the Pydata theme for docs Closes #164 * Hide the top menu navigation from the index page * Docs revamp Start of a big revamp of the docs. - Uses Pydata theme - Enables MyST markdown and converts a lot of the docs to it (rst heading levels and git conflict formatting conflict, which was a fun discovery) - Re-arranges things along the Diátaxis framework lines, or at least how they are being used in the PyData space - Adds the vision or 'Why Xpublish' page - Breaks the tutorial into sections and scaffolds sections for use of plugins Closes #163 #165 #162 #166 * Update xarray-contrib to xpublish-community * Pre-commit format markdown and docs code snippets * Dataset router plugin tutorial and other doc tweaks * Use literalinclude rather than duplicating doc code * Remove some under-construction alerts
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
MyST allows writing of docs and docstrings in Markdown, while still enabling more advanced ReStructuredText style directives.
By converting the docs to MyST we can hopefully encourage more folks to help with documentation by starting with an easier syntax that more folks know.
The text was updated successfully, but these errors were encountered: