Repository navigation
Auto outside pkg - #2370
Merged
Merged
Auto outside pkg#2370
Conversation
|
I finally had a chance to test this out, and it's great! Thanks for putting this together. |
Member
Author
|
Note that the sphinx build failed, but because of an unrelated problem in master (fixed in 8d45943) |
Member
|
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. |
Member
Author
|
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]
Member
Author
|
Hmm, an interesting quirk of Travis that I had not noticed before: If you use |
Member
Author
|
Alright, it's now actually passing, so merging! |
eteq
added a commit
that referenced
this pull request
Apr 28, 2014
Allow automodapi to document objects not in the package being documented
astrofrog
pushed a commit
to astropy/sphinx-automodapi
that referenced
this pull request
Jan 27, 2018
Allow automodapi to document objects not in the package being documented
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
At the request of @ChrisBeaumont, I've re-written the part of #1801 that allows using
automodapito 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.pyis something like:If you just do
.. automodapi:: namespacein master, nothing will appear, becauseimplementation1andimplementation2members aren't included. But after this, if you do:Anything that's acutally in
implementation1will show up on the module summary.