search

logsdail / carmm

Scripts for creation, manipulation and analysis of geometric and electronic structure of molecular models
GNU General Public License v3.0
5 stars 18 forks source link

Sphinx documentation #105

Closed ikowalec closed 8 months ago

ikowalec commented 1 year ago

Proof of concept.

Must figure out the configuration of the .yml file for docs rebuild on pull to master.

codecov[bot] commented 1 year ago

Codecov Report

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

Project coverage is 87.90%. Comparing base (6c6e942) to head (5fc9ae2).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #105 +/- ## ======================================= Coverage 87.90% 87.90% ======================================= Files 76 76 Lines 3149 3149 ======================================= Hits 2768 2768 Misses 381 381 ``` | [Flag](https://app.codecov.io/gh/logsdail/carmm/pull/105/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Andrew+Logsdail) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/logsdail/carmm/pull/105/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Andrew+Logsdail) | `87.90% <ø> (ø)` | | 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=Andrew+Logsdail#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.

logsdail commented 1 year ago

@ikowalec Can we update and push this? It might help others with using the codebase?

ikowalec commented 1 year ago

I will update this week and will look into automating rebuilds. The branch can be merged once done.