diff --git a/docs/conf.py b/docs/conf.py index b0e0e45..13c0610 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -10,7 +10,7 @@ project = "FindMy.py" copyright = "2024, Mike Almeloo" author = "Mike Almeloo" -release = "0.2.1" +release = "0.8.0" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration @@ -42,5 +42,5 @@ autoapi_options = [ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = "furo" +html_theme = "sphinx_book_theme" html_static_path = ["_static"] diff --git a/docs/technical/10-AirTags.md b/docs/technical/10-AirTags.md new file mode 100644 index 0000000..2b34213 --- /dev/null +++ b/docs/technical/10-AirTags.md @@ -0,0 +1,3 @@ +# AirTags + +TODO diff --git a/pyproject.toml b/pyproject.toml index 4b87f45..7d9dc78 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -33,6 +33,7 @@ docs = [ "myst-parser>=4.0.1", "sphinx>=8.2.3,<8.3.0", "sphinx-autoapi==3.6.0", + "sphinx-book-theme>=1.1.4", ] [tool.pyright] diff --git a/shell.nix b/shell.nix index 46f84b7..828be14 100644 --- a/shell.nix +++ b/shell.nix @@ -1,18 +1,21 @@ -{ pkgs ? import {} }: +{ + pkgs ? import { }, +}: let - unstable = import (fetchTarball https://channels.nixos.org/nixos-unstable/nixexprs.tar.xz) { }; + unstable = import (fetchTarball "https://channels.nixos.org/nixos-unstable/nixexprs.tar.xz") { }; in pkgs.mkShell { packages = with pkgs; [ python312 unstable.uv gh + graphviz ]; shellHook = '' - if [[ -d .venv/ ]]; then - source .venv/bin/activate - fi + if [[ -d .venv/ ]]; then + source .venv/bin/activate + fi ''; -} \ No newline at end of file +} diff --git a/uv.lock b/uv.lock index 29893e0..e48a8a6 100644 --- a/uv.lock +++ b/uv.lock @@ -593,6 +593,7 @@ docs = [ { name = "myst-parser", marker = "python_full_version >= '3.11'" }, { name = "sphinx", marker = "python_full_version >= '3.11'" }, { name = "sphinx-autoapi", marker = "python_full_version >= '3.11'" }, + { name = "sphinx-book-theme", marker = "python_full_version >= '3.11'" }, ] test = [ { name = "pytest" }, @@ -622,6 +623,7 @@ docs = [ { name = "myst-parser", marker = "python_full_version >= '3.11'", specifier = ">=4.0.1" }, { name = "sphinx", marker = "python_full_version >= '3.11'", specifier = ">=8.2.3,<8.3.0" }, { name = "sphinx-autoapi", marker = "python_full_version >= '3.11'", specifier = "==3.6.0" }, + { name = "sphinx-book-theme", marker = "python_full_version >= '3.11'", specifier = ">=1.1.4" }, ] test = [{ name = "pytest", specifier = ">=8.3.2,<9.0.0" }] @@ -1232,6 +1234,25 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/13/a3/a812df4e2dd5696d1f351d58b8fe16a405b234ad2886a0dab9183fb78109/pycparser-2.22-py3-none-any.whl", hash = "sha256:c3702b6d3dd8c7abc1afa565d7e63d53a1d0bd86cdc24edd75470f4de499cfcc", size = 117552, upload-time = "2024-03-30T13:22:20.476Z" }, ] +[[package]] +name = "pydata-sphinx-theme" +version = "0.15.4" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "accessible-pygments", marker = "python_full_version >= '3.11'" }, + { name = "babel", marker = "python_full_version >= '3.11'" }, + { name = "beautifulsoup4", marker = "python_full_version >= '3.11'" }, + { name = "docutils", marker = "python_full_version >= '3.11'" }, + { name = "packaging", marker = "python_full_version >= '3.11'" }, + { name = "pygments", marker = "python_full_version >= '3.11'" }, + { name = "sphinx", marker = "python_full_version >= '3.11'" }, + { name = "typing-extensions", marker = "python_full_version >= '3.11'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/67/ea/3ab478cccacc2e8ef69892c42c44ae547bae089f356c4b47caf61730958d/pydata_sphinx_theme-0.15.4.tar.gz", hash = "sha256:7762ec0ac59df3acecf49fd2f889e1b4565dbce8b88b2e29ee06fdd90645a06d", size = 2400673, upload-time = "2024-06-25T19:28:45.041Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/e7/d3/c622950d87a2ffd1654208733b5bd1c5645930014abed8f4c0d74863988b/pydata_sphinx_theme-0.15.4-py3-none-any.whl", hash = "sha256:2136ad0e9500d0949f96167e63f3e298620040aea8f9c74621959eda5d4cf8e6", size = 4640157, upload-time = "2024-06-25T19:28:42.383Z" }, +] + [[package]] name = "pyelftools" version = "0.32" @@ -1528,6 +1549,19 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/3c/dd/018ce05c532a22007ac58d4f45232514cd9d6dd0ee1dc374e309db830983/sphinx_basic_ng-1.0.0b2-py3-none-any.whl", hash = "sha256:eb09aedbabfb650607e9b4b68c9d240b90b1e1be221d6ad71d61c52e29f7932b", size = 22496, upload-time = "2023-07-08T18:40:52.659Z" }, ] +[[package]] +name = "sphinx-book-theme" +version = "1.1.4" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pydata-sphinx-theme", marker = "python_full_version >= '3.11'" }, + { name = "sphinx", marker = "python_full_version >= '3.11'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/45/19/d002ed96bdc7738c15847c730e1e88282d738263deac705d5713b4d8fa94/sphinx_book_theme-1.1.4.tar.gz", hash = "sha256:73efe28af871d0a89bd05856d300e61edce0d5b2fbb7984e84454be0fedfe9ed", size = 439188, upload-time = "2025-02-20T16:32:32.581Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/51/9e/c41d68be04eef5b6202b468e0f90faf0c469f3a03353f2a218fd78279710/sphinx_book_theme-1.1.4-py3-none-any.whl", hash = "sha256:843b3f5c8684640f4a2d01abd298beb66452d1b2394cd9ef5be5ebd5640ea0e1", size = 433952, upload-time = "2025-02-20T16:32:31.009Z" }, +] + [[package]] name = "sphinxcontrib-applehelp" version = "2.0.0"