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

html documentation: modules table and prev-next links #1837

Closed
GBillotey opened this issue Mar 20, 2013 · 8 comments
Closed

html documentation: modules table and prev-next links #1837

GBillotey opened this issue Mar 20, 2013 · 8 comments

Comments

@GBillotey
Copy link
Contributor

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):

@pelson
Copy link
Member

pelson commented Apr 17, 2013

Added to the 1.3 blocker milestone. We should either fix or close before cutting v1.3.

@NelleV
Copy link
Member

NelleV commented Apr 23, 2013

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.

@GBillotey
Copy link
Contributor Author

@NelleV : Thanks for the feedback !

By any chance, did you try adding numpydoc_show_class_members = False in config.py ?
Seems it did help, at least in this case:
phn/pytpm#3 (comment)

(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.)

@NelleV
Copy link
Member

NelleV commented Apr 26, 2013

@GBillotey works for me (I haven't checked it got rid of the warnings). Do you want to do the PR?

@pelson
Copy link
Member

pelson commented Apr 26, 2013

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!

@mdboom
Copy link
Member

mdboom commented Apr 26, 2013

Thanks! I had meant to look into this myself, but pleasantly pleased to find a solution has already been found!

@mdboom
Copy link
Member

mdboom commented May 3, 2013

Just to confirm before I close this: @NelleV, @pelson: #1918 resolves this bug?

@NelleV
Copy link
Member

NelleV commented May 3, 2013

Yes, but unfortunately we have a whole bunch of other problems on our hand (but that aren't roadblocks for the release IMO)

@mdboom mdboom closed this as completed May 3, 2013
thomasfillon added a commit to yomguy/TimeSide that referenced this issue Jan 16, 2015
- 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)
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

4 participants