-
Notifications
You must be signed in to change notification settings - Fork 949
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
Minor docs updates #2669
Minor docs updates #2669
Conversation
How about also renaming the name of the conda environment to |
3ab2e21
to
8ed8222
Compare
I'll address the maps question over there, but #2660's solution to the double-widgets problem is definitely better than this one, so we'll want to incorporate that in some way. |
docs/source/developer_docs.rst
Outdated
@@ -7,7 +7,7 @@ The Jupyter widgets packages are developed in the `https://github.com/jupyter-wi | |||
Scope of ipywidgets | |||
------------------- | |||
|
|||
``ipywidgets`` is a framework to provide eventful python objects that have a representation in the browser (see :doc:`examples/Widget Basics.ipynb` for more on the definition of widgets). This requires two components: | |||
``ipywidgets`` is a framework to provide eventful python objects that have a representation in the browser (see "Simple Widget Introduction" in the :doc:`user_guide` for more on the definition of widgets). This requires two components: |
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.
You can simply drop the file extension to fix the link.
Sphinx document names don't include a file suffix.
http://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-doc
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.
Thanks; several of your fixes in #2660 are more elegant than what is in here...
@mwcraig I think the only thing still relevant in this PR is the password documentation? |
8ed8222
to
8c7811b
Compare
@pbugnion -- there are a few minor things which should be more apparent in this rebase. Ordering the dependencies alphabetically is a little...odd...but makes it easier to catch duplicate package names. |
@mwcraig thanks for clarifying and for pushing this through! It's probably worth noting that the docs don't build with conda (see PR #2708 ), so I'm not sure whether it's worth fixing the requirements here? We could merge just the password change and the broken link and hold off on the requirements fix until #2708 is merged? |
Why are you adding And BTW, alphabetic order is great! |
Apparently alphabetical order wasn't as useful as I thought because I skimmed right over it, need better 👓. Will remove in a moment. |
@pbugnion -- I don't have strong feelings about the conda fix; I was building the environment locally to test but it is honestly a hassle because you have to install the dev version of ipywidgets into this separate environment after you create it. I'm going to push the removal of Then 2 options, you choose:
I can do either of these but just need to know the preferred route. Either way we end up at correct documentation and simplified requirements. |
Looks great! I vote for 1 -- merging as is and rebasing 2708. Happy to merge when you're ready! |
73f55db
to
bcd6168
Compare
Merged in master. |
Thanks! |
This PR:
Temporarily fixes Documentation notebook output duplicated #2629 by pinning the version ofnbsphinx
to 0.4. The duplication reported in Documentation notebook output duplicated #2629 is happening becausenbsphinx
0.5 introduced a new feature, storing the widget in the notebook, so now bothjupyter_sphinx
andnbsphinx
are generating the widget.Fixes another broken link reported by sphinx.