update theme for docs #166
Merged
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
this commit changes the default theme from sphinx_rtd_theme to pydata_sphinx_theme and adds the sphinx_design plugin. Pages for user guides and developer guides are also added.
janash
force-pushed
the
doc-theme-update
branch
from
511dd17
to
f9d3d6a
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## review23 #166 +/- ##
=========================================
Coverage 44.44% 44.44%
=========================================
Files 12 12
Lines 54 54
=========================================
Hits 24 24
Misses 30 30
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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.
this PR changes the default theme from
sphinx_rtd_themetopydata_sphinx_theme. Therequirements.yamlis also updated for new dependencies for this theme.A grid is added to the front page for the four suggested types of documentation, as well as pages for each documentation type:
The extension
sphinx-copybuttonis also added by default to allow copy/paste from code blocks.In
requirements.yaml, I've updated the environment name to be based on the ProjectName. (Does this have any consequence I'm not aware of?). I also added development install of the package created by the Cookiecutter to this file.