Docs revamp #180
Merged
Docs revamp #180
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…into pydata-theme # Conflicts: # docs/requirements.txt # docs/source/api.rst
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
jhamman
reviewed
Apr 29, 2023
docs/source/getting-started/tutorial/serving-multiple-datasets.md
Outdated
Show resolved
Hide resolved
docs/source/index.md
Outdated
| :::{grid-item-card} A quick way to serve a single Xarray dataset | ||
| :link: getting-started/tutorial/introduction | ||
|
|
||
| Add a REST API to your dataset with `ds.rest.serve()`! |
There was a problem hiding this comment.
The whole card, or 'Add a REST API to your dataset with ds.rest.serve()?
How about something like 'Get started with ds.rest.serve() to explore serving data with Xpublish'?
This was referenced Apr 29, 2023
# Conflicts: # docs/source/api.md # docs/source/conf.py # docs/source/index.rst
|
We can always continue to tweak the docs later, so going to merge this and work on a release #183 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Start of a big revamp of the docs.