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

Hide private methods in API documentation #607

Merged
merged 10 commits into from
May 22, 2024

Conversation

danielhollas
Copy link
Contributor

@danielhollas danielhollas commented May 16, 2024

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

Additional changes:

  • simplified the sphinx-apidoc invocation
  • basic pins for docs dependencies to make the build more future-proof

Copy link

codecov bot commented May 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.21%. Comparing base (7c9a3ef) to head (86146db).
Report is 19 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #607   +/-   ##
=======================================
  Coverage   96.21%   96.21%           
=======================================
  Files          11       11           
  Lines        1188     1188           
=======================================
  Hits         1143     1143           
  Misses         45       45           
Flag Coverage Δ
python-3.10 96.21% <ø> (ø)
python-3.9 96.21% <ø> (ø)

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.

Copy link
Member

@unkcpz unkcpz left a comment

Choose a reason for hiding this comment

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

@danielhollas thanks! all good.

@danielhollas danielhollas merged commit 102a7f5 into aiidalab:master May 22, 2024
11 checks passed
@danielhollas danielhollas deleted the apidocs-hide-private branch May 22, 2024 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants