Reduce redirected links in docs (#898)

ofek · web-flow · commit 836d71ff2fd3 · 2025-10-26T02:37:24.000-04:00
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -14,16 +14,20 @@ jobs:
       - name: Install Python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.11"
+          python-version: "3.13"
+
+      - name: Install UV
+        uses: astral-sh/setup-uv@v7
 
       - name: Install msgspec and dependencies
         run: |
-          pip install -e ".[doc]"
+          uv venv --no-project
+          uv pip install -e ".[doc]"
 
       - name: Build Docs
         run: |
           pushd docs
-          make html
+          uv run make html
           popd
 
       - name: Check links
diff --git a/README.md b/README.md
@@ -11,13 +11,13 @@
 [![License](https://img.shields.io/github/license/jcrist/msgspec.svg)](https://github.com/jcrist/msgspec/blob/main/LICENSE)
 [![PyPI Version](https://img.shields.io/pypi/v/msgspec.svg)](https://pypi.org/project/msgspec/)
 [![Conda Version](https://img.shields.io/conda/vn/conda-forge/msgspec.svg)](https://anaconda.org/conda-forge/msgspec)
-[![Code Coverage](https://codecov.io/gh/jcrist/msgspec/branch/main/graph/badge.svg)](https://codecov.io/gh/jcrist/msgspec)
+[![Code Coverage](https://codecov.io/gh/jcrist/msgspec/branch/main/graph/badge.svg)](https://app.codecov.io/gh/jcrist/msgspec)
 
 </div>
 
 `msgspec` is a *fast* serialization and validation library, with builtin
 support for [JSON](https://json.org), [MessagePack](https://msgpack.org),
-[YAML](https://yaml.org), and [TOML](https://toml.io). It features:
+[YAML](https://yaml.org), and [TOML](https://toml.io/en/). It features:
 
 - 🚀 **High performance encoders/decoders** for common protocols. The JSON and
   MessagePack implementations regularly
@@ -35,7 +35,7 @@ support for [JSON](https://json.org), [MessagePack](https://msgpack.org),
 
 - ✨ **A speedy Struct type** for representing structured data. If you already
   use [dataclasses](https://docs.python.org/3/library/dataclasses.html) or
-  [attrs](https://www.attrs.org),
+  [attrs](https://www.attrs.org/en/stable/),
   [structs](https://jcristharif.com/msgspec/structs.html) should feel familiar.
   However, they're
   [5-60x faster](https://jcristharif.com/msgspec/benchmarks.html#structs)
@@ -91,7 +91,7 @@ msgspec.ValidationError: Expected `str`, got `int` - at `$.groups[0]`
 
 `msgspec` is designed to be as performant as possible, while retaining some of
 the nicities of validation libraries like
-[pydantic](https://pydantic-docs.helpmanual.io/). For supported types,
+[pydantic](https://docs.pydantic.dev/latest/). For supported types,
 encoding/decoding a message with `msgspec` can be
 [~10-80x faster than alternative libraries](https://jcristharif.com/msgspec/benchmarks.html).
 
diff --git a/docs/source/_static/esmerald.png b/docs/source/_static/esmerald.png
diff --git a/docs/source/_static/ravyn.png b/docs/source/_static/ravyn.png
diff --git a/docs/source/benchmarks.rst b/docs/source/benchmarks.rst
@@ -130,7 +130,7 @@ popular Python JSON libraries.
 - json_ (standard library)
 
 The full benchmark source can be found
-`here <https://github.com/jcrist/msgspec/tree/main/benchmarks/bench_encodings.py>`__.
+`here <https://github.com/jcrist/msgspec/blob/main/benchmarks/bench_encodings.py>`__.
 
 .. raw:: html
 
@@ -187,7 +187,7 @@ For each library, we measure both the peak increase in memory usage (RSS) and
 the time to JSON decode the file.
 
 The full benchmark source can be found `here
-<https://github.com/jcrist/msgspec/tree/main/benchmarks/bench_large_json.py>`__.
+<https://github.com/jcrist/msgspec/blob/main/benchmarks/bench_large_json.py>`__.
 
 **Results (smaller is better):**
 
@@ -252,7 +252,7 @@ For each library, the following operations are benchmarked:
 - Time to compare two instances for order (``<``/``>``/``<=``/``>=``)
 
 The full benchmark source can be found `here
-<https://github.com/jcrist/msgspec/tree/main/benchmarks/bench_structs.py>`__.
+<https://github.com/jcrist/msgspec/blob/main/benchmarks/bench_structs.py>`__.
 
 **Results (smaller is better):**
 
@@ -299,7 +299,7 @@ of the benchmarked type, then measure:
 - The total amount of memory used by this data structure
 
 The full benchmark source can be found `here
-<https://github.com/jcrist/msgspec/tree/main/benchmarks/bench_gc.py>`__.
+<https://github.com/jcrist/msgspec/blob/main/benchmarks/bench_gc.py>`__.
 
 **Results (smaller is better):**
 
@@ -342,7 +342,7 @@ Here we compare the on-disk size of ``msgspec`` and ``pydantic``, its closest
 equivalent.
 
 The full benchmark source can be found `here
-<https://github.com/jcrist/msgspec/tree/main/benchmarks/bench_library_size.py>`__.
+<https://github.com/jcrist/msgspec/blob/main/benchmarks/bench_library_size.py>`__.
 
 **Results (smaller is better)**
 
@@ -540,9 +540,9 @@ smaller on disk.
 .. _simdjson: https://github.com/TkTech/pysimdjson
 .. _ujson: https://github.com/ultrajson/ultrajson
 .. _rapidjson: https://github.com/python-rapidjson/python-rapidjson
-.. _attrs: https://www.attrs.org
+.. _attrs: https://www.attrs.org/en/stable/
 .. _dataclasses: https://docs.python.org/3/library/dataclasses.html
-.. _pydantic: https://pydantic-docs.helpmanual.io/
+.. _pydantic: https://docs.pydantic.dev/latest/
 .. _cattrs: https://catt.rs/en/latest/
 .. _mashumaro: https://github.com/Fatal1ty/mashumaro
 .. _conda-forge: https://conda-forge.org/
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -194,8 +194,8 @@ Version 0.15.0 (2023-05-10)
 ---------------------------
 
 - Add support for Generic `Struct` types (:pr:`386`, :pr:`393`).
-- Add support for Generic `dataclasses` and `attrs <https://attrs.org>`__ types
-  (:pr:`396`).
+- Add support for Generic `dataclasses` and
+  `attrs <https://www.attrs.org/en/stable/>`__ types (:pr:`396`).
 - Add support for Generic `typing.TypedDict` and `typing.NamedTuple` types
   (:pr:`398`).
 - **BREAKING**: No longer normalize timezones to UTC when decoding `datetime`
@@ -234,7 +234,8 @@ Version 0.14.1 (2023-04-07)
 Version 0.14.0 (2023-04-02)
 ---------------------------
 
-- Support encoding and decoding `attrs <https://attrs.org>`__ types (:pr:`323`).
+- Support encoding and decoding `attrs <https://www.attrs.org/en/stable/>`__
+  types (:pr:`323`).
 - Add ``repr_omit_defaults`` configuration option for omitting struct default
   values in the ``repr`` (:pr:`322`).
 - Expose a struct's configuration through a ``__struct_config__`` attribute
diff --git a/docs/source/converters.rst b/docs/source/converters.rst
@@ -135,4 +135,4 @@ The implementation in ``msgspec.toml`` is *almost* identical to the one above,
 with some additional code for error handling.
 
 
-.. _TOML: https://toml.io
+.. _TOML: https://toml.io/en/
diff --git a/docs/source/examples/asyncio-kv.rst b/docs/source/examples/asyncio-kv.rst
@@ -23,7 +23,7 @@ messages. The length of each message is prefixed to each message
 to make it easier to efficiently determine message boundaries.
 
 The full example source can be found `here
-<https://github.com/jcrist/msgspec/blob/main/examples/asyncio-kv>`__.
+<https://github.com/jcrist/msgspec/tree/main/examples/asyncio-kv>`__.
 
 .. literalinclude:: ../../../examples/asyncio-kv/kv.py
     :language: python
diff --git a/docs/source/examples/conda-repodata.rst b/docs/source/examples/conda-repodata.rst
@@ -64,7 +64,7 @@ determine the top 10 packages by file size.
 **Source**
 
 The full example source can be found `here
-<https://github.com/jcrist/msgspec/blob/main/examples/conda-repodata>`__.
+<https://github.com/jcrist/msgspec/tree/main/examples/conda-repodata>`__.
 
 .. literalinclude:: ../../../examples/conda-repodata/query_repodata.py
     :language: python
diff --git a/docs/source/examples/geojson.rst b/docs/source/examples/geojson.rst
@@ -21,7 +21,7 @@ types, and :ref:`struct-tagged-unions` to differentiate between them. See the
 relevant docs for more information.
 
 The full example source can be found `here
-<https://github.com/jcrist/msgspec/blob/main/examples/geojson>`__.
+<https://github.com/jcrist/msgspec/tree/main/examples/geojson>`__.
 
 .. literalinclude:: ../../../examples/geojson/msgspec_geojson.py
     :language: python
diff --git a/docs/source/examples/pyproject-toml.rst b/docs/source/examples/pyproject-toml.rst
@@ -23,21 +23,21 @@ file. This includes full schema definitions for all fields in the
 ``tool``.
 
 The full example source can be found `here
-<https://github.com/jcrist/msgspec/blob/main/examples/pyproject-toml>`__.
+<https://github.com/jcrist/msgspec/tree/main/examples/pyproject-toml>`__.
 
 .. literalinclude:: ../../../examples/pyproject-toml/pyproject.py
     :language: python
 
 Here we use it to load the `pyproject.toml for Starlette
-<https://github.com/encode/starlette/blob/master/pyproject.toml>`__:
+<https://github.com/Kludex/starlette/blob/main/pyproject.toml>`__:
 
 .. code-block:: ipython3
 
     In [1]: import pyproject
 
     In [2]: import urllib.request
 
-    In [3]: url = "https://raw.githubusercontent.com/encode/starlette/master/pyproject.toml"
+    In [3]: url = "https://raw.githubusercontent.com/Kludex/starlette/HEAD/pyproject.toml"
 
     In [4]: with urllib.request.urlopen(url) as f:
        ...:     data = f.read()
@@ -109,8 +109,8 @@ a single string:
 .. _PEP 517: https://peps.python.org/pep-0517/
 .. _PEP 518: https://peps.python.org/pep-0518/
 .. _PEP 621: https://peps.python.org/pep-0621/
-.. _black: https://black.readthedocs.io
-.. _mypy: https://mypy.readthedocs.io
+.. _black: https://black.readthedocs.io/en/stable/
+.. _mypy: https://mypy.readthedocs.io/en/stable/
 .. _pyright: https://github.com/microsoft/pyright
-.. _pytest: https://docs.pytest.org
+.. _pytest: https://docs.pytest.org/en/stable/
 .. _dependency specifiers: https://packaging.python.org/en/latest/specifications/dependency-specifiers/
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -139,22 +139,22 @@ few:
 
         .. image:: _static/anywidget.png
 
-    .. grid-item-card:: esmerald
-        :link: https://esmerald.dev/
+    .. grid-item-card:: Ravyn
+        :link: https://www.ravyn.dev/
 
-        .. image:: _static/esmerald.png
+        .. image:: _static/ravyn.png
 
 
 .. _type annotations: https://docs.python.org/3/library/typing.html
 .. _JSON: https://json.org
 .. _MessagePack: https://msgpack.org
 .. _YAML: https://yaml.org
-.. _TOML: https://toml.io
-.. _attrs: https://www.attrs.org
+.. _TOML: https://toml.io/en/
+.. _attrs: https://www.attrs.org/en/stable/
 .. _dataclasses: https://docs.python.org/3/library/dataclasses.html
 .. _orjson: https://github.com/ijl/orjson
-.. _pydantic: https://pydantic-docs.helpmanual.io/
-.. _mypy: https://mypy.readthedocs.io
+.. _pydantic: https://docs.pydantic.dev/latest/
+.. _mypy: https://mypy.readthedocs.io/en/stable/
 .. _pyright: https://github.com/microsoft/pyright
 
 .. toctree::
diff --git a/docs/source/install.rst b/docs/source/install.rst
@@ -80,7 +80,7 @@ install from the `development branch on GitHub
 
 
 .. _YAML: https://yaml.org
-.. _TOML: https://toml.io
+.. _TOML: https://toml.io/en/
 .. _PyYAML: https://pyyaml.org/
 .. _tomli: https://github.com/hukkin/tomli
 .. _tomli_w: https://github.com/hukkin/tomli-w
diff --git a/docs/source/structs.rst b/docs/source/structs.rst
@@ -1056,7 +1056,7 @@ collected (leading to a memory leak).
 .. _PEP 563: https://peps.python.org/pep-0563/
 .. _dataclasses: https://docs.python.org/3/library/dataclasses.html
 .. _attrs: https://www.attrs.org/en/stable/index.html
-.. _pydantic: https://pydantic-docs.helpmanual.io/
+.. _pydantic: https://docs.pydantic.dev/latest/
 .. _mypy: https://mypy.readthedocs.io/en/stable/
 .. _pyright: https://github.com/microsoft/pyright
 .. _reference counting: https://en.wikipedia.org/wiki/Reference_counting
diff --git a/docs/source/supported-types.rst b/docs/source/supported-types.rst
@@ -1597,8 +1597,8 @@ TOML_ types are decoded to Python types as follows:
 .. _JSON: https://json.org
 .. _MessagePack: https://msgpack.org
 .. _YAML: https://yaml.org
-.. _TOML: https://toml.io
-.. _pydantic: https://pydantic-docs.helpmanual.io/
+.. _TOML: https://toml.io/en/
+.. _pydantic: https://docs.pydantic.dev/latest/
 .. _pendulum: https://pendulum.eustace.io/
 .. _RFC8259: https://datatracker.ietf.org/doc/html/rfc8259
 .. _RFC3339: https://datatracker.ietf.org/doc/html/rfc3339
@@ -1608,7 +1608,7 @@ TOML_ types are decoded to Python types as follows:
 .. _dataclasses: https://docs.python.org/3/library/dataclasses.html
 .. _attrs: https://www.attrs.org/en/stable/index.html
 .. _timezone-aware: https://docs.python.org/3/library/datetime.html#aware-and-naive-objects
-.. _mypy: https://mypy.readthedocs.io
+.. _mypy: https://mypy.readthedocs.io/en/stable/
 .. _pyright: https://github.com/microsoft/pyright
 .. _generic types:
 .. _user-defined generic types: https://docs.python.org/3/library/typing.html#user-defined-generic-types
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -162,8 +162,8 @@ types.
 .. _JSON: https://json.org
 .. _MessagePack: https://msgpack.org
 .. _YAML: https://yaml.org
-.. _TOML: https://toml.io
+.. _TOML: https://toml.io/en/
 .. _type annotations: https://docs.python.org/3/library/typing.html
-.. _pydantic: https://pydantic-docs.helpmanual.io/
-.. _mypy: https://mypy.readthedocs.io
+.. _pydantic: https://docs.pydantic.dev/latest/
+.. _mypy: https://mypy.readthedocs.io/en/stable/
 .. _pyright: https://github.com/microsoft/pyright
diff --git a/docs/source/why.rst b/docs/source/why.rst
@@ -50,5 +50,5 @@ quick to learn and friendly to use, letting you focus less on serialization and
 more on your application code.
 
 
-.. _mypy: https://mypy.readthedocs.io
+.. _mypy: https://mypy.readthedocs.io/en/stable/
 .. _pyright: https://github.com/microsoft/pyright

Original file line number	Diff line number	Diff line change
@@ -135,4 +135,4 @@ The implementation in ``msgspec.toml`` is almost identical to the one above,
`135`	`135`	`with some additional code for error handling.`
`136`	`136`
`137`	`137`
`138`		`-.. _TOML: https://toml.io`
	`138`	`+.. _TOML: https://toml.io/en/`