docs: switch from sphinx to zensical

.github/workflows/docs.yml

@@ -0,0 +1,49 @@
+# SPDX-FileCopyrightText: 2026 California Institute of Technology.
+
+name: Deploy docs
+
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
+
+      - name: Install dependencies
+        run: uv sync --extra docs
+
+      - name: Build docs
+        run: uv run zensical build
+
+      - uses: actions/upload-pages-artifact@v5
+        with:
+          path: site/
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deploy.outputs.page_url }}
+    steps:
+      - uses: actions/configure-pages@v6
+
+      - id: deploy
+        uses: actions/deploy-pages@v5

.gitignore

@@ -51,8 +51,8 @@ coverage.xml
 # Django stuff:
 *.log
 
-# Sphinx documentation
-docs/_build/
+# MkDocs build output
+site/
 
 # PyBuilder
 target/

AUTHORS.md

@@ -0,0 +1,21 @@
+<!--
+SPDX-FileCopyrightText: 2015-2019 CERN.
+SPDX-License-Identifier: BSD-3-Clause
+
+In applying this license, CERN does not waive the privileges and immunities
+granted to it by virtue of its status as an Intergovernmental Organization
+or submit itself to any jurisdiction.
+-->
+
+# Authors
+
+- Adrian Pawel Baran
+- Alan Rubin
+- Alexander Ioannidis
+- Antoine Lambert
+- Bruno Marmol
+- Guillaume Viger
+- Jiri Kuncar
+- Lars Holm Nielsen
+- Pedro Gaudencio
+- Tibor Simko

CHANGES.rst → CHANGES.md

@@ -1,184 +1,183 @@
-..
-   SPDX-FileCopyrightText: 2015-2023 CERN.
-   SPDX-FileCopyrightText: 2022 Northwestern University.
-   SPDX-License-Identifier: BSD-3-Clause
+<!--
+SPDX-FileCopyrightText: 2015-2023 CERN.
+SPDX-FileCopyrightText: 2022 Northwestern University.
+SPDX-License-Identifier: BSD-3-Clause
 
-   In applying this license, CERN does not waive the privileges and immunities
-   granted to it by virtue of its status as an Intergovernmental Organization
-   or submit itself to any jurisdiction.
+In applying this license, CERN does not waive the privileges and immunities
+granted to it by virtue of its status as an Intergovernmental Organization
+or submit itself to any jurisdiction.
+-->
 
+# Changes
 
-Changes
-=======
-
-Version v1.6.1 (released 2026-05-28)
+## Version v1.6.1 (released 2026-05-28)
 
 - setup: replace isbnlib with isbnlib2
 
-Version v1.6.0 (released 2026-03-19)
+## Version v1.6.0 (released 2026-03-19)
 
 - refactor: remove DeprecationWarning
 - feat: add cstr and rrid identifiers
 - adding tests
 - feat: add openalex validator
 
-Version v1.5.1 (released 2025-12-15)
+## Version v1.5.1 (released 2025-12-15)
 
 - feat: add support for wikidata type QID scheme
 - gh-action: various version bumps
 
-Version v1.5.0 (released 2025-07-14)
+## Version v1.5.0 (released 2025-07-14)
 
 - chores: replaced importlib_metadata with importlib.metadata
 
-Version 1.4.5 (2025-06-05)
+## Version 1.4.5 (2025-06-05)
 
 - ark: fix regex to match new ARK identifiers without slash
 
-Version 1.4.4 (2025-06-03)
+## Version 1.4.4 (2025-06-03)
 
 - swhid: improved SWHID validation
 - tests: additional tests
 
-Version 1.4.3 (2025-05-12)
+## Version 1.4.3 (2025-05-12)
 
 - is_url: allow URL parameters (i.e. semicolon)
 - gnd: improve validation and normalization
 - pmcid: fix url to a working location
 - pmid: add trailing slash
 - new: email and sha1 identifiers
 
-Version 1.4.2 (2024-11-01)
+## Version 1.4.2 (2024-11-01)
 
 - setup: remove pytest-invenio to make imports cleaner
 - setup: install importlib_metadata for compatibility
 - bibcode/ads: normalize unicode
 
-Version 1.4.1 (2024-10-18)
+## Version 1.4.1 (2024-10-18)
 
 - install: add importlib_metadata
 
-Version 1.4.0 (2024-10-17)
+## Version 1.4.0 (2024-10-17)
 
 - Restructure module to be configurable and readable.
 - Adds a new entrypoint to register new custom schemes
 - Adds deprecations for direct imports of schemes
 
-Version 1.3.0 (2024-10-15) (yanked due to undesired flask dependency)
+## Version 1.3.0 (2024-10-15) (yanked due to undesired flask dependency)
 
 - Restructure module to be configurable and readable.
 - Adds a new entrypoint to register new custom schemes
 - Adds deprecations for direct imports of schemes
 
-Version 1.2.1 (2023-03-02)
+## Version 1.2.1 (2023-03-02)
 
 - Fixes ORCiD validation, by adding the new ISNI block range.
 
-Version 1.2.0 (2023-01-30)
+## Version 1.2.0 (2023-01-30)
 
 - schemes: add support for viaf and urn
 
-Version 1.1.12 (2022-02-28)
+## Version 1.1.12 (2022-02-28)
 
-- Replaces ``isbnid_fork`` with ``isbnlib``
+- Replaces `isbnid_fork` with `isbnlib`
 
-Version 1.1.11 (2022-01-28)
+## Version 1.1.11 (2022-01-28)
 
 - Normalize pmid + their URL identifiers
 
-Version 1.1.10 (2022-01-11)
+## Version 1.1.10 (2022-01-11)
 
 - Add purl.fdlp.gov as a valid PURL netloc
 - Normalize ror identifiers
 
-Version 1.1.9 (2021-08-30)
+## Version 1.1.9 (2021-08-30)
 
 - Update ARK's NAAN regex per https://datatracker.ietf.org/doc/html/draft-kunze-ark-28#section-2.3.
 
-Version 1.1.8 (2020-08-13)
+## Version 1.1.8 (2020-08-13)
 
 - Adds support for GEO and ArrayExpress identifiers.
 
-Version 1.1.7 (2020-06-22)
+## Version 1.1.7 (2020-06-22)
 
 - Updates Software Heritage identifiers
 - Adds Research Organization Registry identifiers
 - Fixes DeprctationWarnings by using raw strings for regular expressions
 
-Version 1.1.6 (2020-05-07)
+## Version 1.1.6 (2020-05-07)
 
 - Deprecates Python versions lower than 3.6.0. Now supporting 3.6.0 and 3.7.0.
 
-Version 1.1.5 (2020-02-26)
+## Version 1.1.5 (2020-02-26)
 
 - Adds support for Software Heritage identifiers.
 - Fixes handling of non-digit characters in DOI detection.
 
-Version 1.1.4 (2019-09-27)
+## Version 1.1.4 (2019-09-27)
 
 - Adds support for ASCL identifiers.
 - Fixes the ADS identifier regex to also detect lower-case author initials.
 
-Version 1.1.3 (2019-09-17)
+## Version 1.1.3 (2019-09-17)
 
 - Adds support for HTTPS ORCiD identifiers.
 
-Version 1.1.2 (2019-02-12)
+## Version 1.1.2 (2019-02-12)
 
 - Adds support for HAL identifiers.
 
-Version 1.1.1 (2018-11-18)
+## Version 1.1.1 (2018-11-18)
 
 - Changes URL resolution for bibcodes to use https://ui.adsabs.harvard instead
   of https://adsabs.harvard.edu/abs/.
-- Allows choosing HTTP/HTTPS for any generated URL by ``idutils.to_url``.
+- Allows choosing HTTP/HTTPS for any generated URL by `idutils.to_url`.
 
-Version 1.1.0 (2018-08-17)
+## Version 1.1.0 (2018-08-17)
 
 - Adds support for genomic identifiers: SRA, BioProject, BioSample, Ensembl,
   UniProt, RefSeq, GenBank/RefSeq.
 - Fixes bug in bibcode detection for non-capitalized journals.
 
-Version 1.0.1 (2018-05-02)
+## Version 1.0.1 (2018-05-02)
 
 - Fixes bug causing invalid DOIs to be accepted.
 
-Version 1.0.0 (2017-12-07)
+## Version 1.0.0 (2017-12-07)
 
 - Fixes handling of unicode characters in DOIs.
 - Adds support for APS style arXiv identifiers.
 
-Version 0.2.4 (2017-01-30)
+## Version 0.2.4 (2017-01-30)
 
 - Removes `Python 3.3` from a list of supported Python versions and
   adds `Python 3.6`
 - Moves from `isbnid (v0.3.4)` to `isbnid_fork (v0.4.4)` library.
 
-Version 0.2.3 (2016-09-21)
+## Version 0.2.3 (2016-09-21)
 
 - Adds an optional parameter in `idutils.to_url` to use HTTPS scheme
   for PID providers that support it.
 - Detects and parses Handles and DOIs without the "http(s)://", and
   ignores whitespace after scheme tags (eg. "doi:  10.123/456").
 
-Version 0.2.2 (2016-09-16)
+## Version 0.2.2 (2016-09-16)
 
 - Fixes issue where a valid ISBN with dashes and spaces could not be
   normalized.
 
-Version 0.2.1 (2016-06-17)
+## Version 0.2.1 (2016-06-17)
 
 - Changes ISBN normalization to use `isbnid` instead of `isbnlib`. Now,
   importing this library will not change the default socket timeout, resulting
   in unwanted side effects.
 
-Version 0.2.0 (2016-04-07)
+## Version 0.2.0 (2016-04-07)
 
 - Changes URL resolution for DOIs to use https://doi.org instead of
   http://dx.doi.org according to
   https://www.doi.org/doi_handbook/3_Resolution.html#3.8
 
-Version 0.1.1 (2015-07-22)
+## Version 0.1.1 (2015-07-22)
 
 - Fixes GND validation and normalization.
 - Replaces invalid package name in `run-tests.sh` and makes `run-tests.sh` file
@@ -188,6 +187,6 @@ Version 0.1.1 (2015-07-22)
   `docker-compose build` rebuilds the image,
   `docker-compose run --rm web /code/run-tests.sh` runs the test suite.
 
-Version 0.1.0 (2015-07-02)
+## Version 0.1.0 (2015-07-02)
 
 - First public release.

CONTRIBUTING.rst → CONTRIBUTING.md

@@ -1,19 +1,17 @@
-Contributing
-============
+# Contributing
 
 Bug reports, feature requests, and other contributions are welcome.
 If you find a demonstrable problem that is caused by the code of this
 library, please:
 
-1. Search for `already reported problems
-   <https://github.com/inveniosoftware/idutils/issues>`_.
+1. Search for [already reported problems](https://github.com/inveniosoftware/idutils/issues).
 2. Check if the issue has been fixed or is still reproducible on the
    latest `master` branch.
 3. Create an issue with **a test case**.
 
 If you create a feature branch, you can run the tests to ensure everything is
 operating correctly:
 
-.. code-block:: console
-
-    $ ./run-tests.sh
+```console
+$ ./run-tests.sh
+```