Skip to content

docs: major improvment of the sphinx doc#197

Merged
mdevolde merged 1 commit into
jxmorris12:masterfrom
mdevolde:docs/sphinx
Jun 20, 2026
Merged

docs: major improvment of the sphinx doc#197
mdevolde merged 1 commit into
jxmorris12:masterfrom
mdevolde:docs/sphinx

Conversation

@mdevolde

Copy link
Copy Markdown
Collaborator

docs: major improvment of the sphinx doc

Why the pull request was made

To have more than just the API reference, and having some tutos/usages in the doc.

Summary of changes

  • Add multiple pages in sphinx doc (installation, examples, usages,...).
  • Remove redundant info from README, redirect users to the documentation.
  • Add a gif in the README/doc intro.
  • Improve inter-docs links in sphinx doc.
  • Fix sphinx building errors.
  • Fix doc in integrity.toml.
  • Remove useless actions in makefiles (about old coverage badge).

Screenshots (if appropriate):

Not applicable.

How has this been tested?

Built doc locally.

Resources

Not applicable.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (changes to documentation only)
  • Refactor / code style update (non-breaking change that improves code structure or readability)
  • Tests / CI improvement (adding or updating tests or CI configuration only)
  • Other (please describe):

Checklist

  • Followed the project's contributing guidelines.
  • Updated any relevant tests.
  • Updated any relevant documentation.
  • Added comments to your code where necessary.
  • Formatted your code, run the linters, checked types and tests.

@mdevolde mdevolde self-assigned this Jun 20, 2026
Comment thread docs/source/conf.py Dismissed
Comment thread docs/source/conf.py Dismissed
@codecov-commenter

codecov-commenter commented Jun 20, 2026

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.51%. Comparing base (635708c) to head (c8f22f6).
⚠️ Report is 1 commits behind head on master.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #197      +/-   ##
==========================================
+ Coverage   80.48%   80.51%   +0.03%     
==========================================
  Files          13       13              
  Lines        1732     1735       +3     
==========================================
+ Hits         1394     1397       +3     
  Misses        338      338              

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@mdevolde mdevolde merged commit ea04de4 into jxmorris12:master Jun 20, 2026
@mdevolde mdevolde deleted the docs/sphinx branch June 20, 2026 23:16
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.

3 participants