Skip to content

Commit d479009

Browse files
jhammanpre-commit-ci[bot]andersy005
authored
[docs] update urls throughout documentation (pydata#6262)
* update urls throughout documentation * more url updates * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update doc/internals/how-to-add-new-backend.rst * Apply suggestions from code review Co-authored-by: Anderson Banihirwe <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Anderson Banihirwe <[email protected]>
1 parent 44a3e3b commit d479009

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+162
-163
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Xarray's contributor guidelines [can be found in our online documentation](http://xarray.pydata.org/en/stable/contributing.html)
1+
Xarray's contributor guidelines [can be found in our online documentation](http://docs.xarray.dev/en/stable/contributing.html)

README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ xarray: N-D labeled arrays and datasets
66
.. image:: https://codecov.io/gh/pydata/xarray/branch/main/graph/badge.svg
77
:target: https://codecov.io/gh/pydata/xarray
88
.. image:: https://readthedocs.org/projects/xray/badge/?version=latest
9-
:target: https://xarray.pydata.org/
9+
:target: https://docs.xarray.dev/
1010
.. image:: https://img.shields.io/badge/benchmarked%20by-asv-green.svg?style=flat
1111
:target: https://pandas.pydata.org/speed/xarray/
1212
.. image:: https://img.shields.io/pypi/v/xarray.svg
@@ -69,12 +69,12 @@ powerful and concise interface. For example:
6969
Documentation
7070
-------------
7171

72-
Learn more about xarray in its official documentation at https://xarray.pydata.org/
72+
Learn more about xarray in its official documentation at https://docs.xarray.dev/
7373

7474
Contributing
7575
------------
7676

77-
You can find information about contributing to xarray at our `Contributing page <https://xarray.pydata.org/en/latest/contributing.html#>`_.
77+
You can find information about contributing to xarray at our `Contributing page <https://docs.xarray.dev/en/latest/contributing.html#>`_.
7878

7979
Get in touch
8080
------------

asv_bench/asv.conf.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"project": "xarray",
88

99
// The project's homepage
10-
"project_url": "http://xarray.pydata.org/",
10+
"project_url": "http://docs.xarray.dev/",
1111

1212
// The URL or local path of the source code repository for the
1313
// project being benchmarked

ci/install-upstream-wheels.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ python -m pip install \
4040
git+https://github.com/dask/distributed \
4141
git+https://github.com/zarr-developers/zarr \
4242
git+https://github.com/Unidata/cftime \
43-
git+https://github.com/mapbox/rasterio \
43+
git+https://github.com/rasterio/rasterio \
4444
git+https://github.com/pypa/packaging \
4545
git+https://github.com/hgrecco/pint \
4646
git+https://github.com/pydata/bottleneck \

design_notes/flexible_indexes_notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ A possible, more explicit solution to reuse a `pandas.MultiIndex` in a DataArray
133133

134134
New indexes may also be built from existing sets of coordinates or variables in a Dataset/DataArray using the `.set_index()` method.
135135

136-
The [current signature](http://xarray.pydata.org/en/stable/generated/xarray.DataArray.set_index.html#xarray.DataArray.set_index) of `.set_index()` is tailored to `pandas.MultiIndex` and tied to the concept of a dimension-index. It is therefore hardly reusable as-is in the context of flexible indexes proposed here.
136+
The [current signature](http://docs.xarray.dev/en/stable/generated/xarray.DataArray.set_index.html#xarray.DataArray.set_index) of `.set_index()` is tailored to `pandas.MultiIndex` and tied to the concept of a dimension-index. It is therefore hardly reusable as-is in the context of flexible indexes proposed here.
137137

138138
The new signature may look like one of these:
139139

doc/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
xarray
44
------
55

6-
You can find information about building the docs at our `Contributing page <http://xarray.pydata.org/en/latest/contributing.html#contributing-to-the-documentation>`_.
6+
You can find information about building the docs at our `Contributing page <http:/docs.xarray.dev/en/latest/contributing.html#contributing-to-the-documentation>`_.

doc/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -260,12 +260,12 @@
260260

261261

262262
# configuration for sphinxext.opengraph
263-
ogp_site_url = "https://xarray.pydata.org/en/latest/"
264-
ogp_image = "https://xarray.pydata.org/en/stable/_static/dataset-diagram-logo.png"
263+
ogp_site_url = "https://docs.xarray.dev/en/latest/"
264+
ogp_image = "https://docs.xarray.dev/en/stable/_static/dataset-diagram-logo.png"
265265
ogp_custom_meta_tags = [
266266
'<meta name="twitter:card" content="summary_large_image" />',
267267
'<meta property="twitter:site" content="@xarray_dev" />',
268-
'<meta name="image" property="og:image" content="https://xarray.pydata.org/en/stable/_static/dataset-diagram-logo.png" />',
268+
'<meta name="image" property="og:image" content="https://docs.xarray.dev/en/stable/_static/dataset-diagram-logo.png" />',
269269
]
270270

271271
# Redirects for pages that were moved to new locations

doc/contributing.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -95,14 +95,14 @@ version control to allow many people to work together on the project.
9595

9696
Some great resources for learning Git:
9797

98-
* the `GitHub help pages <http://help.github.com/>`_.
99-
* the `NumPy's documentation <http://docs.scipy.org/doc/numpy/dev/index.html>`_.
100-
* Matthew Brett's `Pydagogue <http://matthew-brett.github.io/pydagogue/>`_.
98+
* the `GitHub help pages <https://help.github.com/>`_.
99+
* the `NumPy's documentation <https://numpy.org/doc/stable/dev/index.html>`_.
100+
* Matthew Brett's `Pydagogue <https://matthew-brett.github.io/pydagogue/>`_.
101101

102102
Getting started with Git
103103
------------------------
104104

105-
`GitHub has instructions <http://help.github.com/set-up-git-redirect>`__ for installing git,
105+
`GitHub has instructions <https://help.github.com/set-up-git-redirect>`__ for installing git,
106106
setting up your SSH key, and configuring git. All these steps need to be completed before
107107
you can work seamlessly between your local repository and GitHub.
108108

@@ -455,7 +455,7 @@ it is worth getting in the habit of writing tests ahead of time so that this is
455455
Like many packages, *xarray* uses `pytest
456456
<http://doc.pytest.org/en/latest/>`_ and the convenient
457457
extensions in `numpy.testing
458-
<http://docs.scipy.org/doc/numpy/reference/routines.testing.html>`_.
458+
<https://numpy.org/doc/stable/reference/routines.testing.html>`_.
459459

460460
Writing tests
461461
~~~~~~~~~~~~~
@@ -855,15 +855,15 @@ GitHub. To delete it there do::
855855
PR checklist
856856
------------
857857
858-
- **Properly comment and document your code.** See `"Documenting your code" <https://xarray.pydata.org/en/stable/contributing.html#documenting-your-code>`_.
859-
- **Test that the documentation builds correctly** by typing ``make html`` in the ``doc`` directory. This is not strictly necessary, but this may be easier than waiting for CI to catch a mistake. See `"Contributing to the documentation" <https://xarray.pydata.org/en/stable/contributing.html#contributing-to-the-documentation>`_.
858+
- **Properly comment and document your code.** See `"Documenting your code" <https://docs.xarray.dev/en/stable/contributing.html#documenting-your-code>`_.
859+
- **Test that the documentation builds correctly** by typing ``make html`` in the ``doc`` directory. This is not strictly necessary, but this may be easier than waiting for CI to catch a mistake. See `"Contributing to the documentation" <https://docs.xarray.dev/en/stable/contributing.html#contributing-to-the-documentation>`_.
860860
- **Test your code**.
861861
862-
- Write new tests if needed. See `"Test-driven development/code writing" <https://xarray.pydata.org/en/stable/contributing.html#test-driven-development-code-writing>`_.
862+
- Write new tests if needed. See `"Test-driven development/code writing" <https://docs.xarray.dev/en/stable/contributing.html#test-driven-development-code-writing>`_.
863863
- Test the code using `Pytest <http://doc.pytest.org/en/latest/>`_. Running all tests (type ``pytest`` in the root directory) takes a while, so feel free to only run the tests you think are needed based on your PR (example: ``pytest xarray/tests/test_dataarray.py``). CI will catch any failing tests.
864864
- By default, the upstream dev CI is disabled on pull request and push events. You can override this behavior per commit by adding a <tt>[test-upstream]</tt> tag to the first line of the commit message. For documentation-only commits, you can skip the CI per commit by adding a "[skip-ci]" tag to the first line of the commit message.
865865
866-
- **Properly format your code** and verify that it passes the formatting guidelines set by `Black <https://black.readthedocs.io/en/stable/>`_ and `Flake8 <http://flake8.pycqa.org/en/latest/>`_. See `"Code formatting" <https://xarray.pydata.org/en/stablcontributing.html#code-formatting>`_. You can use `pre-commit <https://pre-commit.com/>`_ to run these automatically on each commit.
866+
- **Properly format your code** and verify that it passes the formatting guidelines set by `Black <https://black.readthedocs.io/en/stable/>`_ and `Flake8 <http://flake8.pycqa.org/en/latest/>`_. See `"Code formatting" <https://docs.xarray.dev/en/stablcontributing.html#code-formatting>`_. You can use `pre-commit <https://pre-commit.com/>`_ to run these automatically on each commit.
867867
868868
- Run ``pre-commit run --all-files`` in the root directory. This may modify some files. Confirm and commit any formatting changes.
869869

doc/ecosystem.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ Geosciences
2020
- `infinite-diff <https://github.com/spencerahill/infinite-diff>`_: xarray-based finite-differencing, focused on gridded climate/meteorology data
2121
- `marc_analysis <https://github.com/darothen/marc_analysis>`_: Analysis package for CESM/MARC experiments and output.
2222
- `MetPy <https://unidata.github.io/MetPy/dev/index.html>`_: A collection of tools in Python for reading, visualizing, and performing calculations with weather data.
23-
- `MPAS-Analysis <http://mpas-analysis.readthedocs.io>`_: Analysis for simulations produced with Model for Prediction Across Scales (MPAS) components and the Accelerated Climate Model for Energy (ACME).
24-
- `OGGM <http://oggm.org/>`_: Open Global Glacier Model
23+
- `MPAS-Analysis <https://mpas-dev.github.io/MPAS-Analysis>`_: Analysis for simulations produced with Model for Prediction Across Scales (MPAS) components and the Accelerated Climate Model for Energy (ACME).
24+
- `OGGM <https://oggm.org/>`_: Open Global Glacier Model
2525
- `Oocgcm <https://oocgcm.readthedocs.io/>`_: Analysis of large gridded geophysical datasets
2626
- `Open Data Cube <https://www.opendatacube.org/>`_: Analysis toolkit of continental scale Earth Observation data from satellites.
2727
- `Pangaea: <https://pangaea.readthedocs.io/en/latest/>`_: xarray extension for gridded land surface & weather model output).
28-
- `Pangeo <https://pangeo-data.github.io>`_: A community effort for big data geoscience in the cloud.
28+
- `Pangeo <https://pangeo.io>`_: A community effort for big data geoscience in the cloud.
2929
- `PyGDX <https://pygdx.readthedocs.io/en/latest/>`_: Python 3 package for
3030
accessing data stored in GAMS Data eXchange (GDX) files. Also uses a custom
3131
subclass.
@@ -41,13 +41,13 @@ Geosciences
4141
- `wradlib <https://wradlib.org/>`_: An Open Source Library for Weather Radar Data Processing.
4242
- `wrf-python <https://wrf-python.readthedocs.io/>`_: A collection of diagnostic and interpolation routines for use with output of the Weather Research and Forecasting (WRF-ARW) Model.
4343
- `xarray-simlab <https://xarray-simlab.readthedocs.io>`_: xarray extension for computer model simulations.
44-
- `xarray-spatial <https://makepath.github.io/xarray-spatial>`_: Numba-accelerated raster-based spatial processing tools (NDVI, curvature, zonal-statistics, proximity, hillshading, viewshed, etc.)
45-
- `xarray-topo <https://gitext.gfz-potsdam.de/sec55-public/xarray-topo>`_: xarray extension for topographic analysis and modelling.
44+
- `xarray-spatial <https://xarray-spatial.org/>`_: Numba-accelerated raster-based spatial processing tools (NDVI, curvature, zonal-statistics, proximity, hillshading, viewshed, etc.)
45+
- `xarray-topo <https://xarray-topo.readthedocs.io/>`_: xarray extension for topographic analysis and modelling.
4646
- `xbpch <https://github.com/darothen/xbpch>`_: xarray interface for bpch files.
4747
- `xclim <https://xclim.readthedocs.io/>`_: A library for calculating climate science indices with unit handling built from xarray and dask.
4848
- `xESMF <https://pangeo-xesmf.readthedocs.io/>`_: Universal regridder for geospatial data.
4949
- `xgcm <https://xgcm.readthedocs.io/>`_: Extends the xarray data model to understand finite volume grid cells (common in General Circulation Models) and provides interpolation and difference operations for such grids.
50-
- `xmitgcm <http://xgcm.readthedocs.io/>`_: a python package for reading `MITgcm <http://mitgcm.org/>`_ binary MDS files into xarray data structures.
50+
- `xmitgcm <http://xmitgcm.readthedocs.io/>`_: a python package for reading `MITgcm <https://mitgcm.org/>`_ binary MDS files into xarray data structures.
5151
- `xnemogcm <https://github.com/rcaneill/xnemogcm/>`_: a package to read `NEMO <https://nemo-ocean.eu/>`_ output files and add attributes to interface with xgcm.
5252

5353
Machine Learning
@@ -57,6 +57,7 @@ Machine Learning
5757
- `Elm <https://ensemble-learning-models.readthedocs.io>`_: Parallel machine learning on xarray data structures
5858
- `sklearn-xarray (1) <https://phausamann.github.io/sklearn-xarray>`_: Combines scikit-learn and xarray (1).
5959
- `sklearn-xarray (2) <https://sklearn-xarray.readthedocs.io/en/latest/>`_: Combines scikit-learn and xarray (2).
60+
- `xbatcher <https://xbatcher.readthedocs.io>`_: Batch Generation from Xarray Datasets.
6061

6162
Other domains
6263
~~~~~~~~~~~~~
@@ -90,7 +91,7 @@ Visualization
9091

9192
Non-Python projects
9293
~~~~~~~~~~~~~~~~~~~
93-
- `xframe <https://github.com/QuantStack/xframe>`_: C++ data structures inspired by xarray.
94+
- `xframe <https://github.com/xtensor-stack/xframe>`_: C++ data structures inspired by xarray.
9495
- `AxisArrays <https://github.com/JuliaArrays/AxisArrays.jl>`_ and
9596
`NamedArrays <https://github.com/davidavdav/NamedArrays.jl>`_: similar data structures for Julia.
9697

doc/gallery.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ External Examples
116116
---
117117
:img-top: https://avatars.githubusercontent.com/u/60833341?s=200&v=4
118118
++++
119-
.. link-button:: http://gallery.pangeo.io/
119+
.. link-button:: https://gallery.pangeo.io/
120120
:type: url
121121
:text: Xarray and dask on the cloud with Pangeo
122122
:classes: btn-outline-dark btn-block stretched-link

0 commit comments

Comments
 (0)