-
Notifications
You must be signed in to change notification settings - Fork 7
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
Remove duplicates in documenting trait members #1
Remove duplicates in documenting trait members #1
Conversation
- When run with the `:members:`, then traitlets traits are duplicated, because they are added to the autodoc list from both from `:members:` and this autodetection. (I think) - Discussed in at least jupyterhub/jupyterhub#2726. Currently causing JupyterHub docs to fail, because sphinx gives an error if there are duplicate autodoced traits and it is run with `-W`. - This seems to be started in a new version of sphinx, but we aren't completly sure. JH has been using the `-W` option since 2017. - I'm unsure if this is the right solution, but it works and gets me past these errors.
This needs proper testing. I edited live source files to test, then copied to here. Beware! |
If this fixes the problem in the JupyterHub docs build I would vote for merging this. My hunch is this is one of the packages that mostly only JupyterHub (or the JupyterHub ecosystem) uses. So if we break it more than it is already broken we will notice. Let's see if Carol has time and thoughts. |
This change seems reasonable to me. I made some general comments in #3021.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Though I did not build locally for this review.
I"ve been testing with a manual pip install https://... from JH, and it works. Last night, I thought that the sorting/ordering might need adjusting (if it's not sorted in the consumer), but... having the trait_members first actually sort of makes sense, so I guess it's not a big deal. My concern about trivial syntax errors is resolved now, so if a minimal test is enough, I'd say this is OK to go. |
Merged. We are riding the elevator UPwards in the rabbit hole :) |
:members:
, then traitlets traits are duplicated,because they are added to the autodoc list from both from
:members:
and this autodetection. (I think)Jupyter(Hub) conceptual intro jupyterhub#2726. Currently
causing JupyterHub docs to fail, because sphinx gives an error if
there are duplicate autodoced traits and it is run with
-W
.completly sure. JH has been using the
-W
option since 2017.past these errors.