Automodapi option to write out what automodapi is actually doing #1975
Conversation
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
Member
Author
|
Tests pass and this is pretty much just a special debugging option, so I'll just merge it. |
eteq
added a commit
that referenced
this pull request
Jan 21, 2014
Automodapi option to write out what automodapi is actually doing
Member
|
Nice! I was running into the same problem.I'll try this out while looking into #1826. |
astrofrog
pushed a commit
to astropy/sphinx-automodapi
that referenced
this pull request
Jan 27, 2018
Automodapi option to write out what automodapi is actually doing
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
While trying to diagnose #1826, I ended up getting frustrated with a bunch of hacks I had to do to see what
automodapiis doing. So this adds an option to just write out the result ofautomodapiinto the doc source directories. Of course it's off by default, because we don't want it confusing people, but the option will be valuable for debugging sphinx warnings and extensions.