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.

Sign up for GitHub

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

Jump to bottom

autosummary with toctree always lists imported members #2336

Closed
lsaffre opened this issue Feb 18, 2016 · 6 comments · Fixed by #3235
Closed

autosummary with toctree always lists imported members #2336

lsaffre opened this issue Feb 18, 2016 · 6 comments · Fixed by #3235
Labels
extensions:autodoc

Comments

@lsaffre
Copy link
Contributor

lsaffre commented Feb 18, 2016

I continue to have the problem which I tried to describe in #2144. At that time there was some hassle because my patch caused problems elsewjere. Opening a new ticket, this time with a (hopefully) clean patch. It is inspired by
http://stackoverflow.com/questions/25405110/sphinx-autosummary-with-toctree-also-lists-imported-members and the solution described there. The patch is against today's master from github.
20160218.txt
@tbetbetbe
Copy link

I'm seeing this as well. Thanks for the patch!
FYI @vsubramani

@lsaffre
Copy link
Contributor Author

lsaffre commented Aug 22, 2016

NB: how I apply the patch:
$ patch -p1 < 20160218.txt
I had to apply it myself again after updating my copy of the repository. Note also that if you had the problem and applied the patch, you must remove the files generated by autosummary so that they get generated again without imported members.

@lsaffre
Copy link
Contributor Author

lsaffre commented Oct 1, 2016

What a pity, this problem is still open in Sphinx 1.5a2. Is there any problem with my patch?

@lsaffre
Copy link
Contributor Author

lsaffre commented Oct 1, 2016

Here is a slightly modified patch which fixes a failure in the Sphinx test suite caused by my first patch.

20160218_autosummary.txt

@lsaffre
Copy link
Contributor Author

lsaffre commented Dec 12, 2016

Here is above patch, adapted for 1.6 (currently in development)
fix2336_autosummary.txt

lsaffre added a commit to lsaffre/sphinx that referenced this issue Dec 13, 2016
@lsaffre
fix sphinx-doc#2336 autosummary imported members
2390c55
@lsaffre lsaffre mentioned this issue Dec 13, 2016
Merged
shimizukawa added a commit that referenced this issue Dec 13, 2016
@shimizukawa
Merge pull request #3235 from lsaffre/master
60ae843 
fix #2336 autosummary imported members
shimizukawa added a commit that referenced this issue Dec 13, 2016
@shimizukawa
Fix #1061, #2336, #3235: Now generation of autosummary doesn't contai…
938d44e 
…n imported members by default. Thanks to Luc Saffre.
@shimizukawa
Copy link
Member

Fixed by #3235. Thanks to @lsaffre !

@shimizukawa shimizukawa mentioned this issue Dec 13, 2016
Closed
shimizukawa added a commit that referenced this issue Dec 18, 2016
@shimizukawa
refs #2336: Add imported_members option to sphinx-autogen com…
4ece701 
…mand to document imported members.
@arcivanov arcivanov mentioned this issue Jan 28, 2017
Closed
dopplershift added a commit to kgoebber/MetPy that referenced this issue May 19, 2017
@dopplershift
MNT: Fix for sphinx 1.6
7fee8d2 
Sphinx 1.6 broke our autosummary generation by no longer including
imported names by default (sphinx-doc/sphinx#2336). Consequently, we
now need to run sphinx-autogen manually to get it to do what we need.
dopplershift added a commit to dopplershift/MetPy that referenced this issue May 19, 2017
@dopplershift
MNT: Fix for sphinx 1.6
a15427b 
Sphinx 1.6 broke our autosummary generation by no longer including
imported names by default (sphinx-doc/sphinx#2336). Consequently, we
now need to run sphinx-autogen manually to get it to do what we need.
@jorisvandenbossche jorisvandenbossche mentioned this issue Nov 17, 2017
Merged
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 1, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
extensions:autodoc
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix #2336 autosummary imported members lsaffre/sphinx
4 participants
@shimizukawa @tk0miya @lsaffre @tbetbetbe