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

Use sphinxcontrib.apidoc to automatically generate API docs for entire package #296

Merged
merged 5 commits into from
Dec 23, 2024

Conversation

tpvasconcelos
Copy link
Owner

@tpvasconcelos tpvasconcelos commented Dec 22, 2024

Description

Related issues

Closes #290

PR check list

  • Read the contributing guidelines.
    • You don't have to read the whole thing, but it's a good idea to skim it. And definitely take a look at it if you're experiencing any issues getting your local environment up and running.
  • Provided the relevant details in the PR's description.
  • Referenced relevant issues in the PR's description.
  • Added tests for all my changes.
    • The CI will fail unless 100% of all new code is covered by the tests.
  • Updated the docs for relevant changes.
    • New modules (or renamed ones) are included in docs/api/internal/.
    • New public functions/classes/variables are documented in docs/api/index.rst.
    • Added the appropriate versionadded, versionchanged, or deprecated directives to docstrings.
      • The version should be the next release version, which you can infer by bumping the minor version in MAJOR.MINOR.PATCH (e.g., if the current version is 0.2.3, the next release will be 0.3.0).
  • Changes are documented in docs/reference/changelog.md.
    • Please try to follow the conventions laid out in the file. In doubt, just ask!
  • Consider granting push permissions to your PR's branch, so maintainers can help you out if needed.
  • The CI check are all passing, or I'm working on fixing them!
  • I have reviewed my own code! 🤠

📚 Documentation preview 📚: https://ridgeplot--296.org.readthedocs.build/en/296/

@tpvasconcelos tpvasconcelos linked an issue Dec 22, 2024 that may be closed by this pull request
@tpvasconcelos tpvasconcelos marked this pull request as ready for review December 22, 2024 01:57

This comment has been minimized.

Copy link

codecov bot commented Dec 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (13427ce) to head (72cef55).
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #296   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           18        18           
  Lines          648       648           
  Branches        78        78           
=========================================
  Hits           648       648           
Flag Coverage Δ
combined-src 99.84% <100.00%> (ø)

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.

@tpvasconcelos tpvasconcelos merged commit e942b58 into main Dec 23, 2024
20 checks passed
@tpvasconcelos tpvasconcelos deleted the 290-apidocs branch December 23, 2024 00:39
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.

Automatically generate the docs/api/internal/*.rst files
1 participant