search

deepskies / DeepDiagnostics

Inference diagnostics for mostly SBI
MIT License
1 stars 0 forks source link

Docstrings #76

Closed voetberg closed 5 months ago

voetberg commented 5 months ago

Docstrings and putting those docstrings in rst based auto-docs.

Docs can be seen locally by installing the project (according to the readme), and then running 

cd docs 
make html

This makes a folder in docs called html with the documentation. Open the index.html file in any web browser and click away.

Tried to make sure I had no grammar or spelling mistakes but that's a real high bar for my little brain sometimes. Feel free to review and tell me I've spelled something horrifically wrong.

bnord commented 5 months ago

It says

test / test (push) Failing after 2m

is that a problem?

voetberg commented 5 months ago

I should be fixed, if you check the test failure it's just because the CI check is not getting the install right - https://github.com/deepskies/DeepDiagnostics/actions/runs/9619697967/job/26536380866?pr=76#step:10:1 The issue is with the CICD pipeline not the code. (Though it still needs to be fixed).