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

fix toctrees warnings during documentation generation #21

Closed
sdrave opened this issue Apr 9, 2013 · 3 comments
Closed

fix toctrees warnings during documentation generation #21

sdrave opened this issue Apr 9, 2013 · 3 comments
Labels

Comments

@sdrave
Copy link
Member

sdrave commented Apr 9, 2013

There seems to be a clash between numpydoc and autosummary, resulting in over 8000 warnings of the form:

<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'generated/pymor.discreteoperators.basic.GenericLinearOperator.apply'

@sdrave
Copy link
Member Author

sdrave commented Apr 9, 2013

The warnings are eliminated if the following lines of code are commented out in numpydoc.docscrape_sphinx.SphinxDocSting._str_member_list():

if autosum:
    out += ['.. autosummary::', '   :toctree:', '']
    out += autosum

renefritze added a commit that referenced this issue Apr 17, 2013
brings the warning count from down from
8210 to 114
@sdrave
Copy link
Member Author

sdrave commented Apr 22, 2013

Much better now! However still a slight annoyance since the real warnings are mixed with the toctree warnings, so I remove the milestone tag but leave the bug open for now.

@sdrave
Copy link
Member Author

sdrave commented Nov 21, 2013

With bd5f415, documentation now builds without warnings. Still looks horrible, however.

@sdrave sdrave closed this as completed Nov 21, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant