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
Auto outside pkg #2370
Auto outside pkg #2370
Conversation
I finally had a chance to test this out, and it's great! Thanks for putting this together. |
Note that the sphinx build failed, but because of an unrelated problem in master (fixed in 8d45943) |
Sounds good to me. Just as a reminder to myself, this will have to be pulled into astropy-helpers as well. But it should also be here for backward-compatibility. |
I'm going to rebase this against master just to make sure the sphinx build passes against the latest master, and if so I'll merge this, then. |
[ci skip]
Hmm, an interesting quirk of Travis that I had not noticed before: If you use |
Alright, it's now actually passing, so merging! |
Allow automodapi to document objects not in the package being documented
Allow automodapi to document objects not in the package being documented
At the request of @ChrisBeaumont, I've re-written the part of #1801 that allows using
automodapi
to document things that are not actually in the package you're documenting.This is useful for "namespace modules", e.g., where you have something like:
where
namespace.py
is something like:If you just do
.. automodapi:: namespace
in master, nothing will appear, becauseimplementation1
andimplementation2
members aren't included. But after this, if you do:Anything that's acutally in
implementation1
will show up on the module summary.