numpy / numpy/numpydoc

toctree contains reference to nonexisting document

Open
#69 23 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
355
Forks
181
Avg merge
1d 9h
Merged PRs (30d)
3

Description

I'm still trying to migrate scikit-learn to numpydoc master.
I'm having some trouble with this issue:
http://stackoverflow.com/questions/12206334/sphinx-autosummary-toctree-contains-reference-to-nonexisting-document-warnings

Apparently something goes wrong with when autosummary is called?
That didn't use to be the case.
I can't really do numpydoc_show_class_members = False because then there is no method table any more :(

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the autosummary migration described in the issue and review the linked Sphinx warning discussion. Investigate why the toctree references a nonexistent document while class members are shown. Done means the warning is resolved without disabling the method table.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.