-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
html documentation: modules table and prev-next links #1837
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
Comments
Added to the 1.3 blocker milestone. We should either fix or close before cutting |
Thanks for reporting these problems. I've investigated the next-previous link problem without success so far. I think we may have stumbled upon either a sphinx issue or a numpydoc issue. |
@NelleV : Thanks for the feedback ! By any chance, did you try adding (Should also solve #1896 - it works on my computer but not with current master as I am for the moment unable to build from the last source : a new windows issue.) |
@GBillotey works for me (I haven't checked it got rid of the warnings). Do you want to do the PR? |
Funny, I've just found this solution independently. Lets go for it - it removes thousands of warnings! |
Thanks! I had meant to look into this myself, but pleasantly pleased to find a solution has already been found! |
Yes, but unfortunately we have a whole bunch of other problems on our hand (but that aren't roadblocks for the release IMO) |
- Remove path to sample wavfile - Restore default parameters for *html_domain_indices* . The previous command was preventing np-modindex to appear as a second module index. This seems to be covered by 'numpydoc_show_class_members = False'. (See matplotlib/matplotlib#1837)
In my recent builds of the html documentation (sphynx 1.1.3, numpydoc 0.4) I have
noticed 2 issues (And thanks to @NelleV online builds, I know that I am at
least not the only one):
py-modindex and np-modindex (which in fact are identical).
If I am correct, this is related with sphynx new keyword
http://sphinx-doc.org/config.html?highlight=html_use_modindex#confval-html_domain_indices
Explicitely setting
html_domain_indices = ["py-modindex"]
in the buildconfiguration file config.py (line 162) seems to solve this.
http://matplotlib.org/api/ticker_api.html#module-matplotlib.ticker with
http://cbio.ensmp.fr/~nvaroquaux/matplotlib/doc/api/ticker_api.html#module-matplotlib.ticker
It seems that some prev-next relationships are no more included in the sphynx toc tree ; however this goes far beyond my understanding of the doc build.
The text was updated successfully, but these errors were encountered: