Replace Sphinx docs with MkDocs Material

.github/workflows/docs.yaml

@@ -0,0 +1,55 @@
+name: Documentation
+
+on:
+  push:
+  pull_request:
+    branches:
+      - '**'
+
+permissions: {}
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
+        with:
+          python-version: '3.14'
+          cache: 'pip'
+      - name: Install documentation dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r docs/requirements.txt
+      - name: Build documentation
+        run: mkdocs build --strict
+      - name: Upload Pages artifact
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
+        uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
+        with:
+          path: site
+
+  deploy:
+    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
+    needs: build
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5

.gitignore

@@ -11,6 +11,7 @@ build
 cover
 dist
 docs/_build
+site/
 lib/PyLD.egg-info
 profiler
 tests/test_caching.py

CONTRIBUTING.rst

@@ -16,6 +16,27 @@ Code
 * Use version X.Y.Z-dev in dev mode.
 * Use version X.Y.Z for releases.
 
+Documentation
+-------------
+
+The public documentation site is built with MkDocs Material.
+
+* Install documentation dependencies:
+
+  * ``pip install -r docs/requirements.txt``
+
+* Preview documentation locally:
+
+  * ``mkdocs serve``
+
+* Check documentation before submitting changes:
+
+  * ``mkdocs build --strict``
+
+* Refresh bundled JSON-LD context files:
+
+  * ``make download-bundled-contexts``
+
 Versioning
 ----------
 

Makefile

@@ -1,11 +1,14 @@
-.PHONY: install test upgrade-submodules download-bundled-contexts
+.PHONY: install test serve upgrade-submodules download-bundled-contexts
 
 install:
 	pip install -e .
 
 test:
 	pytest --cov=pyld
 
+serve:
+	mkdocs serve --dev-addr 127.0.0.1:8008
+
 upgrade-submodules:
 	git submodule update --remote --init --recursive
 

docs/api-reference.md

@@ -0,0 +1,135 @@
+# API Reference
+
+This page lists the public APIs that are intended for direct user code. PyLD
+also contains internal processor classes and helper functions that are not
+documented here.
+
+## Module `pyld.jsonld`
+
+### `compact(input_, ctx, options=None)`
+
+Compact a JSON-LD document using the provided context.
+
+### `expand(input_, options=None, on_property_dropped=noop)`
+
+Expand a JSON-LD document, removing context aliases and producing expanded
+JSON-LD form. `on_property_dropped` can be used to observe or reject properties
+that do not expand to absolute IRIs.
+
+### `flatten(input_, ctx=None, options=None)`
+
+Flatten a JSON-LD document. If `ctx` is supplied, compact the flattened output
+with that context.
+
+### `frame(input_, frame, options=None)`
+
+Frame a JSON-LD document according to the supplied frame.
+
+### `link(input_, ctx, options=None)`
+
+Experimentally link a JSON-LD document's nodes in memory. This is equivalent to
+framing with `@embed: @link`.
+
+### `normalize(input_, options=None)`
+
+Normalize a JSON-LD document. Common options include `algorithm` and `format`.
+Use `{"algorithm": "URDNA2015", "format": "application/n-quads"}` to produce
+canonical N-Quads.
+
+### `from_rdf(input_, options=None)`
+
+Convert RDF input to JSON-LD.
+
+### `to_rdf(input_, options=None)`
+
+Convert JSON-LD input to RDF dataset form.
+
+### `set_document_loader(load_document_)`
+
+Set the global document loader callable.
+
+### `get_document_loader()`
+
+Return the current global document loader callable.
+
+### `load_document(url, options, base=None, profile=None, request_profile=None)`
+
+Load a remote document using the configured or supplied document loader.
+
+### `requests_document_loader(**kwargs)`
+
+Create a `requests`-based document loader. Pass `secure=True` to require HTTPS.
+Other keyword arguments are forwarded to `requests.get()`.
+
+### `aiohttp_document_loader(**kwargs)`
+
+Create an `aiohttp`-based document loader. Pass `secure=True` to require HTTPS.
+Other keyword arguments are forwarded to `aiohttp` request calls.
+
+### `register_rdf_parser(content_type, parser)`
+
+Register an RDF parser for a content type.
+
+### `unregister_rdf_parser(content_type)`
+
+Remove a registered RDF parser for a content type.
+
+### `parse_link_header(header)`
+
+Parse an HTTP `Link` header.
+
+### `JsonLdProcessor`
+
+Processor class behind the module-level convenience functions. Most callers use
+the module-level functions directly.
+
+### `JsonLdError`
+
+Exception type raised for JSON-LD processing and loading errors.
+
+### `ContextResolver`
+
+Context resolver that can be supplied in operation options for custom context
+loading and caching behavior.
+
+### `freeze(value)`
+
+Return an immutable mapping for dictionary values. This is used by PyLD's
+context caches.
+
+## Top-Level Exports
+
+### `jsonld`
+
+The main JSON-LD processing module.
+
+### `DocumentLoader`
+
+Abstract base class for class-based document loaders. PyLD still accepts any
+callable with the loader signature.
+
+### `RemoteDocument`
+
+Typed mapping shape returned by document loaders.
+
+### `RequestsDocumentLoader`
+
+Class-based remote document loader implemented with `requests`.
+
+### `AioHttpDocumentLoader`
+
+Class-based remote document loader implemented with `aiohttp`.
+
+### `FrozenDocumentLoader`
+
+Allowlist-only document loader for deployments that must not fetch arbitrary
+remote contexts.
+
+### `BUNDLED_CONTEXTS`
+
+Mapping of selected common JSON-LD context URLs to bundled local context files.
+
+### `ContextResolver`
+
+Context resolver that can be supplied in operation options for custom context
+loading and caching behavior.