Check links in docs (#897)

Author: ofek

.github/workflows/docs.yml

@@ -26,6 +26,14 @@ jobs:
           make html
           popd
 
+      - name: Check links
+        uses: lycheeverse/lychee-action@v2
+        with:
+          lycheeVersion: v0.21.0
+          fail: true
+          failIfEmpty: true
+          args: README.md docs/build
+
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         if: github.ref == 'refs/heads/main'

docs/source/_static/edgedb.svg

@@ -424,7 +424,7 @@ Version 0.7.0 (2022-06-20)
 - Adds ``order`` and ``eq`` configuration options for `Struct` types, mirroring
   the ``dataclasses`` options of the same name. Order comparisons for Struct
   types are very performant, roughly `10x to 70x faster
-  <https://jcristharif.com/msgspec/benchmarks.html#benchmark-structs>`__ than
+  <https://jcristharif.com/msgspec/benchmarks.html#structs>`__ than
   alternative libraries (:pr:`122`).
 - Speedup `Struct` decoding for both JSON and MessagePack, on average 20%
   faster (:pr:`119`).
@@ -443,7 +443,7 @@ Version 0.7.0 (2022-06-20)
 Version 0.6.0 (2022-04-06)
 --------------------------
 
-- Add a new `msgspec.Raw <https://jcristharif.com/msgspec/usage.html#raw>`__
+- Add a new `msgspec.Raw <https://jcristharif.com/msgspec/api.html#msgspec.Raw>`__
   type for delayed decoding of message fields / serializing already encoded
   fields (:pr:`92`).
 - Add ``omit_defaults`` option to ``Struct`` types (`docs
@@ -452,15 +452,15 @@ Version 0.6.0 (2022-04-06)
   from serialized message. This improves both encode and decode performance
   (:pr:`94`).
 - Add ``rename`` option to ``Struct`` types (`docs
-  <https://jcristharif.com/msgspec/structs.html#renaming-field-names>`__) for
+  <https://jcristharif.com/msgspec/structs.html#renaming-fields>`__) for
   altering the field names used for encoding. A major use of this is supporting
   ``camelCase`` JSON field names, while letting Python code use the more
   standard ``snake_case`` field names (:pr:`98`).
 - Improve performance of ``nogc=True`` structs (`docs
   <https://jcristharif.com/msgspec/structs.html#disabling-garbage-collection-advanced>`__).
   GC is now avoided in more cases, and ``nogc=True`` structs use 16 fewer bytes
   per instance. Also added a `benchmark
-  <https://jcristharif.com/msgspec/benchmarks.html#benchmark-garbage-collection>`__
+  <https://jcristharif.com/msgspec/benchmarks.html#garbage-collection>`__
   for how ``msgspec`` can interact with application GC usage (:pr:`93`).
 - Cache creation of `tagged union
   <https://jcristharif.com/msgspec/structs.html#tagged-unions>`__ lookup

docs/source/changelog.rst

@@ -10,4 +10,3 @@ Here we provide a few examples using ``msgspec`` to accomplish various tasks.
     asyncio-kv.rst
     conda-repodata.rst
     pyproject-toml.rst
-    edgedb.rst

docs/source/examples/edgedb.rst

@@ -816,7 +816,7 @@ generating `Struct` types to match an existing API.
 
 .. code-block:: python
 
-    # https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#podspec-v1-core
+    # https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#PodSpec
     # An explicit mapping from python name -> JSON field name
     v1podspec_names = {
         ...

docs/source/examples/index.rst

@@ -712,25 +712,22 @@ already using them elsewhere, or if you have downstream code that requires a
       File "<stdin>", line 1, in <module>
     msgspec.ValidationError: Expected `int`, got `str` - at `$[1]`
 
-Other types that duck-type as ``NamedTuple`` (for example
-`edgedb NamedTuples <https://www.edgedb.com/docs/clients/python/api/types#named-tuples>`__)
-are also supported.
+Other types that duck-type as ``NamedTuple`` are also supported, such as
+`os.stat_result`.
 
 .. code-block:: python
 
-    >>> import edgedb
+    >>> import os
 
-    >>> client = edgedb.create_client()
+    >>> import sys
 
-    >>> alice = client.query_single(
-    ...     "SELECT (name := 'Alice', dob := <cal::local_date>'1984-03-01')"
-    ... )
+    >>> result = os.stat(sys.executable)
 
-    >>> alice
-    (name := 'Alice', dob := datetime.date(1984, 3, 1))
+    >>> result
+    os.stat_result(st_mode=33261, st_ino=5396073, st_dev=105, st_nlink=1, st_uid=0, st_gid=0, st_size=18440, st_atime=1760547094, st_mtime=1760547094, st_ctime=1760907672)
 
-    >>> msgspec.json.encode(alice)
-    b'["Alice","1984-03-01"]'
+    >>> msgspec.json.encode(result)
+    b'[33261,5396073,105,1,0,0,18440,1760547094,1760547094,1760907672]'
 
 ``dict``
 --------
@@ -847,29 +844,28 @@ additional features.
       File "<stdin>", line 1, in <module>
     msgspec.ValidationError: Expected `int`, got `str` - at `$.age`
 
-Other types that duck-type as ``dataclasses`` (for example
-`edgedb Objects <https://www.edgedb.com/docs/clients/python/api/types#objects>`__ or
-`pydantic dataclasses <https://docs.pydantic.dev/latest/usage/dataclasses/>`__)
-are also supported.
+Other types that duck-type as ``dataclasses`` are also supported, such as
+`pydantic dataclasses <https://docs.pydantic.dev/latest/usage/dataclasses/>`__.
 
 .. code-block:: python
 
-    >>> import edgedb
+    >>> from datetime import datetime
 
-    >>> client = edgedb.create_client()
+    >>> from pydantic.dataclasses import dataclass
 
-    >>> alice = client.query_single(
-    ...     "SELECT User {name, dob} FILTER .name = <str>$name LIMIT 1",
-    ...     name="Alice"
-    ... )
+    >>> @dataclass
+    ... class User:
+    ...     id: int
+    ...     name: str = 'John Doe'
+    ...     signup_ts: datetime | None = None
 
-    >>> alice
-    Object{name := 'Alice', dob := datetime.date(1984, 3, 1)}
+    >>> user = User(id='42', signup_ts='2032-06-21T12:00')
 
-    >>> msgspec.json.encode(alice)
-    b'{"id":"a6b951cc-2d00-11ee-91aa-b3f17e9898ce","name":"Alice","dob":"1984-03-01"}'
+    >>> user
+    User(id=42, name='John Doe', signup_ts=datetime.datetime(2032, 6, 21, 12, 0))
 
-For a more complete example using EdgeDB, see :doc:`examples/edgedb`.
+    >>> msgspec.json.encode(user)
+    b'{"id":42,"name":"John Doe","signup_ts":"2032-06-21T12:00:00"}'
 
 ``attrs``
 ---------