Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Tool doc/summarize.py does not work #15708

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
Closed
mwtoews opened this issue Mar 4, 2020 · 2 comments · Fixed by #15745
Closed

Tool doc/summarize.py does not work #15708

mwtoews opened this issue Mar 4, 2020 · 2 comments · Fixed by #15745
Labels
triaged Issue/PR that was discussed in a triage meeting

Comments

@mwtoews
Copy link
Contributor

mwtoews commented Mar 4, 2020

The command-line tool doc/summarize.py does not currently work:

Traceback (most recent call last):
  File "doc/summarize.py", line 16, in <module>
    from sphinxext.phantom_import import import_phantom_module
ModuleNotFoundError: No module named 'sphinxext.phantom_import'

the tool depends on sphinxext.phantom_import which was part of numpy/doc/sphinxext/ back in numpy 1.7.x, but has since moved on. Either this tool should be revised to work again, or considered to be removed.
@mwtoews mwtoews mentioned this issue Mar 4, 2020
Merged
6 tasks
@rossbar rossbar added triage review Issue/PR to be discussed at the next triage meeting triaged Issue/PR that was discussed in a triage meeting and removed triage review Issue/PR to be discussed at the next triage meeting labels Mar 7, 2020
@rossbar
Copy link
Contributor

rossbar commented Mar 11, 2020

The consensus seems to be that this script is very rarely used and not worth the effort to update.

Others have since gone through and identified missing/undocumented functions/attributes in, for example, #12385 and #10106 . In these cases, doc/summarize.py was not used. #10106 contains a short script that has been used instead of doc/summarize.py to generate the list of undocumented functions.

A PR to remove doc/summarize.py is welcome.

WarrenWeckesser added a commit to WarrenWeckesser/numpy that referenced this issue Mar 11, 2020
@WarrenWeckesser
MAINT: doc: Remove doc/summarize.py
1a22048 
The code in doc/summarize.py is no longer used and it is
not being maintained, so remove it.

Closes numpygh-15708.
@WarrenWeckesser WarrenWeckesser mentioned this issue Mar 11, 2020
Merged
@WarrenWeckesser
Copy link
Member

A PR to remove doc/summarize.py is welcome.

See #15745

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
triaged Issue/PR that was discussed in a triage meeting
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

MAINT: doc: Remove doc/summarize.py WarrenWeckesser/numpy
3 participants
@WarrenWeckesser @mwtoews @rossbar