Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docstrings #76

Merged
merged 11 commits into from
Jun 24, 2024
Merged

Docstrings #76

merged 11 commits into from
Jun 24, 2024

Conversation

voetberg
Copy link
Contributor

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.

@voetberg voetberg requested a review from bnord June 21, 2024 21:01
@bnord
Copy link
Contributor

bnord commented Jun 22, 2024

It says

test / test (push) Failing after 2m

is that a problem?

@voetberg
Copy link
Contributor Author

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).

This was referenced Jun 24, 2024
@voetberg voetberg merged commit 39b1924 into main Jun 24, 2024
3 checks passed
@voetberg voetberg mentioned this pull request Jun 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants