Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
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

- uses: astral-sh/setup-uv@v6

- name: Install dependencies
run: uv pip install --system -e ".[docs]"

- name: Build docs
run: zensical build

- uses: actions/upload-pages-artifact@v3
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@v5

- id: deploy
uses: actions/deploy-pages@v4
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ coverage.xml
# Django stuff:
*.log

# Sphinx documentation
docs/_build/
# MkDocs build output
site/

# PyBuilder
target/
Expand Down
18 changes: 0 additions & 18 deletions .readthedocs.yaml

This file was deleted.

192 changes: 0 additions & 192 deletions docs/Makefile

This file was deleted.

22 changes: 22 additions & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# API Reference

## Validators

::: idutils.validators

## Normalizers

::: idutils.normalizers

## Detectors

::: idutils.detectors

## URL Generation

::: idutils.schemes
options:
members:
- to_url
- IDUTILS_PID_SCHEMES
- IDUTILS_SCHEME_FILTER
28 changes: 28 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Changelog

## v1.6.1 (2026-05-28)

- setup: replace isbnlib with isbnlib2

## v1.6.0 (2026-03-19)

- refactor: remove DeprecationWarning
- feat: add cstr and rrid identifiers
- feat: add openalex validator

## v1.5.1 (2025-12-15)

- feat: add support for wikidata type QID scheme
- gh-action: various version bumps

## v1.5.0 (2025-07-14)

- feat: add RAiD support

## v1.4.1 (2024-11-25)

- fix: handle edge cases in identifier detection

## Older releases

See the [GitHub releases page](https://github.com/inveniosoftware/idutils/releases) for full history.
Loading
Loading