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.

Sign up for GitHub

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

Jump to bottom

update installation instruction #3849

Merged
merged 4 commits into from
Mar 9, 2020
Merged

update installation instruction #3849

merged 4 commits into from
Mar 9, 2020

Conversation

mathause
Copy link
Collaborator

@mathause mathause commented Mar 9, 2020

@mathause
Copy link
Collaborator Author

mathause commented Mar 9, 2020

I thought it best to remove the instructions

$ conda install -c conda-forge xarray cartopy pynio pseudonetcdf

completely - else people are going to copy-paste the line regardless of what's written in the text. Most people won't need these specific packages.

@raybellwaves, @keewis

keewis
keewis reviewed Mar 9, 2020
View reviewed changes
Copy link
Collaborator

@keewis keewis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

except from the link mentioned below this looks good to me

doc/installing.rst Outdated

.. _conda: http://conda.io/

We recommend using the community maintained `conda-forge <https://conda-forge.github.io/>`__ channel if you need difficult\-to\-build dependencies such as cartopy, pynio or PseudoNetCDF::
If you require other `optional dependencies <#Optional dependencies>`_ add them to the line above.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this link looks strange to me and I think it does not point anywhere. To fix it, I'd add a label in front of the Optional dependencies heading and then reference that:

`optional dependencies <optional-dependencies>`_

or

:doc:`optional-dependencies`

@mathause
Copy link
Collaborator Author

mathause commented Mar 9, 2020

Thanks for the quick feedback. I found somewhere that you can directly link to titles, but this is more explicit.

@raybellwaves
Copy link
Contributor

LGTM

@max-sixty
Copy link
Collaborator

👍

@keewis
Copy link
Collaborator

keewis commented Mar 9, 2020

I didn't know that, I thought that was limited to nbsphinx. It did work, though, the link pointed to some anchor; you just specified the wrong name.

I think you can also use a mixture of both:

:ref:`optional dependencies <optional-dependencies>`

Also, using :ref: should fix the build error.

@keewis
Copy link
Collaborator

keewis commented Mar 9, 2020

the docs build passed. Thanks, @mathause

@keewis keewis merged commit 1db010b into pydata:master Mar 9, 2020
dcherian added a commit to ej81/xarray that referenced this pull request Mar 14, 2020
@dcherian
Merge remote-tracking branch 'upstream/master' into fix-groupby-chang…
27412cc 
…e-size

* upstream/master: (24 commits)
  Fix alignment with join="override" when some dims are unindexed (pydata#3839)
  Fix CFTimeIndex-related errors stemming from updates in pandas (pydata#3764)
  Doctests fixes (pydata#3846)
  add xpublish to related projects (pydata#3850)
  update installation instruction (pydata#3849)
  Pint support for top-level functions (pydata#3611)
  un-xfail tests that append to netCDF files with scipy (pydata#3805)
  remove panel conversion (pydata#3845)
  Add nxarray to related-projects.rst (pydata#3848)
  Implement skipna kwarg in xr.quantile (pydata#3844)
  Allow `where` to receive a callable (pydata#3827)
  update macos image (pydata#3838)
  Label "Installed Versions" item in Issue template (pydata#3832)
  Add note on diff's n differing from pandas (pydata#3822)
  DOC: Add rioxarray and other external examples (pydata#3757)
  Use stable RTD image.
  removed mention that 'dims' are inferred from 'coords'-dict when omit… (pydata#3821)
  Coarsen keep attrs 3376 (pydata#3801)
  Turn on html repr by default (pydata#3812)
  Fix zarr append with groups (pydata#3610)
  ...
@mathause mathause deleted the doc/pynio-not-on-windows branch October 18, 2021 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@keewis keewis keewis left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

pynio package not found
4 participants
@mathause @raybellwaves @max-sixty @keewis