From d058e8cef01c21978292348661ea848247ebeee2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Tcho=C5=84?= Date: Wed, 14 Jan 2026 13:37:44 +0100 Subject: [PATCH 1/3] Lock mkdocstrings and mkdocstrings-python in the supported version range --- docs/requirements.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index a479acfe..c6ada70a 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,5 +3,5 @@ mkdocs mkdocs-jupyter mkdocs-gen-files mkdocs-material -mkdocstrings>=0.26 -mkdocstrings-python>=1.10 +mkdocstrings>=0.26,<1.0 +mkdocstrings-python>=1.10,<2.0 From 589937e5327c5f83bbb98a47aefa796ad72efa14 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Tcho=C5=84?= Date: Thu, 15 Jan 2026 13:39:14 +0100 Subject: [PATCH 2/3] Replace mkdocs import with inventories; release version lock --- docs/requirements.txt | 4 ++-- mkdocs.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index c6ada70a..a479acfe 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,5 +3,5 @@ mkdocs mkdocs-jupyter mkdocs-gen-files mkdocs-material -mkdocstrings>=0.26,<1.0 -mkdocstrings-python>=1.10,<2.0 +mkdocstrings>=0.26 +mkdocstrings-python>=1.10 diff --git a/mkdocs.yml b/mkdocs.yml index ab7886ea..a4027ac7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -69,7 +69,7 @@ plugins: handlers: python: paths: [src] - import: + inventories: - https://docs.python.org/3/objects.inv - https://numpy.org/doc/stable/objects.inv - https://docs.scipy.org/doc/scipy/objects.inv From 7ceaeae7ba7cb39527bb40c422135fc92d0ee9b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Tcho=C5=84?= Date: Thu, 15 Jan 2026 14:10:45 +0100 Subject: [PATCH 3/3] Add docs status badge for readthedocs to the readme --- readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/readme.md b/readme.md index 7100550f..95b8e628 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,5 @@ [![build](https://github.com/instamatic-dev/instamatic/actions/workflows/test.yml/badge.svg)](https://github.com/instamatic-dev/instamatic/actions/workflows/test.yml) +[![docs](https://camo.githubusercontent.com/3303c8b478a6de9b1e736a919b54d743c7af0ea2c1795cc9ae92ace209c4f5b7/68747470733a2f2f6170702e72656164746865646f63732e6f72672f70726f6a656374732f696e7374616d617469632f62616467652f)](https://app.readthedocs.org/projects/instamatic/builds/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/instamatic)](https://pypi.org/project/instamatic/) [![PyPI](https://img.shields.io/pypi/v/instamatic.svg?style=flat)](https://pypi.org/project/instamatic/) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1090388.svg)](https://doi.org/10.5281/zenodo.1090388)