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

Ignore more toolkit-specific modules in apidocs #527

Merged
merged 1 commit into from
Jan 7, 2021

Conversation

rahulporuri
Copy link
Contributor

@rahulporuri rahulporuri commented Dec 31, 2020

This PR updates the docs click command to ignore more modules when generating the api documentation - specifically the toolkit-specific modules

  • "enable/savage/trait_defs/ui/qt4"
  • "enable/savage/trait_defs/ui/wx"
  • "enable/trait_defs/ui/qt4"
  • "enable/trait_defs/ui/wx"

Note that we are including the following modules in the api docs even though they feel like they are implementation details - https://github.com/enthought/enable/tree/master/enable/savage/svg/backends

@codecov-io
Copy link

codecov-io commented Dec 31, 2020

Codecov Report

Merging #527 (3c94bdf) into master (c3c12e2) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #527   +/-   ##
=======================================
  Coverage   35.16%   35.16%           
=======================================
  Files         210      210           
  Lines       17840    17840           
  Branches     2454     2454           
=======================================
  Hits         6274     6274           
  Misses      11161    11161           
  Partials      405      405           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c3c12e2...3c94bdf. Read the comment docs.

@kitchoi
Copy link
Contributor

kitchoi commented Jan 4, 2021

In the long run I think we want to be able to generate API documentation for toolkit specific module. At the moment we aren't before the documentation config has not set up the mocking required when the toolkit backends are absent during documentation build.

These skips are therefore really meaning to silent warnings due to the ImportError, is that right?

Copy link
Contributor

@kitchoi kitchoi left a comment

Choose a reason for hiding this comment

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

LGTM; on the basis that enable has already been skipping documentation for toolkit specific components.

I am wondering if kiva/trait_defs/ui/wx needs to receive the same treatment, feel free to add this entry here post-approval.

Not entirely sure why toolkit-specific modules are skipped; but the fact that null is also skipped suggests to me that they are deemed implementation details to be hidden.

@jwiggins
Copy link
Member

jwiggins commented Jan 7, 2021

they are deemed implementation details to be hidden.

For the most part, yes. The only useful information about toolkits that a user of enable needs is their name [for toolkit selection]. Everything else should be abstracted away by the Window and GraphicsContext interfaces.

@rahulporuri
Copy link
Contributor Author

These skips are therefore really meaning to silent warnings due to the ImportError, is that right?

No, it's because they are implementation detail to be hidden, like you mentioned in a later comment.

I am wondering if kiva/trait_defs/ui/wx needs to receive the same treatment.

I left this as is because there is no interface for KivaFontEditor and there is not qt implementation. So, in this case, the implementation is the only way we can access/understand the relevant interface.

@rahulporuri rahulporuri merged commit d546da0 into master Jan 7, 2021
@rahulporuri rahulporuri deleted the doc/ignore-more-modules-in-apidocs branch January 7, 2021 13:08
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.

4 participants