-
-
Notifications
You must be signed in to change notification settings - Fork 152
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.
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
WARNING: toctree contains reference to nonexisting document #5
Comments
From this SO question, most of them can be suppressed by setting |
IPython uses some lists of class attributes and methods, but we don't generate separate doc pages for each entry, so Sphinx throws warnings about "toctree contains reference to nonexisting document". This adds a Sphinx option called 'numpydoc_class_members_toctree', defaulting to True, controlling whether the autosummary lists are generated with the :toctree: option. Setting it to False suppresses these warnings, but prevents the lists acting as tables of contents. Addresses issue numpygh-5.
My PR #6 adds a |
Addressed in gh-6 |
Thank you. Now I can see all the real problems with my docs ;-) |
[napoleon](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html) [resolves](https://stackoverflow.com/q/12206334/2019542) [issues](numpy/numpydoc#5) with [numpydoc](https://numpydoc.readthedocs.io), but it's pickier about some things.
* Remove file that hasn't been used in 15 years? * Switch from numpydoc to napoleon [napoleon](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html) [resolves](https://stackoverflow.com/q/12206334/2019542) [issues](numpy/numpydoc#5) with [numpydoc](https://numpydoc.readthedocs.io), but it's pickier about some things. * Update title page to customize `\sphinxmaketitle` * Move CHANGELOG from part to chapter * Document __special__ members Fixes #457 * Clean up recursive mess Fixes #601 * Add documentation to CI Fixes #552 * Add sphinx and prerequisites * Fix typo * Install sphinx on Py3k * Install future package * Re-re-re-activate conda environment * (Try to) keep MayaviViewer docs from seg faulting * Install and run xvbf the CirclCI way(?) * Fix typo * Remove xvfb, replace with null ETS toolkit * Add SIunits.sty * Store built documentation * Fetch tags * Fix typo * Update static copies of sources from NIST Drupal * Bring up to date with NIST Drupal * Move Drupalish boilerplate for more consistency with NIST site * Remove `NIST Menu` It doesn't work and it interferes with Sphinx search * Fix some HTML errors
I get thousands of these warnings when I compile my docs with the numpydoc extension. Numpydoc appears to descend into every nook and cranny of our code base, and adds items to the toctree when it finds them? For instance, most of these warnings pertain to object attributes, like this:
None:None: WARNING: toctree contains reference to nonexisting document u'library/spreg/pysal.spreg.twosls_sp.GM_Lag.pfora1a2'
Is there a way to stop this?
The text was updated successfully, but these errors were encountered: