aiidalab / aiidalab-widgets-base

Reusable widgets for AiiDAlab applications
MIT License
6 stars 17 forks source link

Hide private methods in API documentation #606

Closed danielhollas closed 1 month ago

danielhollas commented 1 month ago

I noticed that the current API documentation is extremely messy, because it includes all the private methods. I am not sure what was the original motivation for this, but I'd suggest to remove it.

New version: https://aiidalab-widgets-base--606.org.readthedocs.build/en/606/apidoc/aiidalab_widgets_base.html

(NOTE: In the process I also simplified the sphinx-apidoc invocation)

(This PR is staged on top of #604)

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 96.21%. Comparing base (31ed98b) to head (3e87458).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## uv-docs #606 +/- ## ======================================== Coverage 96.21% 96.21% ======================================== Files 11 11 Lines 1188 1188 ======================================== Hits 1143 1143 Misses 45 45 ``` | [Flag](https://app.codecov.io/gh/aiidalab/aiidalab-widgets-base/pull/606/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aiidalab) | Coverage Δ | | |---|---|---| | [python-3.10](https://app.codecov.io/gh/aiidalab/aiidalab-widgets-base/pull/606/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aiidalab) | `96.21% <ø> (ø)` | | | [python-3.9](https://app.codecov.io/gh/aiidalab/aiidalab-widgets-base/pull/606/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aiidalab) | `96.21% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aiidalab#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

danielhollas commented 1 month ago

The build is failing due to following warning (which was there before, but is now more expose because we call sphinx-apidoc directly and not via subprocess)

checking consistency...docs/source/apidoc/modules.rst:
WARNING: document isn't included in any toctree

Not sure how to fix this so I'll filter it for now.

EDIT: Never mind, I fixed it