MolSSI / cookiecutter-cms

Python-centric Cookiecutter for Molecular Computational Chemistry Packages
MIT License
385 stars 89 forks source link

update theme for docs #166

Closed janash closed 8 months ago

janash commented 1 year ago

this PR changes the default theme fromsphinx_rtd_theme to pydata_sphinx_theme. The requirements.yaml is 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-copybutton is 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.

codecov[bot] commented 11 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (4c3ea62) 44.44% compared to head (df1f713) 44.44%. Report is 12 commits behind head on review23.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## review23 #166 +/- ## ========================================= Coverage 44.44% 44.44% ========================================= Files 12 12 Lines 54 54 ========================================= Hits 24 24 Misses 30 30 ``` | [Flag](https://app.codecov.io/gh/MolSSI/cookiecutter-cms/pull/166/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolSSI) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/MolSSI/cookiecutter-cms/pull/166/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolSSI) | `44.44% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MolSSI#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.