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.

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

Closed
pastephens opened this issue Dec 13, 2013 · 4 comments
Closed

WARNING: toctree contains reference to nonexisting document #5

pastephens opened this issue Dec 13, 2013 · 4 comments

Comments

@pastephens
Copy link

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?

@takluyver
Copy link
Contributor

From this SO question, most of them can be suppressed by setting numpydoc_show_class_members = False in the conf.py file. However, in IPython that still leaves a few warnings.

takluyver added a commit to takluyver/numpydoc that referenced this issue Jan 6, 2014
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.
@takluyver
Copy link
Contributor

My PR #6 adds a numpydoc_class_members_toctree option, to keep the autosummary tables of methods and attributes, but not try to make them a table of contents.

@pv
Copy link
Member

pv commented Jan 7, 2014

Addressed in gh-6

@pastephens
Copy link
Author

Thank you. Now I can see all the real problems with my docs ;-)

guyer added a commit to guyer/fipy that referenced this issue May 13, 2019
guyer added a commit to usnistgov/fipy that referenced this issue Jun 13, 2019
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants