neutrons / multiphonon

multiphonon (getDOS)

MIT License

3 stars 5 forks source link

Readthedocs Configuration #153

Closed mpatrou closed 4 months ago

mpatrou commented 4 months ago

Short description of the changes:

Configuration added for readthedocs website. Existing documentation (source files) with sphinx are used. (related to EWM5114)

Long description of the changes:

The code includes the following:

environment.yml with sphinx-related package
readthedocs yaml file
update to existing documentation configuration
readthedocs hook is activated on the PR for every future PR (from readthedocs)

Check list for the pull request

[ ] I have read the [CONTRIBUTING]
[ ] I have read the [CODE_OF_CONDUCT]
[ ] I have added tests for my changes
[ ] I have updated the documentation accordingly

Check list for the reviewer

[ ] I have read the [CONTRIBUTING]
[ ] I have verified the proposed changes
[ ] best software practices
- [ ] all internal functions have an underbar, as is python standard
- [ ] clearly named variables (better to be verbose in variable names)
- [ ] code comments explaining the intent of code blocks
[ ] All the tests are passing
[ ] The documentation is up to date
[ ] code comments added when explaining intent

Manual test for the reviewer

References

codecov-commenter commented 4 months ago

Codecov Report

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

Project coverage is 88.79%. Comparing base (dfd048f) to head (e430a77).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## next #153 +/- ## ======================================= Coverage 88.79% 88.79% ======================================= Files 23 23 Lines 1392 1392 ======================================= Hits 1236 1236 Misses 156 156 ```

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