From 61f965bb8678c009b7009f8175a18de90b060b84 Mon Sep 17 00:00:00 2001 From: Maxime Liquet <35924738+maximlt@users.noreply.github.com> Date: Thu, 12 Dec 2024 08:47:53 +0100 Subject: [PATCH] doc: remove topics page replaced by a link to examples.holoviz.org (#1377) --- doc/conf.py | 6 ++- doc/index.rst | 2 +- doc/topics/index.rst | 99 -------------------------------------------- pixi.toml | 1 + 4 files changed, 7 insertions(+), 101 deletions(-) delete mode 100644 doc/topics/index.rst diff --git a/doc/conf.py b/doc/conf.py index 964772945..7ae28a82d 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -53,12 +53,12 @@ 'github_repo': 'datashader', }) - extensions += [ 'sphinx.ext.autosummary', 'numpydoc', 'nbsite.analytics', 'sphinxcontrib.mermaid', + 'sphinx_reredirects', ] myst_fence_as_directive = ["mermaid"] @@ -69,6 +69,10 @@ nbbuild_cell_timeout = 2000 +redirects = { + 'topics/index': 'https://examples.holoviz.org', +} + # Datashader uses sphinx.ext.autodoc (e.g. automodule) for its API reference # and automatically include a module that contains Image. Image inherits # from xr.DataArray. Datashader uses numpydoc to parse the docstrings. diff --git a/doc/index.rst b/doc/index.rst index 506729299..74f4177a3 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -38,7 +38,7 @@ hardware, while exploiting distributed and GPU systems when available. Introduction Getting Started User Guide - Topics + Examples Releases API FAQ diff --git a/doc/topics/index.rst b/doc/topics/index.rst deleted file mode 100644 index df4a9c949..000000000 --- a/doc/topics/index.rst +++ /dev/null @@ -1,99 +0,0 @@ -.. Checking this in since topics are not included - -****** -Topics -****** - -Examples of what can be done with Datashader. - -To learn how to use Datashader, see the `Getting Started Guide`_. - -Detailed documentation is contained in the `User Guide`_. - -NOTE: This is a list of links to examples on external sites. Most -examples are on https://examples.pyviz.org. - -- | `Census`_ - | Population and racial data from the 2010 US Census visualized as - scatter points. - -- | `Gerrymandering`_ - | US Congressional boundaries overlaid on 2010 US Census data. - -- | `Landsat`_ - | Hyperspectral satellite imaging data from Landsat8 visualized as - rasters. - -- | `Network Packets`_ - | PCAP network traffic data visualized as network graphs. - -- | `NYC Taxi`_ - | NYC Taxi data visualized as points, curves, and bars. Uses trip - data originally from the `NYC Taxi dataset`_ but preprocessed using - ``taxi_preprocessing_example.py`` for convenience. - -- | `OpenSky`_ - | OpenSky airplane trajectories visualized as points. - -- | `OSM 1 Billion`_ - | 1-billion-point OpenStreetMap dataset visualized as points on a - laptop, in memory. - -- | `OSM`_ - | 2.7-billion-point OpenStreetMap dataset visualized as points on a - laptop, out of core. - -- | `Dashboard`_ - | 30-line dashboard for datashader plots based on the `Panel`_ - library. - -- | `Strange attractors`_ - | Visualizing attractor trajectories for various iterative equations. - -- | `Bay Trimesh`_ - | Rendering a triangular mesh of water depths in the Chesapeake and - Delaware bay areas. - -- | `Amazon.com center distance`_ - | Cities in the USA colored by their distance to the nearest - Amazon.com distribution center. - -- | `UK Researchers`_ - | Network graph of collaborations between UK researchers. - -.. _Getting Started Guide: ../getting_started/index.ipynb -.. _User Guide: ../user_guide/index.ipynb -.. _Census: https://examples.pyviz.org/census/census.html -.. _Gerrymandering: https://examples.pyviz.org/gerrymandering/gerrymandering.html -.. _Landsat: https://examples.pyviz.org/landsat/landsat.html -.. _Network Packets: https://examples.pyviz.org/network_packets/network_packets.html -.. _NYC Taxi: https://examples.pyviz.org/nyc_taxi/nyc_taxi.html -.. _NYC Taxi dataset: http://www.nyc.gov/html/tlc/html/about/trip_record_data.shtml -.. _OpenSky: https://examples.pyviz.org/opensky/opensky.html -.. _OSM 1 Billion: https://examples.pyviz.org/osm/osm-1billion.html -.. _OSM: https://examples.pyviz.org/osm/osm-3billion.html -.. _Dashboard: https://examples.pyviz.org/datashader_dashboard/dashboard.html -.. _Panel: http://panel.pyviz.org -.. _Strange attractors: https://examples.pyviz.org/attractors/attractors.html -.. _Bay Trimesh: https://examples.pyviz.org/bay_trimesh/bay_trimesh.html -.. _Amazon.com center distance: https://anaconda.org/defusco/amz_centers/notebook -.. _UK Researchers: https://examples.pyviz.org/uk_researchers/uk_researchers.html - -.. toctree:: - :titlesonly: - :hidden: - :maxdepth: 2 - - Census - Gerrymandering - Landsat - Network Packets - NYC Taxi - OpenSky - OSM 1 Billion - OSM - Dashboard - Strange attractors - Bay Trimesh - Amazon.com center distance - UK Researchers diff --git a/pixi.toml b/pixi.toml index f67b545f2..6b7180a8c 100644 --- a/pixi.toml +++ b/pixi.toml @@ -137,6 +137,7 @@ test-benchmark = 'pytest datashader/tests --benchmark --gpu' nbsite = ">=0.8.4,<0.9.0" numpydoc = "*" sphinxcontrib-mermaid = "*" +sphinx-reredirects = "*" [feature.doc.activation.env] DASK_DATAFRAME__QUERY_PLANNING = "False"