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

Sphinx documentation #105

Merged
merged 67 commits into from
Mar 4, 2024
Merged

Sphinx documentation #105

merged 67 commits into from
Mar 4, 2024

Conversation

ikowalec
Copy link
Collaborator

@ikowalec ikowalec commented Mar 8, 2023

Proof of concept.

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

@codecov
Copy link

codecov bot commented Mar 8, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #105   +/-   ##
=======================================
  Coverage   87.90%   87.90%           
=======================================
  Files          76       76           
  Lines        3149     3149           
=======================================
  Hits         2768     2768           
  Misses        381      381           
Flag Coverage Δ
unittests 87.90% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@logsdail
Copy link
Owner

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

@ikowalec
Copy link
Collaborator Author

ikowalec commented Jul 3, 2023

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

@ikowalec ikowalec requested a review from logsdail March 4, 2024 16:53
Copy link
Owner

@logsdail logsdail left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice - thanks also for picking up the old naming conventions in .yml files.

@ikowalec ikowalec merged commit 4d5b506 into main Mar 4, 2024
4 checks passed
@ikowalec ikowalec deleted the ikowalec-docs branch March 4, 2024 17:00
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.

None yet

2 participants