diff --git a/.flake8 b/.flake8 index 3a6ed47..08665a7 100644 --- a/.flake8 +++ b/.flake8 @@ -2,4 +2,4 @@ ignore = E203, E266, E501, W503 max-line-length = 110 max-complexity = 18 -select = B,C,E,F,W,T4,B9 \ No newline at end of file +select = B,C,E,F,W,T4,B9 diff --git a/.gitattributes b/.gitattributes index 16f9259..f8bd276 100644 --- a/.gitattributes +++ b/.gitattributes @@ -114,4 +114,4 @@ *.pdf filter=lfs diff=lfs merge=lfs -text # Disabled -#docs/**/* -filter=lfs -diff=lfs -merge=lfs -text \ No newline at end of file +#docs/**/* -filter=lfs -diff=lfs -merge=lfs -text diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 312aab1..7df0909 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,6 +1,6 @@ # These are supported funding model platforms -github: [ cnheider ] +github: [cnheider] patreon: cnheider open_collective: cnheider ko_fi: cnheider diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 1709ee0..cf7a39f 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -9,4 +9,3 @@ updates: directory: "/" # Location of package manifests schedule: interval: "daily" - diff --git a/.github/workflows/on_push.yml b/.github/workflows/on_push.yml index b13e0ee..65349ad 100644 --- a/.github/workflows/on_push.yml +++ b/.github/workflows/on_push.yml @@ -6,7 +6,7 @@ jobs: strategy: max-parallel: 4 matrix: - python-version: [ 3.8 ] + python-version: [3.8] steps: - uses: actions/checkout@master - name: Set up Python 3.8 @@ -20,4 +20,3 @@ jobs: pip install -r requirements/requirements_dev.txt pip install -r requirements/requirements_docs.txt - uses: pything/postdoc@master - diff --git a/.github/workflows/on_push_python_package.yaml b/.github/workflows/on_push_python_package.yaml index 5340e32..4383a16 100644 --- a/.github/workflows/on_push_python_package.yaml +++ b/.github/workflows/on_push_python_package.yaml @@ -1,15 +1,14 @@ name: Python package -on: [ push ] +on: [push] jobs: build: - runs-on: ubuntu-latest strategy: max-parallel: 4 matrix: - python-version: [ 3.8 ] + python-version: [3.8] steps: - uses: actions/checkout@v1 diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml index e5f08c5..0bb152b 100644 --- a/.github/workflows/pythonpackage.yml +++ b/.github/workflows/pythonpackage.yml @@ -1,15 +1,14 @@ name: Python package -on: [ push ] +on: [push] jobs: build: - runs-on: ubuntu-latest strategy: max-parallel: 4 matrix: - python-version: [ 3.8 ] + python-version: [3.8] steps: - uses: actions/checkout@v2 diff --git a/.nojekyll b/.nojekyll index 8b13789..e69de29 100644 --- a/.nojekyll +++ b/.nojekyll @@ -1 +0,0 @@ - diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 390d348..7163560 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,32 +1,263 @@ fail_fast: true -#exclude: '^exclude' repos: + - repo: https://github.com/asottile/pyupgrade + rev: v3.15.2 + hooks: + - id: pyupgrade + args: + - --py38-plus + - --keep-runtime-typing + - repo: https://github.com/ambv/black - rev: 23.3.0 + rev: 24.4.0 hooks: - id: black language_version: python3.10 - - repo: local + + - repo: https://github.com/pre-commit/mirrors-prettier + rev: v4.0.0-alpha.8 hooks: - - id: pytest-check - name: pytest-check - entry: pytest - language: system - pass_filenames: false - always_run: true - - repo: local + - id: prettier + types: [yaml] + + - repo: https://github.com/abravalheri/validate-pyproject + rev: v0.16 hooks: - - id: flake8-check1 # stop the build if there are Python syntax errors or undefined names - name: flake8-check1 - entry: flake8 jord --count --select=E9,F63,F7,F82 --show-source --statistics --exclude=*exclude* - language: system - pass_filenames: false - always_run: true - - repo: local + - id: validate-pyproject + + - repo: https://github.com/pre-commit/mirrors-mypy + rev: v1.9.0 + hooks: + - id: mypy + verbose: true + #exclude: ^tests/ + entry: bash -c 'mypy "$@" || true' -- # only print + #args: [ --strict ] + + - repo: https://github.com/pycqa/flake8 + rev: 7.0.0 # pick a git hash / tag to point to + hooks: + - id: flake8 # stop the build if there are Python syntax errors or undefined names + additional_dependencies: [flake8-docstrings] + exclude: ^exclude* + args: + - --count + - --select=E9,F63,F7,F82 + - --show-source + - --statistics + - id: flake8 # only warn + additional_dependencies: [flake8-docstrings] + exclude: ^exclude* + args: + - --count + - --exit-zero + - --max-complexity=10 + - --max-line-length=127 + - --statistics + + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.6.0 # Use the ref you want to point at hooks: - - id: flake8-check2 # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide - name: flake8-check2 - entry: flake8 jord --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics --exclude=*exclude* - language: system + - id: check-added-large-files + name: check for added large files + description: prevents giant files from being committed. + entry: check-added-large-files + language: python + - id: check-ast + name: check python ast + description: simply checks whether the files parse as valid python. + entry: check-ast + language: python + types: [python] + - id: check-byte-order-marker + name: "check BOM - deprecated: use fix-byte-order-marker" + description: forbids files which have a utf-8 byte-order marker. + entry: check-byte-order-marker + language: python + types: [text] + - id: check-builtin-literals + name: check builtin type constructor use + description: requires literal syntax when initializing empty or zero python builtin types. + entry: check-builtin-literals + language: python + types: [python] + - id: check-case-conflict + name: check for case conflicts + description: checks for files that would conflict in case-insensitive filesystems. + entry: check-case-conflict + language: python + - id: check-docstring-first + name: check docstring is first + description: checks a common error of defining a docstring after code. + entry: check-docstring-first + language: python + types: [python] + - id: check-executables-have-shebangs + name: check that executables have shebangs + description: ensures that (non-binary) executables have a shebang. + entry: check-executables-have-shebangs + language: python + types: [text, executable] + stages: [commit, push, manual] + - id: check-json + name: check json + description: checks json files for parseable syntax. + entry: check-json + language: python + types: [json] + - id: check-shebang-scripts-are-executable + name: check that scripts with shebangs are executable + description: ensures that (non-binary) files with a shebang are executable. + entry: check-shebang-scripts-are-executable + language: python + types: [text] + stages: [commit, push, manual] + - id: check-merge-conflict + name: check for merge conflicts + description: checks for files that contain merge conflict strings. + entry: check-merge-conflict + language: python + types: [text] + - id: check-symlinks + name: check for broken symlinks + description: checks for symlinks which do not point to anything. + entry: check-symlinks + language: python + types: [symlink] + - id: check-toml + name: check toml + description: checks toml files for parseable syntax. + entry: check-toml + language: python + types: [toml] + - id: check-vcs-permalinks + name: check vcs permalinks + description: ensures that links to vcs websites are permalinks. + entry: check-vcs-permalinks + language: python + types: [text] + - id: check-xml + name: check xml + description: checks xml files for parseable syntax. + entry: check-xml + language: python + types: [xml] + - id: check-yaml + name: check yaml + description: checks yaml files for parseable syntax. + entry: check-yaml + language: python + types: [yaml] + - id: debug-statements + name: debug statements (python) + description: checks for debugger imports and py37+ `breakpoint()` calls in python source. + entry: debug-statement-hook + language: python + types: [python] + - id: destroyed-symlinks + name: detect destroyed symlinks + description: detects symlinks which are changed to regular files with a content of a path which that symlink was pointing to. + entry: destroyed-symlinks + language: python + types: [file] + - id: detect-private-key + name: detect private key + description: detects the presence of private keys. + entry: detect-private-key + language: python + types: [text] + - id: end-of-file-fixer + name: fix end of files + description: ensures that a file is either empty, or ends with one newline. + entry: end-of-file-fixer + language: python + types: [text] + stages: [commit, push, manual] + - id: file-contents-sorter + name: file contents sorter + description: sorts the lines in specified files (defaults to alphabetical). you must provide list of target files as input in your .pre-commit-config.yaml file. + entry: file-contents-sorter + language: python + files: "^$" + - id: fix-byte-order-marker + name: fix utf-8 byte order marker + description: removes utf-8 byte order marker. + entry: fix-byte-order-marker + language: python + types: [text] + - id: mixed-line-ending + name: mixed line ending + description: replaces or checks mixed line ending. + entry: mixed-line-ending + language: python + types: [text] + - id: no-commit-to-branch + name: "don't commit to branch" + entry: no-commit-to-branch + language: python pass_filenames: false always_run: true + - id: requirements-txt-fixer + name: fix requirements.txt + description: sorts entries in requirements.txt. + entry: requirements-txt-fixer + language: python + files: requirements.*\.txt$ + - id: sort-simple-yaml + name: sort simple yaml files + description: sorts simple yaml files which consist only of top-level keys, preserving comments and blocks. + language: python + entry: sort-simple-yaml + files: "^$" + - id: trailing-whitespace + name: trim trailing whitespace + description: trims trailing whitespace. + entry: trailing-whitespace-fixer + language: python + types: [text] + stages: [commit, push, manual] + + # - repo: local + # hooks: + # - id: sphinx-check + # name: sphinx-check + # entry: docs/make.sh + # language: script + # types: [ python ] + # pass_filenames: false + + # - repo: local + # hooks: + # - id: pytest-check + # name: pytest-check + # entry: pytest migration --ignore-glob=*exclude* + # language: system + # pass_filenames: false + # always_run: true + + # - repo: https://github.com/jshwi/docsig # BUGGY! + # rev: v0.30.0 + # hooks: + # - id: docsig + # args: + # - "--check-class" + # - "--check-dunders" + # - "--check-overridden" + # - "--check-protected" + # - "--summary" + + #- repo: https://github.com/pycqa/pydocstyle # SLOW! + # rev: 6.3.0 # pick a git hash / tag to point to + # hooks: + # - id: pydocstyle + + # - repo: https://github.com/jsh9/pydoclint + # rev: 0.3.8 + # hooks: + # - id: pydoclint + # args: + # [ + # --style=sphinx, + # --check-return-types=False, + # --arg-type-hints-in-docstring=False, + # ] diff --git a/.pyup.yml b/.pyup.yml index 19f31a8..2431b43 100644 --- a/.pyup.yml +++ b/.pyup.yml @@ -59,4 +59,4 @@ branch_prefix: pyup/ # allow to close stale PRs # default: True -close_prs: True \ No newline at end of file +close_prs: True diff --git a/.readthedocs.yaml b/.readthedocs.yaml index c6b7c8f..e2fa256 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -29,4 +29,4 @@ conda: # Optionally declare the Python requirements required to build your docs python: install: - - requirements: requirements/requirements_dev.txt \ No newline at end of file + - requirements: requirements/requirements_dev.txt diff --git a/.travis.yml b/.travis.yml index a032e29..0c84971 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,8 +1,8 @@ dist: xenial language: python python: - - '3.7' - - '3.8' + - "3.7" + - "3.8" install: - pip install -r requirements.txt - pip install -r requirements/requirements_dev.txt @@ -11,4 +11,3 @@ script: - pytest --cov=yeet - coveralls - black --check yeet - diff --git a/LICENSE.md b/LICENSE.md index 1a32b4c..fea85f2 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -132,7 +132,7 @@ APPENDIX: How to apply the Apache License to your work. same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright 2018 Christian Heider Nielsen + Copyright 2018 Christian Heider Lindbjerg Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at diff --git a/MANIFEST.in b/MANIFEST.in index 95d4e90..9878db1 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -11,4 +11,4 @@ global-include *.md #include LICENSE.txt # Include the data files -#recursive-include data * \ No newline at end of file +#recursive-include data * diff --git a/README.md b/README.md index f2d790f..bf009a0 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ -| [![Build Status](https://travis-ci.org/aivclab/jord.svg?branch=master)](https://travis-ci.org/aivclab/jord) | [![Coverage Status](https://coveralls.io/repos/github/aivclab/vision/badge.svg?branch=master)](https://coveralls.io/github/aivclab/vision?branch=master) | [![GitHub Issues](https://img.shields.io/github/issues/aivclab/vision.svg?style=flat)](https://github.com/aivclab/vision/issues) | [![GitHub Forks](https://img.shields.io/github/forks/aivclab/vision.svg?style=flat)](https://github.com/aivclab/vision/network) | [![GitHub Stars](https://img.shields.io/github/stars/aivclab/vision.svg?style=flat)](https://github.com/aivclab/vision/stargazers) | [![GitHub License](https://img.shields.io/github/license/aivclab/vision.svg?style=flat)](https://github.com/aivclab/vision/blob/master/LICENSE.md) | -|-------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| [![Build Status](https://travis-ci.org/automaps/jord.svg?branch=master)](https://travis-ci.org/automaps/jord) | [![Coverage Status](https://coveralls.io/repos/github/automaps/jord/badge.svg?branch=master)](https://coveralls.io/github/automaps/jord?branch=master) | [![GitHub Issues](https://img.shields.io/github/issues/automaps/jord.svg?style=flat)](https://github.com/automaps/jord/issues) | [![GitHub Forks](https://img.shields.io/github/forks/automaps/jord.svg?style=flat)](https://github.com/automaps/jord/network) | [![GitHub Stars](https://img.shields.io/github/stars/automaps/jord.svg?style=flat)](https://github.com/automaps/jord/stargazers) | [![GitHub License](https://img.shields.io/github/license/automaps/jord.svg?style=flat)](https://github.com/automaps/jord/blob/master/LICENSE.md) | +|---------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|

@@ -30,5 +30,5 @@ # Authors -* **Christian Heider Nielsen** - [cnheider](https://github.com/cnheider) -* [Other contributors](https://github.com/aivclab/jord/contributors) +* **Christian Heider Lindbjerg** - [cnheider](https://github.com/cnheider) +* [Other contributors](https://github.com/automaps/jord/contributors) diff --git a/jord/qgis_utilities/qlive_utilities/procedure_implementation.py b/dev_requirements.txt similarity index 100% rename from jord/qgis_utilities/qlive_utilities/procedure_implementation.py rename to dev_requirements.txt diff --git a/docs/.gitignore b/docs/.gitignore index 4d1f0fb..47d6b32 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,2 +1,2 @@ build -#github \ No newline at end of file +#github diff --git a/docs/clean.sh b/docs/clean.sh old mode 100644 new mode 100755 diff --git a/docs/github/doctrees/environment.pickle b/docs/github/doctrees/environment.pickle deleted file mode 100644 index 88d5402..0000000 Binary files a/docs/github/doctrees/environment.pickle and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.dist_is_editable.doctree b/docs/github/doctrees/generated/jord.dist_is_editable.doctree deleted file mode 100644 index 9eec07c..0000000 Binary files a/docs/github/doctrees/generated/jord.dist_is_editable.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.doctree b/docs/github/doctrees/generated/jord.doctree deleted file mode 100644 index 31d9192..0000000 Binary files a/docs/github/doctrees/generated/jord.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.gdal_utilities.cloning.clone_data_to_memory.doctree b/docs/github/doctrees/generated/jord.gdal_utilities.cloning.clone_data_to_memory.doctree deleted file mode 100644 index 044815f..0000000 Binary files a/docs/github/doctrees/generated/jord.gdal_utilities.cloning.clone_data_to_memory.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.gdal_utilities.cloning.clone_raster_to_memory.doctree b/docs/github/doctrees/generated/jord.gdal_utilities.cloning.clone_raster_to_memory.doctree deleted file mode 100644 index 910034d..0000000 Binary files a/docs/github/doctrees/generated/jord.gdal_utilities.cloning.clone_raster_to_memory.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.gdal_utilities.cloning.clone_vector_to_memory.doctree b/docs/github/doctrees/generated/jord.gdal_utilities.cloning.clone_vector_to_memory.doctree deleted file mode 100644 index 1adf5d8..0000000 Binary files a/docs/github/doctrees/generated/jord.gdal_utilities.cloning.clone_vector_to_memory.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.gdal_utilities.cloning.doctree b/docs/github/doctrees/generated/jord.gdal_utilities.cloning.doctree deleted file mode 100644 index d96b5fc..0000000 Binary files a/docs/github/doctrees/generated/jord.gdal_utilities.cloning.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.gdal_utilities.context.SilenceGDALSession.doctree b/docs/github/doctrees/generated/jord.gdal_utilities.context.SilenceGDALSession.doctree deleted file mode 100644 index 5d2eb2a..0000000 Binary files a/docs/github/doctrees/generated/jord.gdal_utilities.context.SilenceGDALSession.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.gdal_utilities.context.doctree b/docs/github/doctrees/generated/jord.gdal_utilities.context.doctree deleted file mode 100644 index 9f2df05..0000000 Binary files a/docs/github/doctrees/generated/jord.gdal_utilities.context.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.gdal_utilities.conversion.copy_gcps_to_file.doctree b/docs/github/doctrees/generated/jord.gdal_utilities.conversion.copy_gcps_to_file.doctree deleted file mode 100644 index 31e0465..0000000 Binary files a/docs/github/doctrees/generated/jord.gdal_utilities.conversion.copy_gcps_to_file.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.gdal_utilities.conversion.doctree b/docs/github/doctrees/generated/jord.gdal_utilities.conversion.doctree deleted file mode 100644 index a768bd9..0000000 Binary files a/docs/github/doctrees/generated/jord.gdal_utilities.conversion.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.gdal_utilities.conversion.geotiff_to_tiff.doctree b/docs/github/doctrees/generated/jord.gdal_utilities.conversion.geotiff_to_tiff.doctree deleted file mode 100644 index fb0acc4..0000000 Binary files a/docs/github/doctrees/generated/jord.gdal_utilities.conversion.geotiff_to_tiff.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.gdal_utilities.conversion.get_georeference_from_file.doctree b/docs/github/doctrees/generated/jord.gdal_utilities.conversion.get_georeference_from_file.doctree deleted file mode 100644 index 902aa69..0000000 Binary files a/docs/github/doctrees/generated/jord.gdal_utilities.conversion.get_georeference_from_file.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.gdal_utilities.conversion.set_georeference_to_file.doctree b/docs/github/doctrees/generated/jord.gdal_utilities.conversion.set_georeference_to_file.doctree deleted file mode 100644 index 1c0bad8..0000000 Binary files a/docs/github/doctrees/generated/jord.gdal_utilities.conversion.set_georeference_to_file.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.gdal_utilities.conversion.tiff_to_geotiff.doctree b/docs/github/doctrees/generated/jord.gdal_utilities.conversion.tiff_to_geotiff.doctree deleted file mode 100644 index c327a73..0000000 Binary files a/docs/github/doctrees/generated/jord.gdal_utilities.conversion.tiff_to_geotiff.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.gdal_utilities.dataset.doctree b/docs/github/doctrees/generated/jord.gdal_utilities.dataset.doctree deleted file mode 100644 index 213367c..0000000 Binary files a/docs/github/doctrees/generated/jord.gdal_utilities.dataset.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.gdal_utilities.doctree b/docs/github/doctrees/generated/jord.gdal_utilities.doctree deleted file mode 100644 index 334e345..0000000 Binary files a/docs/github/doctrees/generated/jord.gdal_utilities.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.gdal_utilities.enums.doctree b/docs/github/doctrees/generated/jord.gdal_utilities.enums.doctree deleted file mode 100644 index 9bb77bb..0000000 Binary files a/docs/github/doctrees/generated/jord.gdal_utilities.enums.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.gdal_utilities.importing.doctree b/docs/github/doctrees/generated/jord.gdal_utilities.importing.doctree deleted file mode 100644 index 83e1b14..0000000 Binary files a/docs/github/doctrees/generated/jord.gdal_utilities.importing.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.gdal_utilities.importing.import_gdal.doctree b/docs/github/doctrees/generated/jord.gdal_utilities.importing.import_gdal.doctree deleted file mode 100644 index 2853c44..0000000 Binary files a/docs/github/doctrees/generated/jord.gdal_utilities.importing.import_gdal.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.gdal_utilities.importing.import_ogr.doctree b/docs/github/doctrees/generated/jord.gdal_utilities.importing.import_ogr.doctree deleted file mode 100644 index f96090a..0000000 Binary files a/docs/github/doctrees/generated/jord.gdal_utilities.importing.import_ogr.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.gdal_utilities.importing.import_osr.doctree b/docs/github/doctrees/generated/jord.gdal_utilities.importing.import_osr.doctree deleted file mode 100644 index 0616b2a..0000000 Binary files a/docs/github/doctrees/generated/jord.gdal_utilities.importing.import_osr.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.geojson_utilities.doctree b/docs/github/doctrees/generated/jord.geojson_utilities.doctree deleted file mode 100644 index 33d80e1..0000000 Binary files a/docs/github/doctrees/generated/jord.geojson_utilities.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.geojson_utilities.geometry_types.GeoJsonGeometryTypesEnum.doctree b/docs/github/doctrees/generated/jord.geojson_utilities.geometry_types.GeoJsonGeometryTypesEnum.doctree deleted file mode 100644 index 8fbbcc1..0000000 Binary files a/docs/github/doctrees/generated/jord.geojson_utilities.geometry_types.GeoJsonGeometryTypesEnum.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.geojson_utilities.geometry_types.doctree b/docs/github/doctrees/generated/jord.geojson_utilities.geometry_types.doctree deleted file mode 100644 index 4d26111..0000000 Binary files a/docs/github/doctrees/generated/jord.geojson_utilities.geometry_types.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.get_version.doctree b/docs/github/doctrees/generated/jord.get_version.doctree deleted file mode 100644 index 034c9a1..0000000 Binary files a/docs/github/doctrees/generated/jord.get_version.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.pillow_utilities.doctree b/docs/github/doctrees/generated/jord.pillow_utilities.doctree deleted file mode 100644 index 17a52f1..0000000 Binary files a/docs/github/doctrees/generated/jord.pillow_utilities.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.pillow_utilities.exif.doctree b/docs/github/doctrees/generated/jord.pillow_utilities.exif.doctree deleted file mode 100644 index e7d8a27..0000000 Binary files a/docs/github/doctrees/generated/jord.pillow_utilities.exif.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.pillow_utilities.tiff.doctree b/docs/github/doctrees/generated/jord.pillow_utilities.tiff.doctree deleted file mode 100644 index a16fe91..0000000 Binary files a/docs/github/doctrees/generated/jord.pillow_utilities.tiff.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.rasterio_utilities.doctree b/docs/github/doctrees/generated/jord.rasterio_utilities.doctree deleted file mode 100644 index d19e6a7..0000000 Binary files a/docs/github/doctrees/generated/jord.rasterio_utilities.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.analysis.degrees_of_freedom.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.analysis.degrees_of_freedom.doctree deleted file mode 100644 index 3936991..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.analysis.degrees_of_freedom.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.analysis.degrees_of_freedom.has_3_sides_touching.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.analysis.degrees_of_freedom.has_3_sides_touching.doctree deleted file mode 100644 index 540c3d6..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.analysis.degrees_of_freedom.has_3_sides_touching.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.analysis.degrees_of_freedom.has_touches_across_centroid_buffer.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.analysis.degrees_of_freedom.has_touches_across_centroid_buffer.doctree deleted file mode 100644 index 030e8f3..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.analysis.degrees_of_freedom.has_touches_across_centroid_buffer.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.analysis.degrees_of_freedom.is_2d_translatable.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.analysis.degrees_of_freedom.is_2d_translatable.doctree deleted file mode 100644 index 914c8f7..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.analysis.degrees_of_freedom.is_2d_translatable.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.analysis.degrees_of_freedom.is_simple_shape.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.analysis.degrees_of_freedom.is_simple_shape.doctree deleted file mode 100644 index bf5c758..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.analysis.degrees_of_freedom.is_simple_shape.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.analysis.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.analysis.doctree deleted file mode 100644 index 8d3212c..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.analysis.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.analysis.tracing.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.analysis.tracing.doctree deleted file mode 100644 index e189bca..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.analysis.tracing.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.analysis.tracing.trace_for_inner_ring.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.analysis.tracing.trace_for_inner_ring.doctree deleted file mode 100644 index d6e2874..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.analysis.tracing.trace_for_inner_ring.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.clamp.adjust_line_end.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.clamp.adjust_line_end.doctree deleted file mode 100644 index 7085dbb..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.clamp.adjust_line_end.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.clamp.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.clamp.doctree deleted file mode 100644 index 0331b5a..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.clamp.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.clamp.ensure_list_of_geometries.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.clamp.ensure_list_of_geometries.doctree deleted file mode 100644 index f232446..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.clamp.ensure_list_of_geometries.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.clamp.extend_segment.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.clamp.extend_segment.doctree deleted file mode 100644 index 54155a9..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.clamp.extend_segment.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.clamp.fix_starting_point.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.clamp.fix_starting_point.doctree deleted file mode 100644 index 6f98497..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.clamp.fix_starting_point.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.clamp.split_line_string.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.clamp.split_line_string.doctree deleted file mode 100644 index 6f4ec56..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.clamp.split_line_string.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.clamp.unsplit_line_string.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.clamp.unsplit_line_string.doctree deleted file mode 100644 index a0889ab..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.clamp.unsplit_line_string.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.doctree deleted file mode 100644 index bcbac7c..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.geometry_types.ShapelyGeometryTypesEnum.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.geometry_types.ShapelyGeometryTypesEnum.doctree deleted file mode 100644 index 7a6c822..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.geometry_types.ShapelyGeometryTypesEnum.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.geometry_types.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.geometry_types.doctree deleted file mode 100644 index 70964a0..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.geometry_types.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.iteration.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.iteration.doctree deleted file mode 100644 index e74a8c9..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.iteration.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.iteration.pairs.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.iteration.pairs.doctree deleted file mode 100644 index 9bf7587..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.iteration.pairs.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.lines.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.lines.doctree deleted file mode 100644 index 917060f..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.lines.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.lines.explode_line.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.lines.explode_line.doctree deleted file mode 100644 index d3e768d..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.lines.explode_line.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.lines.strip_line_dangles.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.lines.strip_line_dangles.doctree deleted file mode 100644 index 80f9bfa..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.lines.strip_line_dangles.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.lines.strip_multiline_dangles.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.lines.strip_multiline_dangles.doctree deleted file mode 100644 index 907fe73..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.lines.strip_multiline_dangles.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.lines.to_lines.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.lines.to_lines.doctree deleted file mode 100644 index 9a96be8..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.lines.to_lines.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.lines.to_single_line.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.lines.to_single_line.doctree deleted file mode 100644 index bcacff8..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.lines.to_single_line.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.morphology.close.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.morphology.close.doctree deleted file mode 100644 index 4185ff9..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.morphology.close.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.morphology.closing.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.morphology.closing.doctree deleted file mode 100644 index 371ad14..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.morphology.closing.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.morphology.dilate.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.morphology.dilate.doctree deleted file mode 100644 index 4e9d0ab..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.morphology.dilate.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.morphology.dilation.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.morphology.dilation.doctree deleted file mode 100644 index 3f02bf0..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.morphology.dilation.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.morphology.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.morphology.doctree deleted file mode 100644 index f5bd8f6..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.morphology.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.morphology.erode.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.morphology.erode.doctree deleted file mode 100644 index c34af57..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.morphology.erode.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.morphology.erosion.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.morphology.erosion.doctree deleted file mode 100644 index 42c5ef7..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.morphology.erosion.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.morphology.opening.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.morphology.opening.doctree deleted file mode 100644 index 4229f61..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.morphology.opening.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.points.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.points.doctree deleted file mode 100644 index 9c13d2f..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.points.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.points.nearest_neighbor_within.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.points.nearest_neighbor_within.doctree deleted file mode 100644 index fba8ad7..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.points.nearest_neighbor_within.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.points.unique_line_points.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.points.unique_line_points.doctree deleted file mode 100644 index 31de907..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.points.unique_line_points.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.projection.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.projection.doctree deleted file mode 100644 index 79190f9..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.projection.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.projection.nearest_geometry.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.projection.nearest_geometry.doctree deleted file mode 100644 index 10c34bf..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.projection.nearest_geometry.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.projection.project_point_to_line.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.projection.project_point_to_line.doctree deleted file mode 100644 index 23e08bf..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.projection.project_point_to_line.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.projection.project_point_to_object.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.projection.project_point_to_object.doctree deleted file mode 100644 index 84f4fe9..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.projection.project_point_to_object.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.sanitise_poly.deflimmer.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.sanitise_poly.deflimmer.doctree deleted file mode 100644 index 57b2df3..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.sanitise_poly.deflimmer.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.sanitise_poly.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.sanitise_poly.doctree deleted file mode 100644 index e5bc199..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.sanitise_poly.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.sanitise_poly.sanitise.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.sanitise_poly.sanitise.doctree deleted file mode 100644 index 964180e..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.sanitise_poly.sanitise.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.sanitise_poly.zero_buffer.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.sanitise_poly.zero_buffer.doctree deleted file mode 100644 index 63cec6d..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.sanitise_poly.zero_buffer.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.doctree deleted file mode 100644 index 53747bb..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.well_known_binary.csv_wkt_generator.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.well_known_binary.csv_wkt_generator.doctree deleted file mode 100644 index 3c80e10..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.well_known_binary.csv_wkt_generator.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.well_known_binary.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.well_known_binary.doctree deleted file mode 100644 index d71590c..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.well_known_binary.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.well_known_binary.load_wkbs_from_csv.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.well_known_binary.load_wkbs_from_csv.doctree deleted file mode 100644 index c192a67..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.well_known_binary.load_wkbs_from_csv.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.well_known_text.csv_wkt_generator.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.well_known_text.csv_wkt_generator.doctree deleted file mode 100644 index 280778a..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.well_known_text.csv_wkt_generator.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.well_known_text.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.well_known_text.doctree deleted file mode 100644 index e431fd9..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.well_known_text.doctree and /dev/null differ diff --git a/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.well_known_text.load_wkts_from_csv.doctree b/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.well_known_text.load_wkts_from_csv.doctree deleted file mode 100644 index 21fe241..0000000 Binary files a/docs/github/doctrees/generated/jord.shapely_utilities.serialisation.well_known_text.load_wkts_from_csv.doctree and /dev/null differ diff --git a/docs/github/doctrees/getting_started.doctree b/docs/github/doctrees/getting_started.doctree deleted file mode 100644 index 7682e0e..0000000 Binary files a/docs/github/doctrees/getting_started.doctree and /dev/null differ diff --git a/docs/github/doctrees/index.doctree b/docs/github/doctrees/index.doctree deleted file mode 100644 index 4ce3c3e..0000000 Binary files a/docs/github/doctrees/index.doctree and /dev/null differ diff --git a/docs/github/html/.buildinfo b/docs/github/html/.buildinfo deleted file mode 100644 index 1a18c37..0000000 --- a/docs/github/html/.buildinfo +++ /dev/null @@ -1,4 +0,0 @@ -# Sphinx build info version 1 -# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: b097e8b862226926f62782387cb5406f -tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/github/html/_modules/index.html b/docs/github/html/_modules/index.html deleted file mode 100644 index d8933c1..0000000 --- a/docs/github/html/_modules/index.html +++ /dev/null @@ -1,385 +0,0 @@ - - - - - - - - - Overview: module code - jord 0.0.5 documentation - - - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - -

- - - - - -
-
-
- -
-
-
jord 0.0.5 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

All modules for which code is available

- -
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/github/html/_modules/jord.html b/docs/github/html/_modules/jord.html deleted file mode 100644 index 7be14b6..0000000 --- a/docs/github/html/_modules/jord.html +++ /dev/null @@ -1,486 +0,0 @@ - - - - - - - - - jord - jord 0.0.5 documentation - - - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
jord 0.0.5 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for jord

-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
-import datetime
-import os
-from warnings import warn
-
-import pkg_resources
-from apppath import AppPath
-
-__project__ = "Jord"
-__author__ = "Christian Heider Nielsen"
-__version__ = "0.0.5"
-__doc__ = r"""
-.. module:: jord
-   :platform: Unix, Windows
-   :synopsis: A set of general tools build for geo data.
-
-.. moduleauthor:: Christian Heider Nielsen <christian.heider@alexandra.dk>
-
-Created on 27/04/2019
-
-@author: cnheider
-"""
-
-from pathlib import Path
-
-with open(Path(__file__).parent / "README.md", "r") as this_init_file:
-    __doc__ += this_init_file.read()
-
-# __all__ = ['PROJECT_APP_PATH', 'PROJECT_NAME', 'PROJECT_VERSION', 'get_version']
-
-
-from typing import Any
-
-
-
[docs]def dist_is_editable(dist: Any) -> bool:
-    """
-    Return True if given Distribution is an editable installation."""
-    import sys
-    from pathlib import Path
-
-    for path_item in sys.path:
-        egg_link = Path(path_item) / f"{dist.project_name}.egg-link"
-        if egg_link.is_file():
-            return True
-    return False

-
-
-PROJECT_NAME = __project__.lower().strip().replace(" ", "_")
-PROJECT_VERSION = __version__
-PROJECT_YEAR = 2018
-PROJECT_AUTHOR = __author__.lower().strip().replace(" ", "_")
-PROJECT_ORGANISATION = "Aivclab"
-PROJECT_APP_PATH = AppPath(app_name=PROJECT_NAME, app_author=PROJECT_AUTHOR)
-PACKAGE_DATA_PATH = Path(pkg_resources.resource_filename(PROJECT_NAME, "data"))
-INCLUDE_PROJECT_READMES = False
-
-distributions = {v.key: v for v in pkg_resources.working_set}
-if PROJECT_NAME in distributions:
-    distribution = distributions[PROJECT_NAME]
-    DEVELOP = dist_is_editable(distribution)
-else:
-    DEVELOP = True
-
-
-
[docs]def get_version(append_time: Any = DEVELOP) -> str:
-    """
-
-    Args:
-      append_time:
-
-    Returns:
-
-    """
-    version = __version__
-    if not version:
-        version = os.getenv("VERSION", "0.0.0")
-
-    if append_time:
-        now = datetime.datetime.utcnow()
-        date_version = now.strftime("%Y%m%d%H%M%S")
-        # date_version = time.time()
-
-        if version:
-            # Most git tags are prefixed with 'v' (example: v1.2.3) this is
-            # never desirable for artifact repositories, so we strip the
-            # leading 'v' if it's present.
-            version = (
-                version[1:]
-                if isinstance(version, str) and version.startswith("v")
-                else version
-            )
-        else:
-            # Default version is an ISO8601 compliant datetime. PyPI doesn't allow
-            # the colon ':' character in its versions, and time is required to allow
-            # for multiple publications to master in one day. This datetime string
-            # uses the 'basic' ISO8601 format for both its date and time components
-            # to avoid issues with the colon character (ISO requires that date and
-            # time components of a date-time string must be uniformly basic or
-            # extended, which is why the date component does not have dashes.
-            #
-            # Publications using datetime versions should only be made from master
-            # to represent the HEAD moving forward.
-            warn(
-                f"Environment variable VERSION is not set, only using datetime: {date_version}"
-            )
-
-            # warn(f'Environment variable VERSION is not set, only using timestamp: {version}')
-
-        version = f"{version}.{date_version}"
-
-    return version

-
-
-if __version__ is None:
-    __version__ = get_version(append_time=True)
-
-__version_info__ = tuple(int(segment) for segment in __version__.split("."))
-
-
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/github/html/_modules/jord/gdal_utilities/cloning.html b/docs/github/html/_modules/jord/gdal_utilities/cloning.html deleted file mode 100644 index be40c6b..0000000 --- a/docs/github/html/_modules/jord/gdal_utilities/cloning.html +++ /dev/null @@ -1,409 +0,0 @@ - - - - - - - - - jord.gdal_utilities.cloning - jord 0.0.5 documentation - - - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
jord 0.0.5 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for jord.gdal_utilities.cloning

-from typing import Union
-
-from .importing import GDAL, OGR
-
-__all__ = ["clone_data_to_memory", "clone_raster_to_memory", "clone_vector_to_memory"]
-
-
-
[docs]def clone_data_to_memory(
-    ds: Union[GDAL.Dataset, OGR.DataSource], name: str = ""
-) -> Union[GDAL.Dataset, OGR.DataSource]:
-    """
-
-    :param ds:
-    :param name:
-    :return:
-    """
-    if isinstance(ds, GDAL.Dataset):
-        return clone_raster_to_memory(ds, name)
-    elif isinstance(ds, OGR.DataSource):
-        return clone_vector_to_memory(ds, name)
-    else:
-        raise TypeError("Data source must be of GDAL dataset or OGR datasource")

-
-
-
[docs]def clone_vector_to_memory(vector_ds: OGR.DataSource, name: str = "") -> OGR.DataSource:
-    """
-
-    :param vector_ds:
-    :param name:
-    :return:
-    """
-    return OGR.GetDriverByName("Memory").CopyDataSource(vector_ds, name)

-
-
-
[docs]def clone_raster_to_memory(raster_ds: GDAL.Dataset, name: str = "") -> GDAL.Dataset:
-    """
-
-    :param raster_ds:
-    :param name:
-    :return:
-    """
-    return GDAL.GetDriverByName("MEM").CopyDataSource(raster_ds, name)

-
-
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/github/html/_modules/jord/gdal_utilities/context.html b/docs/github/html/_modules/jord/gdal_utilities/context.html deleted file mode 100644 index 367a7c8..0000000 --- a/docs/github/html/_modules/jord/gdal_utilities/context.html +++ /dev/null @@ -1,409 +0,0 @@ - - - - - - - - - jord.gdal_utilities.context - jord 0.0.5 documentation - - - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
jord 0.0.5 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for jord.gdal_utilities.context

-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
-__author__ = "heider"
-__doc__ = r"""
-
-           Created on 1/16/23
-           """
-
-__all__ = ["SilenceGDALSession"]
-
-from warg import AlsoDecorator
-
-from .importing import GDAL
-
-
-
[docs]class SilenceGDALSession(AlsoDecorator):
-    """
-    Session for silencing gdal warning and errors.
-    TODO: add support for having a lasting side effect or leaving last set state of error/exception handling
-    """
-
-
[docs]    def __init__(self):
-        ...

-
-    def __enter__(self) -> bool:
-        GDAL.PushErrorHandler(
-            "CPLQuietErrorHandler"
-        )  # Stop GDAL printing both warnings and errors to STDERR
-        GDAL.UseExceptions()  # Make GDAL raise python exceptions for errors (warnings won't raise an exception)
-        return True
-
-    def __exit__(self, exc_type, exc_val, exc_tb) -> None:
-        # gdal.GetUseExceptions()
-        GDAL.PopErrorHandler()  # Pop error handler previously pushed
-        GDAL.DontUseExceptions()  # Dont use exception anymore

-        # gdal.ErrorReset()
-
-
-if __name__ == "__main__":
-    with SilenceGDALSession():
-        ...
-
-
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/github/html/_modules/jord/gdal_utilities/conversion.html b/docs/github/html/_modules/jord/gdal_utilities/conversion.html deleted file mode 100644 index 69d9c26..0000000 --- a/docs/github/html/_modules/jord/gdal_utilities/conversion.html +++ /dev/null @@ -1,480 +0,0 @@ - - - - - - - - - jord.gdal_utilities.conversion - jord 0.0.5 documentation - - - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
jord 0.0.5 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for jord.gdal_utilities.conversion

-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
-__author__ = "heider"
-__doc__ = r"""
-
-           Created on 5/5/22
-           """
-
-from pathlib import Path
-from typing import List
-
-from jord.gdal_utilities.enums import GdalAccessEnum
-from jord.gdal_utilities.importing import GDAL, OSR
-
-__all__ = [
-    "get_georeference_from_file",
-    "set_georeference_to_file",
-    "geotiff_to_tiff",
-    "tiff_to_geotiff",
-    "copy_gcps_to_file",
-]
-
-
-
[docs]def get_georeference_from_file(file: Path) -> List[GDAL.GCP]:
-    """
-
-    :param file:
-    :type file:
-    :return:
-    :rtype:
-    """
-    with GDAL.Open(file) as f:
-        # return ds.GetProjection()
-        # return f.GetGCPs()
-        return f.GetGeoTransform()

-
-
-
[docs]def set_georeference_to_file(file: Path, gcps: List[GDAL.GCP]) -> None:
-    """
-
-    :param file:
-    :type file:
-    :param gcps:
-    :type gcps:
-
-    TODO: FINISH!
-
-    """
-    img_path = "/path/to/tif"
-
-    # input values for geotransform
-    ulx = 25
-    uly = 60
-    xres = 0.5
-    yres = -0.5
-    xrot = 0
-    yrot = 0
-
-    geotransform = (ulx, xres, xrot, uly, yrot, yres)
-
-    # find projection
-    srs = OSR.SpatialReference()
-    srs.ImportFromEPSG(4326)
-
-    # update image georeference
-    ds = GDAL.Open(img_path, GdalAccessEnum.update.value)
-    ds.SetGeoTransform(geotransform)
-    ds.SetProjection(srs.ExportToWkt())
-    ds.FlushCache()
-    del ds

-
-    # do this for each image and then stack
-
-
-
[docs]def copy_gcps_to_file(file: Path, gcps: List[GDAL.GCP]) -> None:
-    """
-
-    :param file:
-    :type file:
-    :param gcps:
-    :type gcps:
-    """
-
-    with GDAL.Open(file, GdalAccessEnum.update.value) as f:
-        f.SetGCPs(gcps)
-        f.FlushCache()

-
-
-
[docs]def geotiff_to_tiff(src: Path, dst: Path) -> None:
-    """
-    https://gdal.org/user/translate.html
-    """
-    GDAL.Translate(
-        dst,
-        src,
-        format="JPEG",
-        outputType=GDAL.GDT_Byte,
-        creationOptions=["COMPRESS=LZW"],
-    )

-
-
-
[docs]def tiff_to_geotiff(src: Path, dst: Path) -> None:
-    """
-    https://gdal.org/user/translate.html
-    """
-    GDAL.Translate(
-        dst,
-        src,
-        format="GTiff",
-        outputType=GDAL.GDT_Byte,
-        creationOptions=["COMPRESS=LZW"],
-    )

-
-
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/github/html/_modules/jord/gdal_utilities/importing.html b/docs/github/html/_modules/jord/gdal_utilities/importing.html deleted file mode 100644 index bfd0635..0000000 --- a/docs/github/html/_modules/jord/gdal_utilities/importing.html +++ /dev/null @@ -1,429 +0,0 @@ - - - - - - - - - jord.gdal_utilities.importing - jord 0.0.5 documentation - - - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
jord 0.0.5 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for jord.gdal_utilities.importing

-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
-__author__ = "heider"
-__doc__ = r"""
-
-           Created on 5/5/22
-           """
-
-__all__ = ["import_gdal", "import_osr", "import_ogr", "GDAL", "OSR", "OGR"]
-
-from types import ModuleType
-
-
-
[docs]def import_gdal() -> ModuleType:
-    try:
-        import gdal
-
-    except (ImportError, ModuleNotFoundError) as e:
-        try:
-            from osgeo import gdal
-        except Exception as e2:
-            raise ImportError(f"gdal is not installed {type(e), e, type(e2), e2}")
-
-    gdal.UseExceptions()
-
-    return gdal

-
-
-
[docs]def import_osr() -> ModuleType:
-    try:
-        import ors
-
-    except (ImportError, ModuleNotFoundError) as e:
-        try:
-            from osgeo import osr
-        except Exception as e2:
-            raise ImportError(f"osr is not installed {type(e), e, type(e2), e2}")
-
-    osr.UseExceptions()
-
-    return osr

-
-
-
[docs]def import_ogr() -> ModuleType:
-    try:
-        import ogr
-
-    except (ImportError, ModuleNotFoundError) as e:
-        try:
-            from osgeo import ogr
-        except Exception as e2:
-            raise ImportError(f"ogr is not installed {type(e), e, type(e2), e2}")
-
-    ogr.UseExceptions()
-
-    return ogr

-
-
-GDAL = import_gdal()
-OSR = import_osr()
-OGR = import_ogr()
-
-
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/github/html/_modules/jord/geojson_utilities/geometry_types.html b/docs/github/html/_modules/jord/geojson_utilities/geometry_types.html deleted file mode 100644 index 9e1f393..0000000 --- a/docs/github/html/_modules/jord/geojson_utilities/geometry_types.html +++ /dev/null @@ -1,401 +0,0 @@ - - - - - - - - - jord.geojson_utilities.geometry_types - jord 0.0.5 documentation - - - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
jord 0.0.5 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for jord.geojson_utilities.geometry_types

-from enum import Enum
-
-from geojson import (
-    Point,
-    LineString,
-    Polygon,
-    MultiPoint,
-    MultiLineString,
-    MultiPolygon,
-    GeometryCollection,
-)
-
-
-__all__ = ["GeoJsonGeometryTypesEnum"]
-
-
-
[docs]class GeoJsonGeometryTypesEnum(Enum):
-    """
-    This enum is useful for exhaustively iterating possible geojson types.
-    """
-
-    point = Point  #
-
-    line_string = LineString  #
-
-    polygon = Polygon  #
-
-    multi_point = MultiPoint  #
-
-    multi_line_string = MultiLineString  #
-
-    multi_polygon = MultiPolygon  #
-
-    geometry_collection = GeometryCollection  #

-
-
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/github/html/_modules/jord/shapely_utilities/analysis/degrees_of_freedom.html b/docs/github/html/_modules/jord/shapely_utilities/analysis/degrees_of_freedom.html deleted file mode 100644 index 24bbfc5..0000000 --- a/docs/github/html/_modules/jord/shapely_utilities/analysis/degrees_of_freedom.html +++ /dev/null @@ -1,392 +0,0 @@ - - - - - - - - - jord.shapely_utilities.analysis.degrees_of_freedom - jord 0.0.5 documentation - - - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
jord 0.0.5 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for jord.shapely_utilities.analysis.degrees_of_freedom

-from typing import Sequence
-
-from shapely import Polygon, LineString
-
-
-
[docs]def is_2d_translatable():
-    ...

-
-
-
[docs]def has_touches_across_centroid_buffer(
-    poly: Polygon,
-    exterior_intersections: Sequence[LineString],
-    centroid_buffer_size: float = 0.1,
-) -> bool:
-    poly.centroid.buffer()
-
-    ...

-
-
-
[docs]def is_simple_shape():
-    ...

-
-
-
[docs]def has_3_sides_touching():
-    ...

-
-
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/github/html/_modules/jord/shapely_utilities/analysis/tracing.html b/docs/github/html/_modules/jord/shapely_utilities/analysis/tracing.html deleted file mode 100644 index 92c0d94..0000000 --- a/docs/github/html/_modules/jord/shapely_utilities/analysis/tracing.html +++ /dev/null @@ -1,372 +0,0 @@ - - - - - - - - - jord.shapely_utilities.analysis.tracing - jord 0.0.5 documentation - - - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
jord 0.0.5 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for jord.shapely_utilities.analysis.tracing

-from shapely import LinearRing
-
-
-
[docs]def trace_for_inner_ring(geometry) -> LinearRing:
-    pass

-
-
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/github/html/_modules/jord/shapely_utilities/clamp.html b/docs/github/html/_modules/jord/shapely_utilities/clamp.html deleted file mode 100644 index 8b27d44..0000000 --- a/docs/github/html/_modules/jord/shapely_utilities/clamp.html +++ /dev/null @@ -1,625 +0,0 @@ - - - - - - - - - jord.shapely_utilities.clamp - jord 0.0.5 documentation - - - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
jord 0.0.5 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for jord.shapely_utilities.clamp

-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
-__author__ = "heider"
-__doc__ = r"""
-
-           Created on 1/23/23
-           """
-
-__all__ = [
-    "split_line_string",
-    "unsplit_line_string",
-    "extend_segment",
-    "fix_starting_point",
-    "adjust_line_end",
-    "ensure_list_of_geometries",
-]
-
-from collections import deque
-from typing import List, Sequence, Union
-
-from shapely.geometry import LineString, MultiLineString, Point, Polygon
-from shapely.geometry.base import BaseGeometry, BaseMultipartGeometry
-
-
-
[docs]def split_line_string(line_string: LineString) -> Sequence[LineString]:
-    """
-    Break a LineString
-
-    :param line_string:
-    :return:
-    """
-    for start, end in zip(line_string.coords[:-1], line_string.coords[1:]):
-        yield LineString((start, end))

-
-
-
[docs]def unsplit_line_string(segments: Sequence[LineString]) -> LineString:
-    """
-
-    :param segments:
-    :return:
-    """
-    coords = [segments[0].coords[0]]
-
-    for segment in segments:
-        coords.extend(segment.coords[1:])
-
-    return LineString(coords)

-
-
-
[docs]def extend_segment(line_string: LineString) -> LineString:
-    """
-    Move a line segment's start and end away from each other to ensure intersections
-
-    :param line_string:
-    :return:
-    """
-    p0 = line_string.coords[0]
-    p1 = line_string.coords[1]
-
-    difference = (p0[0] - p1[0], p0[1] - p1[1])
-    length = (difference[0] ** 2 + difference[1] ** 2) ** 0.5
-    direction = (difference[0] / length, difference[1] / length)
-    offset = (direction[0] * 1e-12, direction[1] * 1e-12)
-
-    new_p0 = (p0[0] + offset[0], p0[1] + offset[1])
-    new_p1 = (p1[0] - offset[0], p1[1] - offset[1])
-
-    return LineString((new_p0, new_p1))

-
-
-
[docs]def fix_starting_point(polygon_pieces: Sequence[Polygon]) -> Sequence[Polygon]:
-    """
-    Reconnect the starting point of a polygon's pieces.
-    When splitting a polygon with two lines, we want to get two pieces.
-    However, that's not quite how Shapely works.  The outline of the
-    polygon is a LinearRing that starts and ends at the same place, but
-    Shapely still knows where that starting point is and splits there
-    too.
-    We don't want that third piece, so we'll reconnect the segments that
-    touch the starting point.
-
-
-    :param polygon_pieces:
-    :return:
-    """
-
-    if len(polygon_pieces) == 3:
-        # Fortunately, Shapely keeps the starting point of the LinearRing
-        # as the starting point of the first segment.  That means it's also
-        # the ending point of the last segment.  Reconnecting is super simple:
-        return [
-            polygon_pieces[1],
-            LineString(polygon_pieces[2].coords[:] + polygon_pieces[0].coords[1:]),
-        ]
-    else:
-        return polygon_pieces  # We probably cut exactly at the starting point.

-
-
-
[docs]def adjust_line_end(line: LineString, end: BaseGeometry) -> LineString:
-    """
-    Reverse line if necessary to ensure that it ends near end.
-
-    :param line:
-    :param end:
-    :return:
-    """
-
-    line_start = Point(*line.coords[0])
-    line_end = Point(*line.coords[-1])
-
-    if line_end.distance(end) < line_start.distance(end):
-        return line
-    else:
-        return LineString(line.coords[::-1])

-
-
-
[docs]def ensure_list_of_geometries(
-    thing: Union[BaseGeometry, BaseMultipartGeometry]
-) -> List[BaseGeometry]:
-    """
-
-    :param thing:
-    :return:
-    """
-    if False:
-        try:  # Not MultiGeometry base class for shapely
-            return list(thing.geoms)
-        except AttributeError:
-            return [thing]
-    if isinstance(thing, BaseMultipartGeometry):
-        return list(thing.geoms)
-    return [thing]

-
-
-def clamp_linestring_to_polygon(
-    line_string: LineString, polygon: Polygon
-) -> LineString:
-    """
-
-    :param line_string:
-    :param polygon:
-    :return:
-    """
-    segments = deque(split_line_string(line_string))
-    result = []
-    exiting_segment = None
-    was_inside = False
-
-    # contains() checks can fail without this.
-    buffered_polygon = polygon.buffer(1e-9)
-
-    while segments:
-        current_segment = segments.popleft()
-        pieces = ensure_list_of_geometries(current_segment.difference(polygon.exterior))
-
-        if pieces[0].coords[0] != current_segment.coords[0]:
-            # The initial part of this line segment coincided with part of the
-            # polygon border and was removed.
-
-            if was_inside:
-                # If we were already inside, we include this border segment.
-                result.append(
-                    LineString((current_segment.coords[0], pieces[0].coords[0]))
-                )
-
-            # Push the rest back on to be processed later.
-            # Note that extendleft() reverses its arguments, so we have to compensate.
-            segments.extendleft(reversed(pieces))
-
-        elif len(pieces) > 1 and pieces[0].coords[-1] != pieces[1].coords[0]:
-            # There's an initial segment, then a portion that coincided with
-            # part of the polygon border.  Break this segment apart and re-process.
-
-            segments.appendleft(
-                LineString((pieces[0].coords[1], current_segment.coords[-1]))
-            )
-            segments.appendleft(pieces[0])
-
-        elif len(pieces) == 1:
-            # This segment is either all inside or all outside the polygon.
-
-            is_inside = buffered_polygon.contains(current_segment)
-            if is_inside and not was_inside:
-                # We've crossed from outside to inside exactly at the starting
-                # point of this line segment.
-
-                if exiting_segment:
-                    # Earlier we crossed out from the inside, now we're
-                    # crossing back in.  Find the shortest path along
-                    # the border that gets from the exit point to the
-                    # entry point and add it to the result.
-
-                    entering_segment = extend_segment(current_segment)
-
-                    difference = polygon.boundary.difference(
-                        MultiLineString((exiting_segment, entering_segment))
-                    )
-
-                    polygon_pieces = ensure_list_of_geometries(difference)
-                    polygon_pieces = fix_starting_point(polygon_pieces)
-
-                    if len(polygon_pieces) == 1:
-                        # We re-entered exactly where we left, so we
-                        # don't include any of the border.
-                        pass
-                    else:
-                        shorter = min(polygon_pieces, key=lambda piece: piece.length)
-
-                        # We don't know which direction the polygon border
-                        # piece should be.  adjust_line_end() will figure
-                        # that out.
-                        result.append(
-                            adjust_line_end(shorter, Point(*current_segment.coords[0]))
-                        )
-
-                    exiting_segment = None
-
-                result.append(current_segment)
-            elif was_inside and not is_inside:
-                # Like the previous case, but we've crossed to outside.  Store
-                # an extended version of this segment as the exit point.
-                exiting_segment = extend_segment(current_segment)
-            elif is_inside:
-                result.append(current_segment)
-
-            was_inside = is_inside
-
-        elif len(pieces) > 1:
-            # This segment crosses the border, or touches the border at a single point,
-            # or maybe crosses multiple times, etc.  Split the first portion off and
-            # push it and the rest to be reprocessed in the following iterations.
-
-            segments.appendleft(
-                LineString((pieces[0].coords[1], current_segment.coords[-1]))
-            )
-            segments.appendleft(pieces[0])
-
-    return unsplit_line_string(result)
-
-
-if __name__ == "__main__":
-
-    def _main():
-        from draugr.numpy_utilities import HilbertCurve
-        from geopandas import GeoSeries
-        from matplotlib import pyplot
-
-        hilbert_curve = HilbertCurve(5, 2)
-        hc = LineString(hilbert_curve.points_from_distances(range(1023)))
-        circle = Point(15, 15).buffer(15)
-        clamped = clamp_linestring_to_polygon(hc, circle)
-
-        gs = GeoSeries([clamped])
-        gs.plot()
-        pyplot.show()
-
-    _main()
-
-
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/github/html/_modules/jord/shapely_utilities/geometry_types.html b/docs/github/html/_modules/jord/shapely_utilities/geometry_types.html deleted file mode 100644 index 554c326..0000000 --- a/docs/github/html/_modules/jord/shapely_utilities/geometry_types.html +++ /dev/null @@ -1,407 +0,0 @@ - - - - - - - - - jord.shapely_utilities.geometry_types - jord 0.0.5 documentation - - - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
jord 0.0.5 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for jord.shapely_utilities.geometry_types

-from enum import Enum
-
-from shapely import (
-    Point,
-    LineString,
-    LinearRing,
-    Polygon,
-    MultiPoint,
-    MultiLineString,
-    MultiPolygon,
-    GeometryCollection,
-)
-
-__all__ = ["ShapelyGeometryTypesEnum"]
-
-
-
[docs]class ShapelyGeometryTypesEnum(Enum):
-    """
-    This enum is useful for exhaustively iterating possible shapely types.
-    """
-
-    point = Point  # Point(*args) # A geometry type that represents a single coordinate with x,y and possibly z values.
-
-    line_string = LineString  # LineString([coordinates]) # A geometry type composed of one or more line segments.
-
-    linear_ring = LinearRing  # LinearRing([coordinates]) # A geometry type composed of one or more line segments that forms a closed loop.
-
-    polygon = Polygon  #  Polygon([shell, holes]) # A geometry type representing an area that is enclosed by a linear ring.
-
-    multi_point = (
-        MultiPoint  # MultiPoint([points]) # A collection of one or more Points.
-    )
-
-    multi_line_string = MultiLineString  # MultiLineString([lines]) # A collection of one or more LineStrings.
-
-    multi_polygon = (
-        MultiPolygon  # MultiPolygon([polygons]) # A collection of one or more Polygons.
-    )
-
-    geometry_collection = GeometryCollection  # GeometryCollection([geoms]) # A collection of one or more geometries that  may contain more than  one type of geometry.

-
-
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/github/html/_modules/jord/shapely_utilities/iteration.html b/docs/github/html/_modules/jord/shapely_utilities/iteration.html deleted file mode 100644 index 3ce0c14..0000000 --- a/docs/github/html/_modules/jord/shapely_utilities/iteration.html +++ /dev/null @@ -1,392 +0,0 @@ - - - - - - - - - jord.shapely_utilities.iteration - jord 0.0.5 documentation - - - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
jord 0.0.5 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for jord.shapely_utilities.iteration

-from typing import Sequence, Any, Tuple
-
-__all__ = ["pairs"]
-
-
-
[docs]def pairs(s: Sequence) -> Tuple[Any, Any]:
-    """
-    Iterate over a list in overlapping pairs.
-
-    Usage:
-        lst = [4, 7, 11, 2]
-        pairs(lst) yields (4, 7), (7, 11), (11, 2)
-
-    http://stackoverflow.com/questions/1257413/1257446#1257446
-
-
-    :param s: an iterable/list
-    :return: Yields a pair of consecutive elements (lst[k], lst[k+1]) of lst. Last call yields (lst[-2], lst[-1]).
-    """
-    i = iter(s)
-    prev = next(i)
-
-    for item in i:
-        yield prev, item
-        prev = item

-
-
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/github/html/_modules/jord/shapely_utilities/lines.html b/docs/github/html/_modules/jord/shapely_utilities/lines.html deleted file mode 100644 index ae90093..0000000 --- a/docs/github/html/_modules/jord/shapely_utilities/lines.html +++ /dev/null @@ -1,811 +0,0 @@ - - - - - - - - - jord.shapely_utilities.lines - jord 0.0.5 documentation - - - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
jord 0.0.5 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for jord.shapely_utilities.lines

-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
-__author__ = "heider"
-__doc__ = r"""
-
-           Created on 1/23/23
-           """
-
-__all__ = [
-    "to_lines",
-    "to_single_line",
-    "explode_line",
-    "strip_multiline_dangles",
-    "strip_line_dangles",
-]
-
-import collections
-from typing import Union, List, Sequence
-
-import shapely.ops
-from shapely.geometry import LineString, MultiLineString, Point, MultiPoint, box
-from shapely.geometry.base import BaseGeometry
-
-from jord.shapely_utilities.points import (
-    unique_line_points,
-    nearest_neighbor_within,
-)
-
-
-
[docs]def to_single_line(s: Union[LineString, MultiLineString]) -> LineString:
-    """
-    assume that lines are ordered, NOTE closes of gaps!
-
-    :param s:
-    :type s: Union[LineString, MultiLineString]
-    :return:
-    :rtype: LineString
-    """
-    if isinstance(s, MultiLineString):
-        out_coords = [
-            list(i.coords) for i in s.geoms
-        ]  # Put the sub-line coordinates into a list of sublists
-
-        return LineString(
-            [i for sublist in out_coords for i in sublist]
-        )  # Flatten the list of sublists and use it to make a new line
-
-    elif isinstance(s, LineString):
-        return s
-    else:
-        raise NotImplementedError

-
-
-
[docs]def to_lines(geoms: Sequence[BaseGeometry]) -> List[LineString]:
-    """
-    Converts Shapely geoms in to Shapely LineString
-
-    :param geoms:
-    :type geoms: Sequence[BaseGeometry]
-    :return:
-    :rtype: List[LineString]
-    """
-
-    lines = []
-    for g in geoms:
-        if isinstance(g, (LineString)):
-            lines.append(g)
-        elif isinstance(g, (BaseGeometry)):
-            boundary = g.boundary
-            if isinstance(boundary, MultiLineString):
-                lines.extend(to_lines(boundary.geoms))
-            else:
-                lines.append(boundary)
-        else:
-            raise NotImplementedError(f"{g, type(g)}")
-
-    return lines

-
-
-
[docs]def strip_line_dangles(
-    line: LineString, dangle_length_threshold: float = 0.1, iterations: int = 3
-) -> LineString:
-    """
-
-    :param line:
-    :type line: LineString
-    :param dangle_length_threshold:
-    :type dangle_length_threshold: float
-    :param iterations:
-    :type iterations: int
-    :return:
-    :rtype: LineString
-    """
-
-    working_line = line
-    for ith_ in range(iterations):
-        working_segments = []
-        segments = explode_line(working_line)
-        if len(segments) > 2:
-            start, *rest, end = segments
-
-            if start.length > dangle_length_threshold:
-                working_segments.append(start)
-
-            working_segments.extend(rest)
-
-            if end.length > dangle_length_threshold:
-                working_segments.append(end)
-
-        elif len(segments) < 2:
-            segment = segments[0]
-
-            if segment.length > dangle_length_threshold:
-                working_segments.append(segment)
-
-        else:
-            s1, s2 = segments
-
-            if s1.length > dangle_length_threshold:
-                working_segments.append(s1)
-
-            if s2.length > dangle_length_threshold:
-                working_segments.append(s2)
-
-        working_line = LineString(working_segments)
-
-    return working_line

-
-
-def line_endpoints(lines: List[LineString] | MultiLineString) -> MultiPoint:
-    """Return list of terminal points from list of LineStrings."""
-
-    all_points = []
-    if isinstance(lines, MultiLineString):
-        lines = lines.geoms
-
-    for line in lines:
-        for i in [0, -1]:  # start and end point
-            all_points.append(line.coords[i])
-
-    endpoints = set(
-        [item for item, count in collections.Counter(all_points).items() if count < 2]
-    )  # Remove duplicates
-
-    return MultiPoint([Point(p) for p in endpoints])
-
-
-
[docs]def strip_multiline_dangles(
-    multilinestring: MultiLineString,
-    dangle_length_threshold: float = 0.1,
-    iterations: int = 3,
-) -> MultiLineString:
-    """
-
-    :param multilinestring:
-    :type multilinestring: MultiLineString
-    :param dangle_length_threshold:
-    :type dangle_length_threshold: float
-    :param iterations:
-    :type iterations: int
-    :return:
-    :rtype: MultiLineString
-    """
-    working_multi = multilinestring
-    for ith_ in range(iterations):
-        endpoints = line_endpoints(working_multi)
-        working_segments = []
-        for linestring in working_multi.geoms:
-            segments = explode_line(linestring)
-            if len(segments) > 2:
-                start, *rest, end = segments
-                if start.intersects(endpoints):
-                    if start.length > dangle_length_threshold:
-                        working_segments.append(start)
-                else:
-                    working_segments.append(start)
-
-                working_segments.extend(rest)
-
-                if end.intersects(endpoints):
-                    if end.length > dangle_length_threshold:
-                        working_segments.append(end)
-                else:
-                    working_segments.append(end)
-            elif len(segments) < 2:
-                segment = segments[0]
-                if segment.intersects(endpoints):
-                    if segment.length > dangle_length_threshold:
-                        working_segments.append(segment)
-                else:
-                    working_segments.append(segment)
-            else:
-                s1, s2 = segments
-                if s1.intersects(endpoints):
-                    if s1.length > dangle_length_threshold:
-                        working_segments.append(s1)
-                else:
-                    working_segments.append(s1)
-
-                if s2.intersects(endpoints):
-                    if s2.length > dangle_length_threshold:
-                        working_segments.append(s2)
-                else:
-                    working_segments.append(s2)
-
-        working_multi = MultiLineString(working_segments)
-
-    return working_multi

-
-
-
[docs]def explode_line(line: LineString) -> List[LineString]:
-    """
-
-    :param line:
-    :return:
-    """
-    out = []
-    for pt1, pt2 in zip(
-        line.coords, line.coords[1:]
-    ):  # iterate from first cord, iterate from second coords to get
-        # endpoints of each segment
-        out.append(LineString([pt1, pt2]))
-    return out

-
-
-if __name__ == "__main__":
-
-    def iashdh():
-        print(
-            to_single_line(MultiLineString([[[0, 0], [0, 1]], [[0, 2], [0, 3]]]))
-        )  # LINESTRING (0 0, 0 1, 0 2, 0 3)
-
-    def ausdh():
-        from shapely.geometry import MultiPolygon, Point
-
-        pol1 = MultiPolygon([Point(0, 0).buffer(2.0), Point(1, 1).buffer(2.0)])
-        pol2 = Point(7, 8).buffer(1.0)
-        pols = [pol1, pol2]
-
-        print(to_lines(pols))
-
-    ausdh()
-
-
-def find_isolated_endpoints(lines):
-    """Find endpoints of lines that don't touch another line.
-
-    Args:
-        lines: a list of LineStrings or a MultiLineString
-
-    Returns:
-        A list of line end Points that don't touch any other line of lines
-    """
-
-    isolated_endpoints = []
-    for i, line in enumerate(lines):
-        other_lines = lines[:i] + lines[i + 1 :]
-        for q in [0, -1]:
-            endpoint = Point(line.coords[q])
-            if any(endpoint.touches(another_line) for another_line in other_lines):
-                continue
-            else:
-                isolated_endpoints.append(endpoint)
-    return isolated_endpoints
-
-
-def snappy_endings(lines, max_distance):
-    """Snap endpoints of lines together if they are at most max_length apart.
-
-    Args:
-        lines: a list of LineStrings or a MultiLineString
-        max_distance: maximum distance two endpoints may be joined together
-    """
-
-    # initialize snapped lines with list of original lines
-    # snapping points is a MultiPoint object of all vertices
-    snapped_lines = [line for line in lines]
-    snapping_points = unique_line_points(snapped_lines)
-
-    # isolated endpoints are going to snap to the closest vertex
-    isolated_endpoints = find_isolated_endpoints(snapped_lines)
-
-    # only move isolated endpoints, one by one
-    for endpoint in isolated_endpoints:
-        # find all vertices within a radius of max_distance as possible
-        target = nearest_neighbor_within(snapping_points, endpoint, max_distance)
-
-        # do nothing if no target point to snap to is found
-        if not target:
-            continue
-
-            # find the LineString to modify within snapped_lines and update it
-        for i, snapped_line in enumerate(snapped_lines):
-            if endpoint.touches(snapped_line):
-                snapped_lines[i] = bend_towards(snapped_line, where=endpoint, to=target)
-                break
-
-        # also update the corresponding snapping_points
-        for i, snapping_point in enumerate(snapping_points):
-            if endpoint.equals(snapping_point):
-                snapping_points[i] = target
-                break
-
-    # post-processing: remove any resulting lines of length 0
-    snapped_lines = [s for s in snapped_lines if s.length > 0]
-
-    return snapped_lines
-
-
-def bend_towards(line, where, to):
-    """Move the point where along a line to the point at location to.
-
-    Args:
-        line: a LineString
-        where: a point ON the line (not necessarily a vertex)
-        to: a point NOT on the line where the nearest vertex will be moved to
-
-    Returns:
-        the modified (bent) line
-    """
-
-    if not line.contains(where) and not line.touches(where):
-        raise ValueError("line does not contain the point where.")
-
-    coords = line.coords[:]
-    # easy case: where is (within numeric precision) a vertex of line
-    for k, vertex in enumerate(coords):
-        if where.almost_equals(Point(vertex)):
-            # move coordinates of the vertex to destination
-            coords[k] = to.coords[0]
-            return LineString(coords)
-
-    # hard case: where lies between vertices of line, so
-    # find the nearest vertex and move that one to point to
-    _, min_k = min(
-        (where.distance(Point(vertex)), k) for k, vertex in enumerate(coords)
-    )
-    coords[min_k] = to.coords[0]
-    return LineString(coords)
-
-
-def prune_short_lines(lines: Sequence[LineString], min_length: float):
-    """Remove lines from a LineString shorter than min_length.
-
-    Deletes all lines from a list of LineStrings or a MultiLineString
-    that have a total length of less than min_length. Vertices of touching
-    lines are contracted towards the centroid of the removed line.
-
-    Args:
-        lines: list of LineStrings or a MultiLineString
-        min_length: minimum length of a single LineString to be preserved
-
-    Returns:
-        the pruned pandas DataFrame
-    """
-    pruned_lines = [line for line in lines]  # converts MultiLineString to list
-    to_prune = []
-
-    for i, line in enumerate(pruned_lines):
-        if line.length < min_length:
-            to_prune.append(i)
-            for n in intersecting_lines_idx(pruned_lines, line):
-                contact_point = line.intersection(pruned_lines[n])
-                pruned_lines[n] = bend_towards(
-                    pruned_lines[n], where=contact_point, to=line.centroid
-                )
-
-    return [line for i, line in enumerate(pruned_lines) if i not in to_prune]
-
-
-def linemerge(line_s: LineString | MultiLineString) -> LineString | MultiLineString:
-    """
-    Merge list of LineStrings and/or MultiLineStrings.
-
-    Given a list of LineStrings and possibly MultiLineStrings, merge all of
-    them to a single MultiLineString.
-
-
-    :type line_s: LineString|MultiLineString
-    :rtype:LineString|MultiLineString
-    """
-    lines = []
-    for line in line_s.geoms:
-        if isinstance(line, MultiLineString):
-            # line is a multilinestring, so append its components
-            lines.extend(line.geoms)
-        else:
-            # line is a line, so simply append it
-            lines.append(line)
-
-    return shapely.ops.linemerge(lines)
-
-
-def one_linestring_per_intersection(lines: Sequence[LineString]):
-    """Move line endpoints to intersections of line segments.
-
-    Given a list of touching or possibly intersecting LineStrings, return a
-    list LineStrings that have their endpoints at all crossings and
-    intersecting points and ONLY there.
-
-    Args:
-        a list of LineStrings or a MultiLineString
-
-    Returns:
-        a list of LineStrings
-    """
-    lines_merged = shapely.ops.linemerge(lines)
-
-    # intersecting multiline with its bounding box somehow triggers a first
-    bounding_box = box(*lines_merged.bounds)
-
-    # perform linemerge (one linestring between each crossing only)
-    # if this fails, write function to perform this on a bbox-grid and then
-    # merge the result
-    lines_merged = lines_merged.intersection(bounding_box)
-    lines_merged = shapely.ops.linemerge(lines_merged)
-    return lines_merged
-
-
-def intersecting_lines_idx(of: LineString, lines: Sequence[LineString]) -> List[int]:
-    """Find the indices in a list of LineStrings that touch a given LineString.
-
-    Args:
-        lines: list of LineStrings in which to search for neighbors
-        of: the LineString which must be touched
-
-    Returns:
-        list of indices, so that all lines[indices] touch the LineString of
-    """
-    return [k for k, line in enumerate(lines) if line.touches(of)]
-
-
-def intersecting_lines(of: LineString, lines: Sequence[LineString]) -> List[LineString]:
-    """Find the indices in a list of LineStrings that touch a given LineString.
-
-    Args:
-        lines: list of LineStrings in which to search for neighbors
-        of: the LineString which must be touched
-
-    Returns:
-        list of indices, so that all lines[indices] touch the LineString of
-    """
-    return [line for line in (lines) if line.touches(of)]
-
-
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/github/html/_modules/jord/shapely_utilities/morphology.html b/docs/github/html/_modules/jord/shapely_utilities/morphology.html deleted file mode 100644 index e8b2650..0000000 --- a/docs/github/html/_modules/jord/shapely_utilities/morphology.html +++ /dev/null @@ -1,467 +0,0 @@ - - - - - - - - - jord.shapely_utilities.morphology - jord 0.0.5 documentation - - - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
jord 0.0.5 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for jord.shapely_utilities.morphology

-from shapely.geometry.base import BaseGeometry
-
-__all__ = ["closing", "opening", "erode", "erosion", "dilate", "dilation", "close"]
-
-
-
[docs]def erosion(geom: BaseGeometry, eps: float = 1e-7) -> BaseGeometry:
-    """
-
-    :param geom:
-    :param eps:
-    :return:
-    """
-    return geom.buffer(-eps)

-
-
-erode = erosion
-
-
-
[docs]def dilation(geom: BaseGeometry, eps: float = 1e-7) -> BaseGeometry:
-    """
-
-    :param geom:
-    :param eps:
-    :return:
-    """
-    return geom.buffer(eps)

-
-
-dilate = dilation
-
-
-
[docs]def closing(geom: BaseGeometry, eps: float = 1e-7) -> BaseGeometry:
-    """
-
-    :param geom:
-    :param eps:
-    :return:
-    """
-    return erode(dilate(geom, eps), eps)

-
-
-close = closing
-
-
-
[docs]def opening(geom: BaseGeometry, eps: float = 1e-7) -> BaseGeometry:
-    """
-
-    :param geom:
-    :param eps:
-    :return:
-    """
-    return dilate(erode(geom, eps), eps)

-
-
-# open = opening # keyword clash
-
-if __name__ == "__main__":
-
-    def aishdjauisd():
-        # Import constructors for creating geometry collections
-        from shapely.geometry import MultiPoint, MultiLineString
-
-        # Import necessary geometric objects from shapely module
-        from shapely.geometry import Point, LineString, Polygon
-
-        # Create Point geometric object(s) with coordinates
-        point1 = Point(2.2, 4.2)
-        point2 = Point(7.2, -25.1)
-        point3 = Point(9.26, -2.456)
-        # point3D = Point(9.26, -2.456, 0.57)
-
-        # Create a MultiPoint object of our points 1,2 and 3
-        multi_point = MultiPoint([point1, point2, point3])
-
-        # It is also possible to pass coordinate tuples inside
-        multi_point2 = MultiPoint([(2.2, 4.2), (7.2, -25.1), (9.26, -2.456)])
-
-        # We can also create a MultiLineString with two lines
-        line1 = LineString([point1, point2])
-        line2 = LineString([point2, point3])
-        multi_line = MultiLineString([line1, line2])
-        polygon = Polygon([point2, point1, point3])
-
-        from shapely.geometry import GeometryCollection
-        from matplotlib import pyplot
-        import geopandas as gpd
-
-        geoms = GeometryCollection([multi_point, multi_point2, multi_line, polygon])
-
-        # A positive distance produces a dilation, a negative distance an erosion. A very small or zero distance may sometimes be used to “tidy” a polygon.
-        geoms = opening(geoms)
-        geoms = dilate(geoms)
-        geoms = closing(geoms)
-        geoms = erode(geoms)
-
-        p = gpd.GeoSeries(geoms)
-        p.plot()
-        pyplot.show()
-
-    aishdjauisd()
-
-
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/github/html/_modules/jord/shapely_utilities/points.html b/docs/github/html/_modules/jord/shapely_utilities/points.html deleted file mode 100644 index 986c628..0000000 --- a/docs/github/html/_modules/jord/shapely_utilities/points.html +++ /dev/null @@ -1,417 +0,0 @@ - - - - - - - - - jord.shapely_utilities.points - jord 0.0.5 documentation - - - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
jord 0.0.5 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for jord.shapely_utilities.points

-from typing import Sequence, List, Optional
-
-from shapely import LineString, Point, MultiPoint
-
-
-__all__ = ["unique_line_points", "nearest_neighbor_within"]
-
-
-
[docs]def unique_line_points(lines: Sequence[LineString]) -> List[Point]:
-    """
-
-
-    :param lines:
-    :return: Return list of unique vertices from list of LineStrings.
-    :rtype: List[Point]
-    """
-
-    vertices = []
-
-    for line in lines:
-        vertices.extend(list(line.coords))
-
-    return [Point(p) for p in set(vertices)]

-
-
-
[docs]def nearest_neighbor_within(others: Sequence, point, max_distance) -> Optional[Point]:
-    """Find the nearest point among others up to a maximum distance.
-
-
-    :param others: a list of Points or a MultiPoint
-    :param point: a Point
-    :param max_distance: maximum distance to search for the nearest neighbor
-
-    :return: A shapely Point if one is within max_distance, None otherwise
-    :rtype: Optional[Point]
-    """
-    search_region = point.buffer(max_distance)
-    interesting_points = search_region.intersection(MultiPoint(others))
-
-    if not interesting_points:
-        closest_point = None
-    elif isinstance(interesting_points, Point):
-        closest_point = interesting_points
-    else:
-        distances = [
-            point.distance(ip) for ip in interesting_points if point.distance(ip) > 0
-        ]
-        closest_point = interesting_points[distances.index(min(distances))]
-
-    return closest_point

-
-
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/github/html/_modules/jord/shapely_utilities/projection.html b/docs/github/html/_modules/jord/shapely_utilities/projection.html deleted file mode 100644 index 6fe8565..0000000 --- a/docs/github/html/_modules/jord/shapely_utilities/projection.html +++ /dev/null @@ -1,474 +0,0 @@ - - - - - - - - - jord.shapely_utilities.projection - jord 0.0.5 documentation - - - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
jord 0.0.5 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for jord.shapely_utilities.projection

-from typing import Sequence, Tuple
-
-from shapely import Polygon, Point, LineString
-from shapely.geometry.base import BaseGeometry
-
-from jord.shapely_utilities import pairs
-
-
-__all__ = ["project_point_to_object", "project_point_to_line", "nearest_geometry"]
-
-
-
[docs]def project_point_to_object(point: Point, geometry: BaseGeometry) -> Point:
-    """Find the nearest point in geometry, measured from given point.
-
-    :param point: a shapely Point
-    :param geometry: a shapely geometry object (LineString, Polygon)
-
-    :return: a shapely Point that lies on geometry closest to point
-    """
-    nearest_point = None
-    min_dist = float("inf")
-
-    if isinstance(geometry, Polygon):
-        for seg_start, seg_end in pairs(list(geometry.exterior.coords)):
-            line_start = Point(seg_start)
-            line_end = Point(seg_end)
-
-            intersection_point = project_point_to_line(point, line_start, line_end)
-            cur_dist = point.distance(intersection_point)
-
-            if cur_dist < min_dist:
-                min_dist = cur_dist
-                nearest_point = intersection_point
-
-    elif isinstance(geometry, LineString):
-        for seg_start, seg_end in pairs(list(geometry.coords)):
-            line_start = Point(seg_start)
-            line_end = Point(seg_end)
-
-            intersection_point = project_point_to_line(point, line_start, line_end)
-            cur_dist = point.distance(intersection_point)
-
-            if cur_dist < min_dist:
-                min_dist = cur_dist
-                nearest_point = intersection_point
-    else:
-        raise NotImplementedError(
-            "project_point_to_object not implemented for"
-            + " geometry type '"
-            + geometry.type
-            + "'."
-        )
-    return nearest_point

-
-
-
[docs]def project_point_to_line(point: Point, line_start: Point, line_end: Point) -> Point:
-    """Find the nearest point on a straight line, measured from given point.
-
-    Source: http://gis.stackexchange.com/a/438/19627
-
-    :param point: a shapely Point object
-    :param line_start: the line starting point as a shapely Point
-    :param line_end: the line end point as a shapely Point
-
-    :return: a shapely Point that lies on the straight line closest to point
-
-
-    """
-    line_magnitude = line_start.distance(line_end)
-
-    u = (
-        (point.x - line_start.x) * (line_end.x - line_start.x)
-        + (point.y - line_start.y) * (line_end.y - line_start.y)
-    ) / (line_magnitude**2)
-
-    # closest point does not fall within the line segment,
-    # take the shorter distance to an endpoint
-    if u < 0.00001 or u > 1:
-        ix = point.distance(line_start)
-        iy = point.distance(line_end)
-
-        if ix > iy:
-            return line_end
-
-        else:
-            return line_start
-
-    ix = line_start.x + u * (line_end.x - line_start.x)
-    iy = line_start.y + u * (line_end.y - line_start.y)
-    return Point([ix, iy])

-
-
-
[docs]def nearest_geometry(
-    geometries: Sequence[BaseGeometry], point: Point
-) -> Tuple[BaseGeometry, float, int]:
-    """Find the nearest geometry among a list, measured from fixed point.
-
-    :param geometries: a list of shapely geometry objects
-    :param point: a shapely Point
-
-    :return:        Tuple (geom, min_dist, min_index) of the geometry with minimum distance        to point, its distance min_dist and the list index of geom, so that        geom = geometries[min_index].
-    """
-    min_dist, min_index = min(
-        (point.distance(geom), k) for (k, geom) in enumerate(geometries)
-    )
-
-    return geometries[min_index], min_dist, min_index

-
-
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/github/html/_modules/jord/shapely_utilities/sanitise_poly.html b/docs/github/html/_modules/jord/shapely_utilities/sanitise_poly.html deleted file mode 100644 index 4d69bab..0000000 --- a/docs/github/html/_modules/jord/shapely_utilities/sanitise_poly.html +++ /dev/null @@ -1,464 +0,0 @@ - - - - - - - - - jord.shapely_utilities.sanitise_poly - jord 0.0.5 documentation - - - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
jord 0.0.5 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for jord.shapely_utilities.sanitise_poly

-from typing import Union
-
-from shapely.geometry.base import BaseGeometry
-
-__all__ = ["zero_buffer", "sanitise", "deflimmer"]
-
-from jord.shapely_utilities.morphology import opening, closing
-
-
-
[docs]def zero_buffer(
-    geom: BaseGeometry,
-) -> Union[
-    BaseGeometry
-    # Point,
-    # LineString,
-    # Polygon,
-    # MultiPolygon
-]:
-    return geom.buffer(0)

-
-
-
[docs]def deflimmer(geom: BaseGeometry, eps: float = 1e-7) -> BaseGeometry:
-    return opening(closing(geom, eps), eps)

-
-
-clean_geometry = unflimmer = deflimmer
-
-
-def std_dev_line_length():
-    ...  # get std_dev of line length in geometry
-
-
-def std_dev_area():
-    ...  # get std_dev of areas in geometry
-
-
-def filter_area():
-    ...
-
-
-
[docs]def sanitise(geom: BaseGeometry, *args: callable) -> BaseGeometry:
-    """
-
-    #A positive distance produces a dilation, a negative distance an erosion. A very small or zero distance may sometimes be used to “tidy” a polygon.
-
-
-
-    """
-
-    if not len(args):
-        args = (zero_buffer, deflimmer)
-
-    for f in args:
-        geom = f(geom)
-
-    return geom

-
-
-if __name__ == "__main__":
-
-    def aishdjauisd():
-        # Import constructors for creating geometry collections
-        from shapely.geometry import MultiPoint, MultiLineString
-
-        # Import necessary geometric objects from shapely module
-        from shapely.geometry import Point, LineString, Polygon
-
-        # Create Point geometric object(s) with coordinates
-        point1 = Point(2.2, 4.2)
-        point2 = Point(7.2, -25.1)
-        point3 = Point(9.26, -2.456)
-        # point3D = Point(9.26, -2.456, 0.57)
-
-        # Create a MultiPoint object of our points 1,2 and 3
-        multi_point = MultiPoint([point1, point2, point3])
-
-        # It is also possible to pass coordinate tuples inside
-        multi_point2 = MultiPoint([(2.2, 4.2), (7.2, -25.1), (9.26, -2.456)])
-
-        # We can also create a MultiLineString with two lines
-        line1 = LineString([point1, point2])
-        line2 = LineString([point2, point3])
-        multi_line = MultiLineString([line1, line2])
-        polygon = Polygon([point2, point1, point3])
-
-        from shapely.geometry import GeometryCollection
-        from matplotlib import pyplot
-        import geopandas as gpd
-
-        geoms = GeometryCollection([multi_point, multi_point2, multi_line, polygon])
-        geoms = sanitise(geoms)
-
-        p = gpd.GeoSeries(geoms)
-        p.plot()
-        pyplot.show()
-
-    aishdjauisd()
-
-
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/github/html/_modules/jord/shapely_utilities/serialisation/well_known_binary.html b/docs/github/html/_modules/jord/shapely_utilities/serialisation/well_known_binary.html deleted file mode 100644 index c5aacd7..0000000 --- a/docs/github/html/_modules/jord/shapely_utilities/serialisation/well_known_binary.html +++ /dev/null @@ -1,393 +0,0 @@ - - - - - - - - - jord.shapely_utilities.serialisation.well_known_binary - jord 0.0.5 documentation - - - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
jord 0.0.5 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for jord.shapely_utilities.serialisation.well_known_binary

-from pathlib import Path
-
-import pandas
-from shapely import wkb
-
-__all__ = ["load_wkbs_from_csv", "csv_wkt_generator"]
-
-
-
[docs]def load_wkbs_from_csv(csv_file_path: Path, geometry_column: str = "Shape") -> wkb:
-    """
-    Well-Known Text
-    """
-    return pandas.read_csv(str(csv_file_path))[geometry_column].apply(wkb.loads)

-
-
-
[docs]def csv_wkt_generator(csv_file_path: Path, geometry_column: str = "Shape") -> wkb:
-    """
-
-    :param csv_file_path:
-    :param geometry_column:
-    :return:
-    """
-    for idx, g in pandas.read_csv(
-        str(csv_file_path), usecols=[geometry_column]
-    ).iterrows():
-        yield wkb.loads(g)

-
-
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/github/html/_modules/jord/shapely_utilities/serialisation/well_known_text.html b/docs/github/html/_modules/jord/shapely_utilities/serialisation/well_known_text.html deleted file mode 100644 index b58fdaf..0000000 --- a/docs/github/html/_modules/jord/shapely_utilities/serialisation/well_known_text.html +++ /dev/null @@ -1,401 +0,0 @@ - - - - - - - - - jord.shapely_utilities.serialisation.well_known_text - jord 0.0.5 documentation - - - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
jord 0.0.5 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for jord.shapely_utilities.serialisation.well_known_text

-from pathlib import Path
-from typing import Sequence
-
-import pandas
-from pandas import DataFrame
-from shapely import wkt
-
-__all__ = ["load_wkts_from_csv", "csv_wkt_generator"]
-
-
-
[docs]def load_wkts_from_csv(
-    csv_file_path: Path, geometry_column: str = "Shape", additional_cols: Sequence = ()
-) -> DataFrame:
-    """
-    Well-Known Text
-    """
-    df = pandas.read_csv(
-        str(csv_file_path), usecols=[*additional_cols, geometry_column]
-    )
-    df[geometry_column] = df[geometry_column].apply(wkt.loads)
-    return df

-
-
-
[docs]def csv_wkt_generator(csv_file_path: Path, geometry_column: str = "Shape") -> wkt:
-    """
-
-    :param csv_file_path:
-    :param geometry_column:
-    :return:
-    """
-    for idx, g in pandas.read_csv(
-        str(csv_file_path), usecols=[geometry_column]
-    ).iterrows():
-        yield wkt.loads(g)

-
-
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.dist_is_editable.rst.txt b/docs/github/html/_sources/generated/jord.dist_is_editable.rst.txt deleted file mode 100644 index 6d2434a..0000000 --- a/docs/github/html/_sources/generated/jord.dist_is_editable.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.dist\_is\_editable -======================= - -.. currentmodule:: jord - -.. autofunction:: dist_is_editable \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.gdal_utilities.cloning.clone_data_to_memory.rst.txt b/docs/github/html/_sources/generated/jord.gdal_utilities.cloning.clone_data_to_memory.rst.txt deleted file mode 100644 index 61ec831..0000000 --- a/docs/github/html/_sources/generated/jord.gdal_utilities.cloning.clone_data_to_memory.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.gdal\_utilities.cloning.clone\_data\_to\_memory -==================================================== - -.. currentmodule:: jord.gdal_utilities.cloning - -.. autofunction:: clone_data_to_memory \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.gdal_utilities.cloning.clone_raster_to_memory.rst.txt b/docs/github/html/_sources/generated/jord.gdal_utilities.cloning.clone_raster_to_memory.rst.txt deleted file mode 100644 index 9a029ac..0000000 --- a/docs/github/html/_sources/generated/jord.gdal_utilities.cloning.clone_raster_to_memory.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.gdal\_utilities.cloning.clone\_raster\_to\_memory -====================================================== - -.. currentmodule:: jord.gdal_utilities.cloning - -.. autofunction:: clone_raster_to_memory \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.gdal_utilities.cloning.clone_vector_to_memory.rst.txt b/docs/github/html/_sources/generated/jord.gdal_utilities.cloning.clone_vector_to_memory.rst.txt deleted file mode 100644 index 3fb1d90..0000000 --- a/docs/github/html/_sources/generated/jord.gdal_utilities.cloning.clone_vector_to_memory.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.gdal\_utilities.cloning.clone\_vector\_to\_memory -====================================================== - -.. currentmodule:: jord.gdal_utilities.cloning - -.. autofunction:: clone_vector_to_memory \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.gdal_utilities.cloning.rst.txt b/docs/github/html/_sources/generated/jord.gdal_utilities.cloning.rst.txt deleted file mode 100644 index f0fc646..0000000 --- a/docs/github/html/_sources/generated/jord.gdal_utilities.cloning.rst.txt +++ /dev/null @@ -1,32 +0,0 @@ -jord.gdal\_utilities.cloning -============================ - -.. automodule:: jord.gdal_utilities.cloning - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - - clone_data_to_memory - clone_raster_to_memory - clone_vector_to_memory - - - - - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.gdal_utilities.context.SilenceGDALSession.rst.txt b/docs/github/html/_sources/generated/jord.gdal_utilities.context.SilenceGDALSession.rst.txt deleted file mode 100644 index fa887c1..0000000 --- a/docs/github/html/_sources/generated/jord.gdal_utilities.context.SilenceGDALSession.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -jord.gdal\_utilities.context.SilenceGDALSession -=============================================== - -.. currentmodule:: jord.gdal_utilities.context - -.. autoclass:: SilenceGDALSession - :members: - :show-inheritance: - :inherited-members: - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~SilenceGDALSession.__init__ - - - - - - \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.gdal_utilities.context.rst.txt b/docs/github/html/_sources/generated/jord.gdal_utilities.context.rst.txt deleted file mode 100644 index 925e47c..0000000 --- a/docs/github/html/_sources/generated/jord.gdal_utilities.context.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -jord.gdal\_utilities.context -============================ - -.. automodule:: jord.gdal_utilities.context - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom_autosummary/class.rst - - SilenceGDALSession - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.gdal_utilities.conversion.copy_gcps_to_file.rst.txt b/docs/github/html/_sources/generated/jord.gdal_utilities.conversion.copy_gcps_to_file.rst.txt deleted file mode 100644 index fcbef56..0000000 --- a/docs/github/html/_sources/generated/jord.gdal_utilities.conversion.copy_gcps_to_file.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.gdal\_utilities.conversion.copy\_gcps\_to\_file -==================================================== - -.. currentmodule:: jord.gdal_utilities.conversion - -.. autofunction:: copy_gcps_to_file \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.gdal_utilities.conversion.geotiff_to_tiff.rst.txt b/docs/github/html/_sources/generated/jord.gdal_utilities.conversion.geotiff_to_tiff.rst.txt deleted file mode 100644 index b633a58..0000000 --- a/docs/github/html/_sources/generated/jord.gdal_utilities.conversion.geotiff_to_tiff.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.gdal\_utilities.conversion.geotiff\_to\_tiff -================================================= - -.. currentmodule:: jord.gdal_utilities.conversion - -.. autofunction:: geotiff_to_tiff \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.gdal_utilities.conversion.get_georeference_from_file.rst.txt b/docs/github/html/_sources/generated/jord.gdal_utilities.conversion.get_georeference_from_file.rst.txt deleted file mode 100644 index 1a976e1..0000000 --- a/docs/github/html/_sources/generated/jord.gdal_utilities.conversion.get_georeference_from_file.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.gdal\_utilities.conversion.get\_georeference\_from\_file -============================================================= - -.. currentmodule:: jord.gdal_utilities.conversion - -.. autofunction:: get_georeference_from_file \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.gdal_utilities.conversion.rst.txt b/docs/github/html/_sources/generated/jord.gdal_utilities.conversion.rst.txt deleted file mode 100644 index c738017..0000000 --- a/docs/github/html/_sources/generated/jord.gdal_utilities.conversion.rst.txt +++ /dev/null @@ -1,34 +0,0 @@ -jord.gdal\_utilities.conversion -=============================== - -.. automodule:: jord.gdal_utilities.conversion - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - - get_georeference_from_file - set_georeference_to_file - geotiff_to_tiff - tiff_to_geotiff - copy_gcps_to_file - - - - - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.gdal_utilities.conversion.set_georeference_to_file.rst.txt b/docs/github/html/_sources/generated/jord.gdal_utilities.conversion.set_georeference_to_file.rst.txt deleted file mode 100644 index a2f0971..0000000 --- a/docs/github/html/_sources/generated/jord.gdal_utilities.conversion.set_georeference_to_file.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.gdal\_utilities.conversion.set\_georeference\_to\_file -=========================================================== - -.. currentmodule:: jord.gdal_utilities.conversion - -.. autofunction:: set_georeference_to_file \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.gdal_utilities.conversion.tiff_to_geotiff.rst.txt b/docs/github/html/_sources/generated/jord.gdal_utilities.conversion.tiff_to_geotiff.rst.txt deleted file mode 100644 index 010e2f0..0000000 --- a/docs/github/html/_sources/generated/jord.gdal_utilities.conversion.tiff_to_geotiff.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.gdal\_utilities.conversion.tiff\_to\_geotiff -================================================= - -.. currentmodule:: jord.gdal_utilities.conversion - -.. autofunction:: tiff_to_geotiff \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.gdal_utilities.dataset.rst.txt b/docs/github/html/_sources/generated/jord.gdal_utilities.dataset.rst.txt deleted file mode 100644 index 6adbf46..0000000 --- a/docs/github/html/_sources/generated/jord.gdal_utilities.dataset.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -jord.gdal\_utilities.dataset -============================ - -.. automodule:: jord.gdal_utilities.dataset - - - - - - - - - - - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.gdal_utilities.enums.rst.txt b/docs/github/html/_sources/generated/jord.gdal_utilities.enums.rst.txt deleted file mode 100644 index 652fbfe..0000000 --- a/docs/github/html/_sources/generated/jord.gdal_utilities.enums.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -jord.gdal\_utilities.enums -========================== - -.. automodule:: jord.gdal_utilities.enums - - - - - - - - - - - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.gdal_utilities.importing.import_gdal.rst.txt b/docs/github/html/_sources/generated/jord.gdal_utilities.importing.import_gdal.rst.txt deleted file mode 100644 index e905a0a..0000000 --- a/docs/github/html/_sources/generated/jord.gdal_utilities.importing.import_gdal.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.gdal\_utilities.importing.import\_gdal -=========================================== - -.. currentmodule:: jord.gdal_utilities.importing - -.. autofunction:: import_gdal \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.gdal_utilities.importing.import_ogr.rst.txt b/docs/github/html/_sources/generated/jord.gdal_utilities.importing.import_ogr.rst.txt deleted file mode 100644 index 8c3ed5c..0000000 --- a/docs/github/html/_sources/generated/jord.gdal_utilities.importing.import_ogr.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.gdal\_utilities.importing.import\_ogr -========================================== - -.. currentmodule:: jord.gdal_utilities.importing - -.. autofunction:: import_ogr \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.gdal_utilities.importing.import_osr.rst.txt b/docs/github/html/_sources/generated/jord.gdal_utilities.importing.import_osr.rst.txt deleted file mode 100644 index 39ea8a6..0000000 --- a/docs/github/html/_sources/generated/jord.gdal_utilities.importing.import_osr.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.gdal\_utilities.importing.import\_osr -========================================== - -.. currentmodule:: jord.gdal_utilities.importing - -.. autofunction:: import_osr \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.gdal_utilities.importing.rst.txt b/docs/github/html/_sources/generated/jord.gdal_utilities.importing.rst.txt deleted file mode 100644 index dcc94a8..0000000 --- a/docs/github/html/_sources/generated/jord.gdal_utilities.importing.rst.txt +++ /dev/null @@ -1,32 +0,0 @@ -jord.gdal\_utilities.importing -============================== - -.. automodule:: jord.gdal_utilities.importing - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - - import_gdal - import_osr - import_ogr - - - - - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.gdal_utilities.rst.txt b/docs/github/html/_sources/generated/jord.gdal_utilities.rst.txt deleted file mode 100644 index 08d9aeb..0000000 --- a/docs/github/html/_sources/generated/jord.gdal_utilities.rst.txt +++ /dev/null @@ -1,37 +0,0 @@ -jord.gdal\_utilities -==================== - -.. automodule:: jord.gdal_utilities - - - - - - - - - - - - - - - - - - - -.. rubric:: Modules - -.. autosummary:: - :toctree: - :template: custom_autosummary/module.rst - :recursive: - - jord.gdal_utilities.cloning - jord.gdal_utilities.context - jord.gdal_utilities.conversion - jord.gdal_utilities.dataset - jord.gdal_utilities.enums - jord.gdal_utilities.importing - diff --git a/docs/github/html/_sources/generated/jord.geojson_utilities.geometry_types.GeoJsonGeometryTypesEnum.rst.txt b/docs/github/html/_sources/generated/jord.geojson_utilities.geometry_types.GeoJsonGeometryTypesEnum.rst.txt deleted file mode 100644 index d9b487b..0000000 --- a/docs/github/html/_sources/generated/jord.geojson_utilities.geometry_types.GeoJsonGeometryTypesEnum.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -jord.geojson\_utilities.geometry\_types.GeoJsonGeometryTypesEnum -================================================================ - -.. currentmodule:: jord.geojson_utilities.geometry_types - -.. autoclass:: GeoJsonGeometryTypesEnum - :members: - :show-inheritance: - :inherited-members: - - - .. automethod:: __init__ - - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~GeoJsonGeometryTypesEnum.point - ~GeoJsonGeometryTypesEnum.line_string - ~GeoJsonGeometryTypesEnum.polygon - ~GeoJsonGeometryTypesEnum.multi_point - ~GeoJsonGeometryTypesEnum.multi_line_string - ~GeoJsonGeometryTypesEnum.multi_polygon - ~GeoJsonGeometryTypesEnum.geometry_collection - - \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.geojson_utilities.geometry_types.rst.txt b/docs/github/html/_sources/generated/jord.geojson_utilities.geometry_types.rst.txt deleted file mode 100644 index c39883e..0000000 --- a/docs/github/html/_sources/generated/jord.geojson_utilities.geometry_types.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -jord.geojson\_utilities.geometry\_types -======================================= - -.. automodule:: jord.geojson_utilities.geometry_types - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom_autosummary/class.rst - - GeoJsonGeometryTypesEnum - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.geojson_utilities.rst.txt b/docs/github/html/_sources/generated/jord.geojson_utilities.rst.txt deleted file mode 100644 index 2bab22b..0000000 --- a/docs/github/html/_sources/generated/jord.geojson_utilities.rst.txt +++ /dev/null @@ -1,32 +0,0 @@ -jord.geojson\_utilities -======================= - -.. automodule:: jord.geojson_utilities - - - - - - - - - - - - - - - - - - - -.. rubric:: Modules - -.. autosummary:: - :toctree: - :template: custom_autosummary/module.rst - :recursive: - - jord.geojson_utilities.geometry_types - diff --git a/docs/github/html/_sources/generated/jord.get_version.rst.txt b/docs/github/html/_sources/generated/jord.get_version.rst.txt deleted file mode 100644 index 1fc9a2b..0000000 --- a/docs/github/html/_sources/generated/jord.get_version.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.get\_version -================= - -.. currentmodule:: jord - -.. autofunction:: get_version \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.pillow_utilities.exif.rst.txt b/docs/github/html/_sources/generated/jord.pillow_utilities.exif.rst.txt deleted file mode 100644 index fc00484..0000000 --- a/docs/github/html/_sources/generated/jord.pillow_utilities.exif.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -jord.pillow\_utilities.exif -=========================== - -.. automodule:: jord.pillow_utilities.exif - - - - - - - - - - - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.pillow_utilities.rst.txt b/docs/github/html/_sources/generated/jord.pillow_utilities.rst.txt deleted file mode 100644 index 240f9a0..0000000 --- a/docs/github/html/_sources/generated/jord.pillow_utilities.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -jord.pillow\_utilities -====================== - -.. automodule:: jord.pillow_utilities - - - - - - - - - - - - - - - - - - - -.. rubric:: Modules - -.. autosummary:: - :toctree: - :template: custom_autosummary/module.rst - :recursive: - - jord.pillow_utilities.exif - jord.pillow_utilities.tiff - diff --git a/docs/github/html/_sources/generated/jord.pillow_utilities.tiff.rst.txt b/docs/github/html/_sources/generated/jord.pillow_utilities.tiff.rst.txt deleted file mode 100644 index 26ab706..0000000 --- a/docs/github/html/_sources/generated/jord.pillow_utilities.tiff.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -jord.pillow\_utilities.tiff -=========================== - -.. automodule:: jord.pillow_utilities.tiff - - - - - - - - - - - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.rasterio_utilities.rst.txt b/docs/github/html/_sources/generated/jord.rasterio_utilities.rst.txt deleted file mode 100644 index cdfc1b5..0000000 --- a/docs/github/html/_sources/generated/jord.rasterio_utilities.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -jord.rasterio\_utilities -======================== - -.. automodule:: jord.rasterio_utilities - - - - - - - - - - - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.rst.txt b/docs/github/html/_sources/generated/jord.rst.txt deleted file mode 100644 index 7c48434..0000000 --- a/docs/github/html/_sources/generated/jord.rst.txt +++ /dev/null @@ -1,45 +0,0 @@ -jord -==== - -.. automodule:: jord - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - - dist_is_editable - get_version - - - - - - - - - - - - - -.. rubric:: Modules - -.. autosummary:: - :toctree: - :template: custom_autosummary/module.rst - :recursive: - - jord.gdal_utilities - jord.geojson_utilities - jord.pillow_utilities - jord.qgis_utilities - jord.rasterio_utilities - jord.shapely_utilities - diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.degrees_of_freedom.has_3_sides_touching.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.degrees_of_freedom.has_3_sides_touching.rst.txt deleted file mode 100644 index 016d0e7..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.degrees_of_freedom.has_3_sides_touching.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.analysis.degrees\_of\_freedom.has\_3\_sides\_touching -============================================================================= - -.. currentmodule:: jord.shapely_utilities.analysis.degrees_of_freedom - -.. autofunction:: has_3_sides_touching \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.degrees_of_freedom.has_touches_across_centroid_buffer.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.degrees_of_freedom.has_touches_across_centroid_buffer.rst.txt deleted file mode 100644 index daa4771..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.degrees_of_freedom.has_touches_across_centroid_buffer.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.analysis.degrees\_of\_freedom.has\_touches\_across\_centroid\_buffer -============================================================================================ - -.. currentmodule:: jord.shapely_utilities.analysis.degrees_of_freedom - -.. autofunction:: has_touches_across_centroid_buffer \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.degrees_of_freedom.is_2d_translatable.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.degrees_of_freedom.is_2d_translatable.rst.txt deleted file mode 100644 index 0bd9559..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.degrees_of_freedom.is_2d_translatable.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.analysis.degrees\_of\_freedom.is\_2d\_translatable -========================================================================== - -.. currentmodule:: jord.shapely_utilities.analysis.degrees_of_freedom - -.. autofunction:: is_2d_translatable \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.degrees_of_freedom.is_simple_shape.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.degrees_of_freedom.is_simple_shape.rst.txt deleted file mode 100644 index 46c7464..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.degrees_of_freedom.is_simple_shape.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.analysis.degrees\_of\_freedom.is\_simple\_shape -======================================================================= - -.. currentmodule:: jord.shapely_utilities.analysis.degrees_of_freedom - -.. autofunction:: is_simple_shape \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.degrees_of_freedom.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.degrees_of_freedom.rst.txt deleted file mode 100644 index 554cd00..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.degrees_of_freedom.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -jord.shapely\_utilities.analysis.degrees\_of\_freedom -===================================================== - -.. automodule:: jord.shapely_utilities.analysis.degrees_of_freedom - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - - has_3_sides_touching - has_touches_across_centroid_buffer - is_2d_translatable - is_simple_shape - - - - - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.rst.txt deleted file mode 100644 index 5ead3a1..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -jord.shapely\_utilities.analysis -================================ - -.. automodule:: jord.shapely_utilities.analysis - - - - - - - - - - - - - - - - - - - -.. rubric:: Modules - -.. autosummary:: - :toctree: - :template: custom_autosummary/module.rst - :recursive: - - jord.shapely_utilities.analysis.degrees_of_freedom - jord.shapely_utilities.analysis.tracing - diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.tracing.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.tracing.rst.txt deleted file mode 100644 index a5f50b6..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.tracing.rst.txt +++ /dev/null @@ -1,30 +0,0 @@ -jord.shapely\_utilities.analysis.tracing -======================================== - -.. automodule:: jord.shapely_utilities.analysis.tracing - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - - trace_for_inner_ring - - - - - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.tracing.trace_for_inner_ring.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.tracing.trace_for_inner_ring.rst.txt deleted file mode 100644 index c8ceb06..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.analysis.tracing.trace_for_inner_ring.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.analysis.tracing.trace\_for\_inner\_ring -================================================================ - -.. currentmodule:: jord.shapely_utilities.analysis.tracing - -.. autofunction:: trace_for_inner_ring \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.adjust_line_end.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.adjust_line_end.rst.txt deleted file mode 100644 index 32158e1..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.adjust_line_end.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.clamp.adjust\_line\_end -=============================================== - -.. currentmodule:: jord.shapely_utilities.clamp - -.. autofunction:: adjust_line_end \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.ensure_list_of_geometries.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.ensure_list_of_geometries.rst.txt deleted file mode 100644 index 448d3f7..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.ensure_list_of_geometries.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.clamp.ensure\_list\_of\_geometries -========================================================== - -.. currentmodule:: jord.shapely_utilities.clamp - -.. autofunction:: ensure_list_of_geometries \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.extend_segment.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.extend_segment.rst.txt deleted file mode 100644 index d1c767f..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.extend_segment.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.clamp.extend\_segment -============================================= - -.. currentmodule:: jord.shapely_utilities.clamp - -.. autofunction:: extend_segment \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.fix_starting_point.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.fix_starting_point.rst.txt deleted file mode 100644 index efb3f78..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.fix_starting_point.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.clamp.fix\_starting\_point -================================================== - -.. currentmodule:: jord.shapely_utilities.clamp - -.. autofunction:: fix_starting_point \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.rst.txt deleted file mode 100644 index a9d6775..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.rst.txt +++ /dev/null @@ -1,35 +0,0 @@ -jord.shapely\_utilities.clamp -============================= - -.. automodule:: jord.shapely_utilities.clamp - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - - split_line_string - unsplit_line_string - extend_segment - fix_starting_point - adjust_line_end - ensure_list_of_geometries - - - - - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.split_line_string.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.split_line_string.rst.txt deleted file mode 100644 index 9a8c90b..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.split_line_string.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.clamp.split\_line\_string -================================================= - -.. currentmodule:: jord.shapely_utilities.clamp - -.. autofunction:: split_line_string \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.unsplit_line_string.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.unsplit_line_string.rst.txt deleted file mode 100644 index c05da4e..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.clamp.unsplit_line_string.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.clamp.unsplit\_line\_string -=================================================== - -.. currentmodule:: jord.shapely_utilities.clamp - -.. autofunction:: unsplit_line_string \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.geometry_types.ShapelyGeometryTypesEnum.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.geometry_types.ShapelyGeometryTypesEnum.rst.txt deleted file mode 100644 index be0780e..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.geometry_types.ShapelyGeometryTypesEnum.rst.txt +++ /dev/null @@ -1,32 +0,0 @@ -jord.shapely\_utilities.geometry\_types.ShapelyGeometryTypesEnum -================================================================ - -.. currentmodule:: jord.shapely_utilities.geometry_types - -.. autoclass:: ShapelyGeometryTypesEnum - :members: - :show-inheritance: - :inherited-members: - - - .. automethod:: __init__ - - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ShapelyGeometryTypesEnum.point - ~ShapelyGeometryTypesEnum.line_string - ~ShapelyGeometryTypesEnum.linear_ring - ~ShapelyGeometryTypesEnum.polygon - ~ShapelyGeometryTypesEnum.multi_point - ~ShapelyGeometryTypesEnum.multi_line_string - ~ShapelyGeometryTypesEnum.multi_polygon - ~ShapelyGeometryTypesEnum.geometry_collection - - \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.geometry_types.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.geometry_types.rst.txt deleted file mode 100644 index 000fa4e..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.geometry_types.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -jord.shapely\_utilities.geometry\_types -======================================= - -.. automodule:: jord.shapely_utilities.geometry_types - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom_autosummary/class.rst - - ShapelyGeometryTypesEnum - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.iteration.pairs.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.iteration.pairs.rst.txt deleted file mode 100644 index 6c9dbca..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.iteration.pairs.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.iteration.pairs -======================================= - -.. currentmodule:: jord.shapely_utilities.iteration - -.. autofunction:: pairs \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.iteration.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.iteration.rst.txt deleted file mode 100644 index 149e142..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.iteration.rst.txt +++ /dev/null @@ -1,30 +0,0 @@ -jord.shapely\_utilities.iteration -================================= - -.. automodule:: jord.shapely_utilities.iteration - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - - pairs - - - - - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.lines.explode_line.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.lines.explode_line.rst.txt deleted file mode 100644 index 3f263e9..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.lines.explode_line.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.lines.explode\_line -=========================================== - -.. currentmodule:: jord.shapely_utilities.lines - -.. autofunction:: explode_line \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.lines.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.lines.rst.txt deleted file mode 100644 index 4e9aa53..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.lines.rst.txt +++ /dev/null @@ -1,34 +0,0 @@ -jord.shapely\_utilities.lines -============================= - -.. automodule:: jord.shapely_utilities.lines - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - - to_lines - to_single_line - explode_line - strip_multiline_dangles - strip_line_dangles - - - - - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.lines.strip_line_dangles.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.lines.strip_line_dangles.rst.txt deleted file mode 100644 index aa6aa66..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.lines.strip_line_dangles.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.lines.strip\_line\_dangles -================================================== - -.. currentmodule:: jord.shapely_utilities.lines - -.. autofunction:: strip_line_dangles \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.lines.strip_multiline_dangles.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.lines.strip_multiline_dangles.rst.txt deleted file mode 100644 index 2858716..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.lines.strip_multiline_dangles.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.lines.strip\_multiline\_dangles -======================================================= - -.. currentmodule:: jord.shapely_utilities.lines - -.. autofunction:: strip_multiline_dangles \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.lines.to_lines.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.lines.to_lines.rst.txt deleted file mode 100644 index cb8ba24..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.lines.to_lines.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.lines.to\_lines -======================================= - -.. currentmodule:: jord.shapely_utilities.lines - -.. autofunction:: to_lines \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.lines.to_single_line.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.lines.to_single_line.rst.txt deleted file mode 100644 index d0d31b3..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.lines.to_single_line.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.lines.to\_single\_line -============================================== - -.. currentmodule:: jord.shapely_utilities.lines - -.. autofunction:: to_single_line \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.close.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.close.rst.txt deleted file mode 100644 index c83c031..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.close.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.morphology.close -======================================== - -.. currentmodule:: jord.shapely_utilities.morphology - -.. autofunction:: close \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.closing.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.closing.rst.txt deleted file mode 100644 index 2c9f81e..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.closing.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.morphology.closing -========================================== - -.. currentmodule:: jord.shapely_utilities.morphology - -.. autofunction:: closing \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.dilate.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.dilate.rst.txt deleted file mode 100644 index b600c6a..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.dilate.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.morphology.dilate -========================================= - -.. currentmodule:: jord.shapely_utilities.morphology - -.. autofunction:: dilate \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.dilation.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.dilation.rst.txt deleted file mode 100644 index 0622247..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.dilation.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.morphology.dilation -=========================================== - -.. currentmodule:: jord.shapely_utilities.morphology - -.. autofunction:: dilation \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.erode.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.erode.rst.txt deleted file mode 100644 index 4c9ec8c..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.erode.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.morphology.erode -======================================== - -.. currentmodule:: jord.shapely_utilities.morphology - -.. autofunction:: erode \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.erosion.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.erosion.rst.txt deleted file mode 100644 index 4a169e4..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.erosion.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.morphology.erosion -========================================== - -.. currentmodule:: jord.shapely_utilities.morphology - -.. autofunction:: erosion \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.opening.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.opening.rst.txt deleted file mode 100644 index 4d5dc1a..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.opening.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.morphology.opening -========================================== - -.. currentmodule:: jord.shapely_utilities.morphology - -.. autofunction:: opening \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.rst.txt deleted file mode 100644 index 53eef44..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.morphology.rst.txt +++ /dev/null @@ -1,36 +0,0 @@ -jord.shapely\_utilities.morphology -================================== - -.. automodule:: jord.shapely_utilities.morphology - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - - closing - opening - erode - erosion - dilate - dilation - close - - - - - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.points.nearest_neighbor_within.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.points.nearest_neighbor_within.rst.txt deleted file mode 100644 index 09821ca..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.points.nearest_neighbor_within.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.points.nearest\_neighbor\_within -======================================================== - -.. currentmodule:: jord.shapely_utilities.points - -.. autofunction:: nearest_neighbor_within \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.points.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.points.rst.txt deleted file mode 100644 index 15e06cf..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.points.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -jord.shapely\_utilities.points -============================== - -.. automodule:: jord.shapely_utilities.points - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - - unique_line_points - nearest_neighbor_within - - - - - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.points.unique_line_points.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.points.unique_line_points.rst.txt deleted file mode 100644 index 79e839b..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.points.unique_line_points.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.points.unique\_line\_points -=================================================== - -.. currentmodule:: jord.shapely_utilities.points - -.. autofunction:: unique_line_points \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.projection.nearest_geometry.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.projection.nearest_geometry.rst.txt deleted file mode 100644 index d1f169d..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.projection.nearest_geometry.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.projection.nearest\_geometry -==================================================== - -.. currentmodule:: jord.shapely_utilities.projection - -.. autofunction:: nearest_geometry \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.projection.project_point_to_line.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.projection.project_point_to_line.rst.txt deleted file mode 100644 index af8f122..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.projection.project_point_to_line.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.projection.project\_point\_to\_line -=========================================================== - -.. currentmodule:: jord.shapely_utilities.projection - -.. autofunction:: project_point_to_line \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.projection.project_point_to_object.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.projection.project_point_to_object.rst.txt deleted file mode 100644 index 08eede3..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.projection.project_point_to_object.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.projection.project\_point\_to\_object -============================================================= - -.. currentmodule:: jord.shapely_utilities.projection - -.. autofunction:: project_point_to_object \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.projection.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.projection.rst.txt deleted file mode 100644 index db8c5fa..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.projection.rst.txt +++ /dev/null @@ -1,32 +0,0 @@ -jord.shapely\_utilities.projection -================================== - -.. automodule:: jord.shapely_utilities.projection - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - - project_point_to_object - project_point_to_line - nearest_geometry - - - - - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.rst.txt deleted file mode 100644 index 92ab645..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.rst.txt +++ /dev/null @@ -1,42 +0,0 @@ -jord.shapely\_utilities -======================= - -.. automodule:: jord.shapely_utilities - - - - - - - - - - - - - - - - - - - -.. rubric:: Modules - -.. autosummary:: - :toctree: - :template: custom_autosummary/module.rst - :recursive: - - jord.shapely_utilities.analysis - jord.shapely_utilities.clamp - jord.shapely_utilities.exclude - jord.shapely_utilities.geometry_types - jord.shapely_utilities.iteration - jord.shapely_utilities.lines - jord.shapely_utilities.morphology - jord.shapely_utilities.points - jord.shapely_utilities.projection - jord.shapely_utilities.sanitise_poly - jord.shapely_utilities.serialisation - diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.sanitise_poly.deflimmer.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.sanitise_poly.deflimmer.rst.txt deleted file mode 100644 index 91821d2..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.sanitise_poly.deflimmer.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.sanitise\_poly.deflimmer -================================================ - -.. currentmodule:: jord.shapely_utilities.sanitise_poly - -.. autofunction:: deflimmer \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.sanitise_poly.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.sanitise_poly.rst.txt deleted file mode 100644 index 1c0211f..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.sanitise_poly.rst.txt +++ /dev/null @@ -1,32 +0,0 @@ -jord.shapely\_utilities.sanitise\_poly -====================================== - -.. automodule:: jord.shapely_utilities.sanitise_poly - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - - zero_buffer - sanitise - deflimmer - - - - - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.sanitise_poly.sanitise.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.sanitise_poly.sanitise.rst.txt deleted file mode 100644 index 1061101..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.sanitise_poly.sanitise.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.sanitise\_poly.sanitise -=============================================== - -.. currentmodule:: jord.shapely_utilities.sanitise_poly - -.. autofunction:: sanitise \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.sanitise_poly.zero_buffer.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.sanitise_poly.zero_buffer.rst.txt deleted file mode 100644 index 586d693..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.sanitise_poly.zero_buffer.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.sanitise\_poly.zero\_buffer -=================================================== - -.. currentmodule:: jord.shapely_utilities.sanitise_poly - -.. autofunction:: zero_buffer \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.rst.txt deleted file mode 100644 index f6132cc..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -jord.shapely\_utilities.serialisation -===================================== - -.. automodule:: jord.shapely_utilities.serialisation - - - - - - - - - - - - - - - - - - - -.. rubric:: Modules - -.. autosummary:: - :toctree: - :template: custom_autosummary/module.rst - :recursive: - - jord.shapely_utilities.serialisation.well_known_binary - jord.shapely_utilities.serialisation.well_known_text - diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.well_known_binary.csv_wkt_generator.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.well_known_binary.csv_wkt_generator.rst.txt deleted file mode 100644 index 7de014e..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.well_known_binary.csv_wkt_generator.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.serialisation.well\_known\_binary.csv\_wkt\_generator -============================================================================= - -.. currentmodule:: jord.shapely_utilities.serialisation.well_known_binary - -.. autofunction:: csv_wkt_generator \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.well_known_binary.load_wkbs_from_csv.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.well_known_binary.load_wkbs_from_csv.rst.txt deleted file mode 100644 index f905788..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.well_known_binary.load_wkbs_from_csv.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.serialisation.well\_known\_binary.load\_wkbs\_from\_csv -=============================================================================== - -.. currentmodule:: jord.shapely_utilities.serialisation.well_known_binary - -.. autofunction:: load_wkbs_from_csv \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.well_known_binary.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.well_known_binary.rst.txt deleted file mode 100644 index 3076106..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.well_known_binary.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -jord.shapely\_utilities.serialisation.well\_known\_binary -========================================================= - -.. automodule:: jord.shapely_utilities.serialisation.well_known_binary - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - - load_wkbs_from_csv - csv_wkt_generator - - - - - - - - - - - - - diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.well_known_text.csv_wkt_generator.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.well_known_text.csv_wkt_generator.rst.txt deleted file mode 100644 index 4614448..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.well_known_text.csv_wkt_generator.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.serialisation.well\_known\_text.csv\_wkt\_generator -=========================================================================== - -.. currentmodule:: jord.shapely_utilities.serialisation.well_known_text - -.. autofunction:: csv_wkt_generator \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.well_known_text.load_wkts_from_csv.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.well_known_text.load_wkts_from_csv.rst.txt deleted file mode 100644 index 33330f7..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.well_known_text.load_wkts_from_csv.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -jord.shapely\_utilities.serialisation.well\_known\_text.load\_wkts\_from\_csv -============================================================================= - -.. currentmodule:: jord.shapely_utilities.serialisation.well_known_text - -.. autofunction:: load_wkts_from_csv \ No newline at end of file diff --git a/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.well_known_text.rst.txt b/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.well_known_text.rst.txt deleted file mode 100644 index 0e4c6df..0000000 --- a/docs/github/html/_sources/generated/jord.shapely_utilities.serialisation.well_known_text.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -jord.shapely\_utilities.serialisation.well\_known\_text -======================================================= - -.. automodule:: jord.shapely_utilities.serialisation.well_known_text - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - - load_wkts_from_csv - csv_wkt_generator - - - - - - - - - - - - - diff --git a/docs/github/html/_sources/getting_started.rst.txt b/docs/github/html/_sources/getting_started.rst.txt deleted file mode 100644 index c71efb6..0000000 --- a/docs/github/html/_sources/getting_started.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -.. _getting_started: - -Getting Started -=============== - -pip install |PROJECT_NAME| -U \ No newline at end of file diff --git a/docs/github/html/_sources/index.rst.txt b/docs/github/html/_sources/index.rst.txt deleted file mode 100644 index 4d11802..0000000 --- a/docs/github/html/_sources/index.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -|organisation| |project| Documentation -====================================== - -Version: |version| |today| - -.. autosummary:: - :toctree: generated - :template: custom_autosummary/module.rst - :recursive: - - jord - -.. toctree:: - :glob: - :hidden: - :maxdepth: 1 - :caption: Notes - - getting_started - -What's next? -------------- - -Read the :ref:`Getting Started Guide ` - - -Indices and tables -================== -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/github/html/_static/basic.css b/docs/github/html/_static/basic.css deleted file mode 100644 index 7577acb..0000000 --- a/docs/github/html/_static/basic.css +++ /dev/null @@ -1,903 +0,0 @@ -/* - * basic.css - * ~~~~~~~~~ - * - * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/* -- main layout ----------------------------------------------------------- */ - -div.clearer { - clear: both; -} - -div.section::after { - display: block; - content: ''; - clear: left; -} - -/* -- relbar ---------------------------------------------------------------- */ - -div.related { - width: 100%; - font-size: 90%; -} - -div.related h3 { - display: none; -} - -div.related ul { - margin: 0; - padding: 0 0 0 10px; - list-style: none; -} - -div.related li { - display: inline; -} - -div.related li.right { - float: right; - margin-right: 5px; -} - -/* -- sidebar --------------------------------------------------------------- */ - -div.sphinxsidebarwrapper { - padding: 10px 5px 0 10px; -} - -div.sphinxsidebar { - float: left; - width: 230px; - margin-left: -100%; - font-size: 90%; - word-wrap: break-word; - overflow-wrap : break-word; -} - -div.sphinxsidebar ul { - list-style: none; -} - -div.sphinxsidebar ul ul, -div.sphinxsidebar ul.want-points { - margin-left: 20px; - list-style: square; -} - -div.sphinxsidebar ul ul { - margin-top: 0; - margin-bottom: 0; -} - -div.sphinxsidebar form { - margin-top: 10px; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - -div.sphinxsidebar #searchbox form.search { - overflow: hidden; -} - -div.sphinxsidebar #searchbox input[type="text"] { - float: left; - width: 80%; - padding: 0.25em; - box-sizing: border-box; -} - -div.sphinxsidebar #searchbox input[type="submit"] { - float: left; - width: 20%; - border-left: none; - padding: 0.25em; - box-sizing: border-box; -} - - -img { - border: 0; - max-width: 100%; -} - -/* -- search page ----------------------------------------------------------- */ - -ul.search { - margin: 10px 0 0 20px; - padding: 0; -} - -ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; -} - -ul.search li a { - font-weight: bold; -} - -ul.search li p.context { - color: #888; - margin: 2px 0 0 30px; - text-align: left; -} - -ul.keywordmatches li.goodmatch a { - font-weight: bold; -} - -/* -- index page ------------------------------------------------------------ */ - -table.contentstable { - width: 90%; - margin-left: auto; - margin-right: auto; -} - -table.contentstable p.biglink { - line-height: 150%; -} - -a.biglink { - font-size: 1.3em; -} - -span.linkdescr { - font-style: italic; - padding-top: 5px; - font-size: 90%; -} - -/* -- general index --------------------------------------------------------- */ - -table.indextable { - width: 100%; -} - -table.indextable td { - text-align: left; - vertical-align: top; -} - -table.indextable ul { - margin-top: 0; - margin-bottom: 0; - list-style-type: none; -} - -table.indextable > tbody > tr > td > ul { - padding-left: 0em; -} - -table.indextable tr.pcap { - height: 10px; -} - -table.indextable tr.cap { - margin-top: 10px; - background-color: #f2f2f2; -} - -img.toggler { - margin-right: 3px; - margin-top: 3px; - cursor: pointer; -} - -div.modindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -div.genindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -/* -- domain module index --------------------------------------------------- */ - -table.modindextable td { - padding: 2px; - border-collapse: collapse; -} - -/* -- general body styles --------------------------------------------------- */ - -div.body { - min-width: 360px; - max-width: 800px; -} - -div.body p, div.body dd, div.body li, div.body blockquote { - -moz-hyphens: auto; - -ms-hyphens: auto; - -webkit-hyphens: auto; - hyphens: auto; -} - -a.headerlink { - visibility: hidden; -} - -h1:hover > a.headerlink, -h2:hover > a.headerlink, -h3:hover > a.headerlink, -h4:hover > a.headerlink, -h5:hover > a.headerlink, -h6:hover > a.headerlink, -dt:hover > a.headerlink, -caption:hover > a.headerlink, -p.caption:hover > a.headerlink, -div.code-block-caption:hover > a.headerlink { - visibility: visible; -} - -div.body p.caption { - text-align: inherit; -} - -div.body td { - text-align: left; -} - -.first { - margin-top: 0 !important; -} - -p.rubric { - margin-top: 30px; - font-weight: bold; -} - -img.align-left, figure.align-left, .figure.align-left, object.align-left { - clear: left; - float: left; - margin-right: 1em; -} - -img.align-right, figure.align-right, .figure.align-right, object.align-right { - clear: right; - float: right; - margin-left: 1em; -} - -img.align-center, figure.align-center, .figure.align-center, object.align-center { - display: block; - margin-left: auto; - margin-right: auto; -} - -img.align-default, figure.align-default, .figure.align-default { - display: block; - margin-left: auto; - margin-right: auto; -} - -.align-left { - text-align: left; -} - -.align-center { - text-align: center; -} - -.align-default { - text-align: center; -} - -.align-right { - text-align: right; -} - -/* -- sidebars -------------------------------------------------------------- */ - -div.sidebar, -aside.sidebar { - margin: 0 0 0.5em 1em; - border: 1px solid #ddb; - padding: 7px; - background-color: #ffe; - width: 40%; - float: right; - clear: right; - overflow-x: auto; -} - -p.sidebar-title { - font-weight: bold; -} - -nav.contents, -aside.topic, -div.admonition, div.topic, blockquote { - clear: left; -} - -/* -- topics ---------------------------------------------------------------- */ - -nav.contents, -aside.topic, -div.topic { - border: 1px solid #ccc; - padding: 7px; - margin: 10px 0 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* -- admonitions ----------------------------------------------------------- */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -div.admonition dt { - font-weight: bold; -} - -p.admonition-title { - margin: 0px 10px 5px 0px; - font-weight: bold; -} - -div.body p.centered { - text-align: center; - margin-top: 25px; -} - -/* -- content of sidebars/topics/admonitions -------------------------------- */ - -div.sidebar > :last-child, -aside.sidebar > :last-child, -nav.contents > :last-child, -aside.topic > :last-child, -div.topic > :last-child, -div.admonition > :last-child { - margin-bottom: 0; -} - -div.sidebar::after, -aside.sidebar::after, -nav.contents::after, -aside.topic::after, -div.topic::after, -div.admonition::after, -blockquote::after { - display: block; - content: ''; - clear: both; -} - -/* -- tables ---------------------------------------------------------------- */ - -table.docutils { - margin-top: 10px; - margin-bottom: 10px; - border: 0; - border-collapse: collapse; -} - -table.align-center { - margin-left: auto; - margin-right: auto; -} - -table.align-default { - margin-left: auto; - margin-right: auto; -} - -table caption span.caption-number { - font-style: italic; -} - -table caption span.caption-text { -} - -table.docutils td, table.docutils th { - padding: 1px 8px 1px 5px; - border-top: 0; - border-left: 0; - border-right: 0; - border-bottom: 1px solid #aaa; -} - -th { - text-align: left; - padding-right: 5px; -} - -table.citation { - border-left: solid 1px gray; - margin-left: 1px; -} - -table.citation td { - border-bottom: none; -} - -th > :first-child, -td > :first-child { - margin-top: 0px; -} - -th > :last-child, -td > :last-child { - margin-bottom: 0px; -} - -/* -- figures --------------------------------------------------------------- */ - -div.figure, figure { - margin: 0.5em; - padding: 0.5em; -} - -div.figure p.caption, figcaption { - padding: 0.3em; -} - -div.figure p.caption span.caption-number, -figcaption span.caption-number { - font-style: italic; -} - -div.figure p.caption span.caption-text, -figcaption span.caption-text { -} - -/* -- field list styles ----------------------------------------------------- */ - -table.field-list td, table.field-list th { - border: 0 !important; -} - -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - -.field-name { - -moz-hyphens: manual; - -ms-hyphens: manual; - -webkit-hyphens: manual; - hyphens: manual; -} - -/* -- hlist styles ---------------------------------------------------------- */ - -table.hlist { - margin: 1em 0; -} - -table.hlist td { - vertical-align: top; -} - -/* -- object description styles --------------------------------------------- */ - -.sig { - font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; -} - -.sig-name, code.descname { - background-color: transparent; - font-weight: bold; -} - -.sig-name { - font-size: 1.1em; -} - -code.descname { - font-size: 1.2em; -} - -.sig-prename, code.descclassname { - background-color: transparent; -} - -.optional { - font-size: 1.3em; -} - -.sig-paren { - font-size: larger; -} - -.sig-param.n { - font-style: italic; -} - -/* C++ specific styling */ - -.sig-inline.c-texpr, -.sig-inline.cpp-texpr { - font-family: unset; -} - -.sig.c .k, .sig.c .kt, -.sig.cpp .k, .sig.cpp .kt { - color: #0033B3; -} - -.sig.c .m, -.sig.cpp .m { - color: #1750EB; -} - -.sig.c .s, .sig.c .sc, -.sig.cpp .s, .sig.cpp .sc { - color: #067D17; -} - - -/* -- other body styles ----------------------------------------------------- */ - -ol.arabic { - list-style: decimal; -} - -ol.loweralpha { - list-style: lower-alpha; -} - -ol.upperalpha { - list-style: upper-alpha; -} - -ol.lowerroman { - list-style: lower-roman; -} - -ol.upperroman { - list-style: upper-roman; -} - -:not(li) > ol > li:first-child > :first-child, -:not(li) > ul > li:first-child > :first-child { - margin-top: 0px; -} - -:not(li) > ol > li:last-child > :last-child, -:not(li) > ul > li:last-child > :last-child { - margin-bottom: 0px; -} - -ol.simple ol p, -ol.simple ul p, -ul.simple ol p, -ul.simple ul p { - margin-top: 0; -} - -ol.simple > li:not(:first-child) > p, -ul.simple > li:not(:first-child) > p { - margin-top: 0; -} - -ol.simple p, -ul.simple p { - margin-bottom: 0; -} - -aside.footnote > span, -div.citation > span { - float: left; -} -aside.footnote > span:last-of-type, -div.citation > span:last-of-type { - padding-right: 0.5em; -} -aside.footnote > p { - margin-left: 2em; -} -div.citation > p { - margin-left: 4em; -} -aside.footnote > p:last-of-type, -div.citation > p:last-of-type { - margin-bottom: 0em; -} -aside.footnote > p:last-of-type:after, -div.citation > p:last-of-type:after { - content: ""; - clear: both; -} - -dl.field-list { - display: grid; - grid-template-columns: fit-content(30%) auto; -} - -dl.field-list > dt { - font-weight: bold; - word-break: break-word; - padding-left: 0.5em; - padding-right: 5px; -} - -dl.field-list > dd { - padding-left: 0.5em; - margin-top: 0em; - margin-left: 0em; - margin-bottom: 0em; -} - -dl { - margin-bottom: 15px; -} - -dd > :first-child { - margin-top: 0px; -} - -dd ul, dd table { - margin-bottom: 10px; -} - -dd { - margin-top: 3px; - margin-bottom: 10px; - margin-left: 30px; -} - -dl > dd:last-child, -dl > dd:last-child > :last-child { - margin-bottom: 0; -} - -dt:target, span.highlighted { - background-color: #fbe54e; -} - -rect.highlighted { - fill: #fbe54e; -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -.versionmodified { - font-style: italic; -} - -.system-message { - background-color: #fda; - padding: 5px; - border: 3px solid red; -} - -.footnote:target { - background-color: #ffa; -} - -.line-block { - display: block; - margin-top: 1em; - margin-bottom: 1em; -} - -.line-block .line-block { - margin-top: 0; - margin-bottom: 0; - margin-left: 1.5em; -} - -.guilabel, .menuselection { - font-family: sans-serif; -} - -.accelerator { - text-decoration: underline; -} - -.classifier { - font-style: oblique; -} - -.classifier:before { - font-style: normal; - margin: 0 0.5em; - content: ":"; - display: inline-block; -} - -abbr, acronym { - border-bottom: dotted 1px; - cursor: help; -} - -/* -- code displays --------------------------------------------------------- */ - -pre { - overflow: auto; - overflow-y: hidden; /* fixes display issues on Chrome browsers */ -} - -pre, div[class*="highlight-"] { - clear: both; -} - -span.pre { - -moz-hyphens: none; - -ms-hyphens: none; - -webkit-hyphens: none; - hyphens: none; - white-space: nowrap; -} - -div[class*="highlight-"] { - margin: 1em 0; -} - -td.linenos pre { - border: 0; - background-color: transparent; - color: #aaa; -} - -table.highlighttable { - display: block; -} - -table.highlighttable tbody { - display: block; -} - -table.highlighttable tr { - display: flex; -} - -table.highlighttable td { - margin: 0; - padding: 0; -} - -table.highlighttable td.linenos { - padding-right: 0.5em; -} - -table.highlighttable td.code { - flex: 1; - overflow: hidden; -} - -.highlight .hll { - display: block; -} - -div.highlight pre, -table.highlighttable pre { - margin: 0; -} - -div.code-block-caption + div { - margin-top: 0; -} - -div.code-block-caption { - margin-top: 1em; - padding: 2px 5px; - font-size: small; -} - -div.code-block-caption code { - background-color: transparent; -} - -table.highlighttable td.linenos, -span.linenos, -div.highlight span.gp { /* gp: Generic.Prompt */ - user-select: none; - -webkit-user-select: text; /* Safari fallback only */ - -webkit-user-select: none; /* Chrome/Safari */ - -moz-user-select: none; /* Firefox */ - -ms-user-select: none; /* IE10+ */ -} - -div.code-block-caption span.caption-number { - padding: 0.1em 0.3em; - font-style: italic; -} - -div.code-block-caption span.caption-text { -} - -div.literal-block-wrapper { - margin: 1em 0; -} - -code.xref, a code { - background-color: transparent; - font-weight: bold; -} - -h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { - background-color: transparent; -} - -.viewcode-link { - float: right; -} - -.viewcode-back { - float: right; - font-family: sans-serif; -} - -div.viewcode-block:target { - margin: -1px -10px; - padding: 0 10px; -} - -/* -- math display ---------------------------------------------------------- */ - -img.math { - vertical-align: middle; -} - -div.body div.math p { - text-align: center; -} - -span.eqno { - float: right; -} - -span.eqno a.headerlink { - position: absolute; - z-index: 1; -} - -div.math:hover a.headerlink { - visibility: visible; -} - -/* -- printout stylesheet --------------------------------------------------- */ - -@media print { - div.document, - div.documentwrapper, - div.bodywrapper { - margin: 0 !important; - width: 100%; - } - - div.sphinxsidebar, - div.related, - div.footer, - #top-link { - display: none; - } -} \ No newline at end of file diff --git a/docs/github/html/_static/custom.css b/docs/github/html/_static/custom.css deleted file mode 100644 index fbbeeaa..0000000 --- a/docs/github/html/_static/custom.css +++ /dev/null @@ -1,3 +0,0 @@ -div.main > div.content > div.article-container > article[role=main] > section > h1 { - overflow-wrap: anywhere; -} \ No newline at end of file diff --git a/docs/github/html/_static/debug.css b/docs/github/html/_static/debug.css deleted file mode 100644 index 74d4aec..0000000 --- a/docs/github/html/_static/debug.css +++ /dev/null @@ -1,69 +0,0 @@ -/* - This CSS file should be overridden by the theme authors. It's - meant for debugging and developing the skeleton that this theme provides. -*/ -body { - font-family: -apple-system, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, - "Apple Color Emoji", "Segoe UI Emoji"; - background: lavender; -} -.sb-announcement { - background: rgb(131, 131, 131); -} -.sb-announcement__inner { - background: black; - color: white; -} -.sb-header { - background: lightskyblue; -} -.sb-header__inner { - background: royalblue; - color: white; -} -.sb-header-secondary { - background: lightcyan; -} -.sb-header-secondary__inner { - background: cornflowerblue; - color: white; -} -.sb-sidebar-primary { - background: lightgreen; -} -.sb-main { - background: blanchedalmond; -} -.sb-main__inner { - background: antiquewhite; -} -.sb-header-article { - background: lightsteelblue; -} -.sb-article-container { - background: snow; -} -.sb-article-main { - background: white; -} -.sb-footer-article { - background: lightpink; -} -.sb-sidebar-secondary { - background: lightgoldenrodyellow; -} -.sb-footer-content { - background: plum; -} -.sb-footer-content__inner { - background: palevioletred; -} -.sb-footer { - background: pink; -} -.sb-footer__inner { - background: salmon; -} -.sb-article { - background: white; -} diff --git a/docs/github/html/_static/doctools.js b/docs/github/html/_static/doctools.js deleted file mode 100644 index d06a71d..0000000 --- a/docs/github/html/_static/doctools.js +++ /dev/null @@ -1,156 +0,0 @@ -/* - * doctools.js - * ~~~~~~~~~~~ - * - * Base JavaScript utilities for all Sphinx HTML documentation. - * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ -"use strict"; - -const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ - "TEXTAREA", - "INPUT", - "SELECT", - "BUTTON", -]); - -const _ready = (callback) => { - if (document.readyState !== "loading") { - callback(); - } else { - document.addEventListener("DOMContentLoaded", callback); - } -}; - -/** - * Small JavaScript module for the documentation. - */ -const Documentation = { - init: () => { - Documentation.initDomainIndexTable(); - Documentation.initOnKeyListeners(); - }, - - /** - * i18n support - */ - TRANSLATIONS: {}, - PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), - LOCALE: "unknown", - - // gettext and ngettext don't access this so that the functions - // can safely bound to a different name (_ = Documentation.gettext) - gettext: (string) => { - const translated = Documentation.TRANSLATIONS[string]; - switch (typeof translated) { - case "undefined": - return string; // no translation - case "string": - return translated; // translation exists - default: - return translated[0]; // (singular, plural) translation tuple exists - } - }, - - ngettext: (singular, plural, n) => { - const translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated !== "undefined") - return translated[Documentation.PLURAL_EXPR(n)]; - return n === 1 ? singular : plural; - }, - - addTranslations: (catalog) => { - Object.assign(Documentation.TRANSLATIONS, catalog.messages); - Documentation.PLURAL_EXPR = new Function( - "n", - `return (${catalog.plural_expr})` - ); - Documentation.LOCALE = catalog.locale; - }, - - /** - * helper function to focus on search bar - */ - focusSearchBar: () => { - document.querySelectorAll("input[name=q]")[0]?.focus(); - }, - - /** - * Initialise the domain index toggle buttons - */ - initDomainIndexTable: () => { - const toggler = (el) => { - const idNumber = el.id.substr(7); - const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); - if (el.src.substr(-9) === "minus.png") { - el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; - toggledRows.forEach((el) => (el.style.display = "none")); - } else { - el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; - toggledRows.forEach((el) => (el.style.display = "")); - } - }; - - const togglerElements = document.querySelectorAll("img.toggler"); - togglerElements.forEach((el) => - el.addEventListener("click", (event) => toggler(event.currentTarget)) - ); - togglerElements.forEach((el) => (el.style.display = "")); - if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); - }, - - initOnKeyListeners: () => { - // only install a listener if it is really needed - if ( - !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && - !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS - ) - return; - - document.addEventListener("keydown", (event) => { - // bail for input elements - if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; - // bail with special keys - if (event.altKey || event.ctrlKey || event.metaKey) return; - - if (!event.shiftKey) { - switch (event.key) { - case "ArrowLeft": - if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; - - const prevLink = document.querySelector('link[rel="prev"]'); - if (prevLink && prevLink.href) { - window.location.href = prevLink.href; - event.preventDefault(); - } - break; - case "ArrowRight": - if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; - - const nextLink = document.querySelector('link[rel="next"]'); - if (nextLink && nextLink.href) { - window.location.href = nextLink.href; - event.preventDefault(); - } - break; - } - } - - // some keyboard layouts may need Shift to get / - switch (event.key) { - case "/": - if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; - Documentation.focusSearchBar(); - event.preventDefault(); - } - }); - }, -}; - -// quick alias for translations -const _ = Documentation.gettext; - -_ready(Documentation.init); diff --git a/docs/github/html/_static/documentation_options.js b/docs/github/html/_static/documentation_options.js deleted file mode 100644 index 481f14b..0000000 --- a/docs/github/html/_static/documentation_options.js +++ /dev/null @@ -1,14 +0,0 @@ -var DOCUMENTATION_OPTIONS = { - URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '0.0.5', - LANGUAGE: 'en', - COLLAPSE_INDEX: false, - BUILDER: 'html', - FILE_SUFFIX: '.html', - LINK_SUFFIX: '.html', - HAS_SOURCE: true, - SOURCELINK_SUFFIX: '.txt', - NAVIGATION_WITH_KEYS: false, - SHOW_SEARCH_SUMMARY: true, - ENABLE_SEARCH_SHORTCUTS: true, -}; \ No newline at end of file diff --git a/docs/github/html/_static/graphviz.css b/docs/github/html/_static/graphviz.css deleted file mode 100644 index 8d81c02..0000000 --- a/docs/github/html/_static/graphviz.css +++ /dev/null @@ -1,19 +0,0 @@ -/* - * graphviz.css - * ~~~~~~~~~~~~ - * - * Sphinx stylesheet -- graphviz extension. - * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -img.graphviz { - border: 0; - max-width: 100%; -} - -object.graphviz { - max-width: 100%; -} diff --git a/docs/github/html/_static/header.svg b/docs/github/html/_static/header.svg deleted file mode 100644 index 0756e63..0000000 --- a/docs/github/html/_static/header.svg +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/docs/github/html/_static/language_data.js b/docs/github/html/_static/language_data.js deleted file mode 100644 index 250f566..0000000 --- a/docs/github/html/_static/language_data.js +++ /dev/null @@ -1,199 +0,0 @@ -/* - * language_data.js - * ~~~~~~~~~~~~~~~~ - * - * This script contains the language-specific data used by searchtools.js, - * namely the list of stopwords, stemmer, scorer and splitter. - * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; - - -/* Non-minified version is copied as a separate JS file, is available */ - -/** - * Porter Stemmer - */ -var Stemmer = function() { - - var step2list = { - ational: 'ate', - tional: 'tion', - enci: 'ence', - anci: 'ance', - izer: 'ize', - bli: 'ble', - alli: 'al', - entli: 'ent', - eli: 'e', - ousli: 'ous', - ization: 'ize', - ation: 'ate', - ator: 'ate', - alism: 'al', - iveness: 'ive', - fulness: 'ful', - ousness: 'ous', - aliti: 'al', - iviti: 'ive', - biliti: 'ble', - logi: 'log' - }; - - var step3list = { - icate: 'ic', - ative: '', - alize: 'al', - iciti: 'ic', - ical: 'ic', - ful: '', - ness: '' - }; - - var c = "[^aeiou]"; // consonant - var v = "[aeiouy]"; // vowel - var C = c + "[^aeiouy]*"; // consonant sequence - var V = v + "[aeiou]*"; // vowel sequence - - var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 - var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 - var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 - var s_v = "^(" + C + ")?" + v; // vowel in stem - - this.stemWord = function (w) { - var stem; - var suffix; - var firstch; - var origword = w; - - if (w.length < 3) - return w; - - var re; - var re2; - var re3; - var re4; - - firstch = w.substr(0,1); - if (firstch == "y") - w = firstch.toUpperCase() + w.substr(1); - - // Step 1a - re = /^(.+?)(ss|i)es$/; - re2 = /^(.+?)([^s])s$/; - - if (re.test(w)) - w = w.replace(re,"$1$2"); - else if (re2.test(w)) - w = w.replace(re2,"$1$2"); - - // Step 1b - re = /^(.+?)eed$/; - re2 = /^(.+?)(ed|ing)$/; - if (re.test(w)) { - var fp = re.exec(w); - re = new RegExp(mgr0); - if (re.test(fp[1])) { - re = /.$/; - w = w.replace(re,""); - } - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1]; - re2 = new RegExp(s_v); - if (re2.test(stem)) { - w = stem; - re2 = /(at|bl|iz)$/; - re3 = new RegExp("([^aeiouylsz])\\1$"); - re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re2.test(w)) - w = w + "e"; - else if (re3.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - else if (re4.test(w)) - w = w + "e"; - } - } - - // Step 1c - re = /^(.+?)y$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(s_v); - if (re.test(stem)) - w = stem + "i"; - } - - // Step 2 - re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step2list[suffix]; - } - - // Step 3 - re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step3list[suffix]; - } - - // Step 4 - re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; - re2 = /^(.+?)(s|t)(ion)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - if (re.test(stem)) - w = stem; - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1] + fp[2]; - re2 = new RegExp(mgr1); - if (re2.test(stem)) - w = stem; - } - - // Step 5 - re = /^(.+?)e$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - re2 = new RegExp(meq1); - re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) - w = stem; - } - re = /ll$/; - re2 = new RegExp(mgr1); - if (re.test(w) && re2.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - - // and turn initial Y back to y - if (firstch == "y") - w = firstch.toLowerCase() + w.substr(1); - return w; - } -} - diff --git a/docs/github/html/_static/pygments.css b/docs/github/html/_static/pygments.css deleted file mode 100644 index ae44878..0000000 --- a/docs/github/html/_static/pygments.css +++ /dev/null @@ -1,246 +0,0 @@ -.highlight pre { line-height: 125%; } -.highlight td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } -.highlight span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } -.highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -.highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -.highlight .hll { background-color: #ffffcc } -.highlight { background: #eeffcc; } -.highlight .c { color: #408090; font-style: italic } /* Comment */ -.highlight .err { border: 1px solid #FF0000 } /* Error */ -.highlight .k { color: #007020; font-weight: bold } /* Keyword */ -.highlight .o { color: #666666 } /* Operator */ -.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */ -.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ -.highlight .cp { color: #007020 } /* Comment.Preproc */ -.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */ -.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ -.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ -.highlight .gd { color: #A00000 } /* Generic.Deleted */ -.highlight .ge { font-style: italic } /* Generic.Emph */ -.highlight .gr { color: #FF0000 } /* Generic.Error */ -.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ -.highlight .gi { color: #00A000 } /* Generic.Inserted */ -.highlight .go { color: #333333 } /* Generic.Output */ -.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ -.highlight .gs { font-weight: bold } /* Generic.Strong */ -.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ -.highlight .gt { color: #0044DD } /* Generic.Traceback */ -.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ -.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ -.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ -.highlight .kp { color: #007020 } /* Keyword.Pseudo */ -.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ -.highlight .kt { color: #902000 } /* Keyword.Type */ -.highlight .m { color: #208050 } /* Literal.Number */ -.highlight .s { color: #4070a0 } /* Literal.String */ -.highlight .na { color: #4070a0 } /* Name.Attribute */ -.highlight .nb { color: #007020 } /* Name.Builtin */ -.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */ -.highlight .no { color: #60add5 } /* Name.Constant */ -.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */ -.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */ -.highlight .ne { color: #007020 } /* Name.Exception */ -.highlight .nf { color: #06287e } /* Name.Function */ -.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ -.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ -.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ -.highlight .nv { color: #bb60d5 } /* Name.Variable */ -.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ -.highlight .w { color: #bbbbbb } /* Text.Whitespace */ -.highlight .mb { color: #208050 } /* Literal.Number.Bin */ -.highlight .mf { color: #208050 } /* Literal.Number.Float */ -.highlight .mh { color: #208050 } /* Literal.Number.Hex */ -.highlight .mi { color: #208050 } /* Literal.Number.Integer */ -.highlight .mo { color: #208050 } /* Literal.Number.Oct */ -.highlight .sa { color: #4070a0 } /* Literal.String.Affix */ -.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ -.highlight .sc { color: #4070a0 } /* Literal.String.Char */ -.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */ -.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ -.highlight .s2 { color: #4070a0 } /* Literal.String.Double */ -.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ -.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */ -.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ -.highlight .sx { color: #c65d09 } /* Literal.String.Other */ -.highlight .sr { color: #235388 } /* Literal.String.Regex */ -.highlight .s1 { color: #4070a0 } /* Literal.String.Single */ -.highlight .ss { color: #517918 } /* Literal.String.Symbol */ -.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ -.highlight .fm { color: #06287e } /* Name.Function.Magic */ -.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ -.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ -.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ -.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */ -.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ -@media not print { -body[data-theme="dark"] .highlight pre { line-height: 125%; } -body[data-theme="dark"] .highlight td.linenos .normal { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } -body[data-theme="dark"] .highlight span.linenos { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } -body[data-theme="dark"] .highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -body[data-theme="dark"] .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -body[data-theme="dark"] .highlight .hll { background-color: #404040 } -body[data-theme="dark"] .highlight { background: #202020; color: #d0d0d0 } -body[data-theme="dark"] .highlight .c { color: #ababab; font-style: italic } /* Comment */ -body[data-theme="dark"] .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ -body[data-theme="dark"] .highlight .esc { color: #d0d0d0 } /* Escape */ -body[data-theme="dark"] .highlight .g { color: #d0d0d0 } /* Generic */ -body[data-theme="dark"] .highlight .k { color: #6ebf26; font-weight: bold } /* Keyword */ -body[data-theme="dark"] .highlight .l { color: #d0d0d0 } /* Literal */ -body[data-theme="dark"] .highlight .n { color: #d0d0d0 } /* Name */ -body[data-theme="dark"] .highlight .o { color: #d0d0d0 } /* Operator */ -body[data-theme="dark"] .highlight .x { color: #d0d0d0 } /* Other */ -body[data-theme="dark"] .highlight .p { color: #d0d0d0 } /* Punctuation */ -body[data-theme="dark"] .highlight .ch { color: #ababab; font-style: italic } /* Comment.Hashbang */ -body[data-theme="dark"] .highlight .cm { color: #ababab; font-style: italic } /* Comment.Multiline */ -body[data-theme="dark"] .highlight .cp { color: #cd2828; font-weight: bold } /* Comment.Preproc */ -body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ -body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ -body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ -body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ -body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ -body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ -body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ -body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ -body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ -body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ -body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ -body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ -body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ -body[data-theme="dark"] .highlight .kp { color: #6ebf26 } /* Keyword.Pseudo */ -body[data-theme="dark"] .highlight .kr { color: #6ebf26; font-weight: bold } /* Keyword.Reserved */ -body[data-theme="dark"] .highlight .kt { color: #6ebf26; font-weight: bold } /* Keyword.Type */ -body[data-theme="dark"] .highlight .ld { color: #d0d0d0 } /* Literal.Date */ -body[data-theme="dark"] .highlight .m { color: #51b2fd } /* Literal.Number */ -body[data-theme="dark"] .highlight .s { color: #ed9d13 } /* Literal.String */ -body[data-theme="dark"] .highlight .na { color: #bbbbbb } /* Name.Attribute */ -body[data-theme="dark"] .highlight .nb { color: #2fbccd } /* Name.Builtin */ -body[data-theme="dark"] .highlight .nc { color: #71adff; text-decoration: underline } /* Name.Class */ -body[data-theme="dark"] .highlight .no { color: #40ffff } /* Name.Constant */ -body[data-theme="dark"] .highlight .nd { color: #ffa500 } /* Name.Decorator */ -body[data-theme="dark"] .highlight .ni { color: #d0d0d0 } /* Name.Entity */ -body[data-theme="dark"] .highlight .ne { color: #bbbbbb } /* Name.Exception */ -body[data-theme="dark"] .highlight .nf { color: #71adff } /* Name.Function */ -body[data-theme="dark"] .highlight .nl { color: #d0d0d0 } /* Name.Label */ -body[data-theme="dark"] .highlight .nn { color: #71adff; text-decoration: underline } /* Name.Namespace */ -body[data-theme="dark"] .highlight .nx { color: #d0d0d0 } /* Name.Other */ -body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ -body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ -body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ -body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ -body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ -body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ -body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ -body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ -body[data-theme="dark"] .highlight .mh { color: #51b2fd } /* Literal.Number.Hex */ -body[data-theme="dark"] .highlight .mi { color: #51b2fd } /* Literal.Number.Integer */ -body[data-theme="dark"] .highlight .mo { color: #51b2fd } /* Literal.Number.Oct */ -body[data-theme="dark"] .highlight .sa { color: #ed9d13 } /* Literal.String.Affix */ -body[data-theme="dark"] .highlight .sb { color: #ed9d13 } /* Literal.String.Backtick */ -body[data-theme="dark"] .highlight .sc { color: #ed9d13 } /* Literal.String.Char */ -body[data-theme="dark"] .highlight .dl { color: #ed9d13 } /* Literal.String.Delimiter */ -body[data-theme="dark"] .highlight .sd { color: #ed9d13 } /* Literal.String.Doc */ -body[data-theme="dark"] .highlight .s2 { color: #ed9d13 } /* Literal.String.Double */ -body[data-theme="dark"] .highlight .se { color: #ed9d13 } /* Literal.String.Escape */ -body[data-theme="dark"] .highlight .sh { color: #ed9d13 } /* Literal.String.Heredoc */ -body[data-theme="dark"] .highlight .si { color: #ed9d13 } /* Literal.String.Interpol */ -body[data-theme="dark"] .highlight .sx { color: #ffa500 } /* Literal.String.Other */ -body[data-theme="dark"] .highlight .sr { color: #ed9d13 } /* Literal.String.Regex */ -body[data-theme="dark"] .highlight .s1 { color: #ed9d13 } /* Literal.String.Single */ -body[data-theme="dark"] .highlight .ss { color: #ed9d13 } /* Literal.String.Symbol */ -body[data-theme="dark"] .highlight .bp { color: #2fbccd } /* Name.Builtin.Pseudo */ -body[data-theme="dark"] .highlight .fm { color: #71adff } /* Name.Function.Magic */ -body[data-theme="dark"] .highlight .vc { color: #40ffff } /* Name.Variable.Class */ -body[data-theme="dark"] .highlight .vg { color: #40ffff } /* Name.Variable.Global */ -body[data-theme="dark"] .highlight .vi { color: #40ffff } /* Name.Variable.Instance */ -body[data-theme="dark"] .highlight .vm { color: #40ffff } /* Name.Variable.Magic */ -body[data-theme="dark"] .highlight .il { color: #51b2fd } /* Literal.Number.Integer.Long */ -@media (prefers-color-scheme: dark) { -body:not([data-theme="light"]) .highlight pre { line-height: 125%; } -body:not([data-theme="light"]) .highlight td.linenos .normal { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } -body:not([data-theme="light"]) .highlight span.linenos { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } -body:not([data-theme="light"]) .highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -body:not([data-theme="light"]) .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -body:not([data-theme="light"]) .highlight .hll { background-color: #404040 } -body:not([data-theme="light"]) .highlight { background: #202020; color: #d0d0d0 } -body:not([data-theme="light"]) .highlight .c { color: #ababab; font-style: italic } /* Comment */ -body:not([data-theme="light"]) .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ -body:not([data-theme="light"]) .highlight .esc { color: #d0d0d0 } /* Escape */ -body:not([data-theme="light"]) .highlight .g { color: #d0d0d0 } /* Generic */ -body:not([data-theme="light"]) .highlight .k { color: #6ebf26; font-weight: bold } /* Keyword */ -body:not([data-theme="light"]) .highlight .l { color: #d0d0d0 } /* Literal */ -body:not([data-theme="light"]) .highlight .n { color: #d0d0d0 } /* Name */ -body:not([data-theme="light"]) .highlight .o { color: #d0d0d0 } /* Operator */ -body:not([data-theme="light"]) .highlight .x { color: #d0d0d0 } /* Other */ -body:not([data-theme="light"]) .highlight .p { color: #d0d0d0 } /* Punctuation */ -body:not([data-theme="light"]) .highlight .ch { color: #ababab; font-style: italic } /* Comment.Hashbang */ -body:not([data-theme="light"]) .highlight .cm { color: #ababab; font-style: italic } /* Comment.Multiline */ -body:not([data-theme="light"]) .highlight .cp { color: #cd2828; font-weight: bold } /* Comment.Preproc */ -body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ -body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ -body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ -body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ -body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ -body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ -body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ -body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ -body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ -body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ -body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ -body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ -body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ -body:not([data-theme="light"]) .highlight .kp { color: #6ebf26 } /* Keyword.Pseudo */ -body:not([data-theme="light"]) .highlight .kr { color: #6ebf26; font-weight: bold } /* Keyword.Reserved */ -body:not([data-theme="light"]) .highlight .kt { color: #6ebf26; font-weight: bold } /* Keyword.Type */ -body:not([data-theme="light"]) .highlight .ld { color: #d0d0d0 } /* Literal.Date */ -body:not([data-theme="light"]) .highlight .m { color: #51b2fd } /* Literal.Number */ -body:not([data-theme="light"]) .highlight .s { color: #ed9d13 } /* Literal.String */ -body:not([data-theme="light"]) .highlight .na { color: #bbbbbb } /* Name.Attribute */ -body:not([data-theme="light"]) .highlight .nb { color: #2fbccd } /* Name.Builtin */ -body:not([data-theme="light"]) .highlight .nc { color: #71adff; text-decoration: underline } /* Name.Class */ -body:not([data-theme="light"]) .highlight .no { color: #40ffff } /* Name.Constant */ -body:not([data-theme="light"]) .highlight .nd { color: #ffa500 } /* Name.Decorator */ -body:not([data-theme="light"]) .highlight .ni { color: #d0d0d0 } /* Name.Entity */ -body:not([data-theme="light"]) .highlight .ne { color: #bbbbbb } /* Name.Exception */ -body:not([data-theme="light"]) .highlight .nf { color: #71adff } /* Name.Function */ -body:not([data-theme="light"]) .highlight .nl { color: #d0d0d0 } /* Name.Label */ -body:not([data-theme="light"]) .highlight .nn { color: #71adff; text-decoration: underline } /* Name.Namespace */ -body:not([data-theme="light"]) .highlight .nx { color: #d0d0d0 } /* Name.Other */ -body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Property */ -body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ -body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ -body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ -body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ -body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ -body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ -body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ -body:not([data-theme="light"]) .highlight .mh { color: #51b2fd } /* Literal.Number.Hex */ -body:not([data-theme="light"]) .highlight .mi { color: #51b2fd } /* Literal.Number.Integer */ -body:not([data-theme="light"]) .highlight .mo { color: #51b2fd } /* Literal.Number.Oct */ -body:not([data-theme="light"]) .highlight .sa { color: #ed9d13 } /* Literal.String.Affix */ -body:not([data-theme="light"]) .highlight .sb { color: #ed9d13 } /* Literal.String.Backtick */ -body:not([data-theme="light"]) .highlight .sc { color: #ed9d13 } /* Literal.String.Char */ -body:not([data-theme="light"]) .highlight .dl { color: #ed9d13 } /* Literal.String.Delimiter */ -body:not([data-theme="light"]) .highlight .sd { color: #ed9d13 } /* Literal.String.Doc */ -body:not([data-theme="light"]) .highlight .s2 { color: #ed9d13 } /* Literal.String.Double */ -body:not([data-theme="light"]) .highlight .se { color: #ed9d13 } /* Literal.String.Escape */ -body:not([data-theme="light"]) .highlight .sh { color: #ed9d13 } /* Literal.String.Heredoc */ -body:not([data-theme="light"]) .highlight .si { color: #ed9d13 } /* Literal.String.Interpol */ -body:not([data-theme="light"]) .highlight .sx { color: #ffa500 } /* Literal.String.Other */ -body:not([data-theme="light"]) .highlight .sr { color: #ed9d13 } /* Literal.String.Regex */ -body:not([data-theme="light"]) .highlight .s1 { color: #ed9d13 } /* Literal.String.Single */ -body:not([data-theme="light"]) .highlight .ss { color: #ed9d13 } /* Literal.String.Symbol */ -body:not([data-theme="light"]) .highlight .bp { color: #2fbccd } /* Name.Builtin.Pseudo */ -body:not([data-theme="light"]) .highlight .fm { color: #71adff } /* Name.Function.Magic */ -body:not([data-theme="light"]) .highlight .vc { color: #40ffff } /* Name.Variable.Class */ -body:not([data-theme="light"]) .highlight .vg { color: #40ffff } /* Name.Variable.Global */ -body:not([data-theme="light"]) .highlight .vi { color: #40ffff } /* Name.Variable.Instance */ -body:not([data-theme="light"]) .highlight .vm { color: #40ffff } /* Name.Variable.Magic */ -body:not([data-theme="light"]) .highlight .il { color: #51b2fd } /* Literal.Number.Integer.Long */ -} -} \ No newline at end of file diff --git a/docs/github/html/_static/python.svg b/docs/github/html/_static/python.svg deleted file mode 100644 index 6a82ce9..0000000 --- a/docs/github/html/_static/python.svg +++ /dev/null @@ -1,281 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - diff --git a/docs/github/html/_static/scripts/furo.js b/docs/github/html/_static/scripts/furo.js deleted file mode 100644 index cbf6487..0000000 --- a/docs/github/html/_static/scripts/furo.js +++ /dev/null @@ -1,3 +0,0 @@ -/*! For license information please see furo.js.LICENSE.txt */ -(()=>{var t={212:function(t,e,n){var o,r;r=void 0!==n.g?n.g:"undefined"!=typeof window?window:this,o=function(){return function(t){"use strict";var e={navClass:"active",contentClass:"active",nested:!1,nestedClass:"active",offset:0,reflow:!1,events:!0},n=function(t,e,n){if(n.settings.events){var o=new CustomEvent(t,{bubbles:!0,cancelable:!0,detail:n});e.dispatchEvent(o)}},o=function(t){var e=0;if(t.offsetParent)for(;t;)e+=t.offsetTop,t=t.offsetParent;return e>=0?e:0},r=function(t){t&&t.sort((function(t,e){return o(t.content)=Math.max(document.body.scrollHeight,document.documentElement.scrollHeight,document.body.offsetHeight,document.documentElement.offsetHeight,document.body.clientHeight,document.documentElement.clientHeight)},l=function(t,e){var n=t[t.length-1];if(function(t,e){return!(!s()||!c(t.content,e,!0))}(n,e))return n;for(var o=t.length-1;o>=0;o--)if(c(t[o].content,e))return t[o]},a=function(t,e){if(e.nested&&t.parentNode){var n=t.parentNode.closest("li");n&&(n.classList.remove(e.nestedClass),a(n,e))}},i=function(t,e){if(t){var o=t.nav.closest("li");o&&(o.classList.remove(e.navClass),t.content.classList.remove(e.contentClass),a(o,e),n("gumshoeDeactivate",o,{link:t.nav,content:t.content,settings:e}))}},u=function(t,e){if(e.nested){var n=t.parentNode.closest("li");n&&(n.classList.add(e.nestedClass),u(n,e))}};return function(o,c){var s,a,d,f,m,v={setup:function(){s=document.querySelectorAll(o),a=[],Array.prototype.forEach.call(s,(function(t){var e=document.getElementById(decodeURIComponent(t.hash.substr(1)));e&&a.push({nav:t,content:e})})),r(a)},detect:function(){var t=l(a,m);t?d&&t.content===d.content||(i(d,m),function(t,e){if(t){var o=t.nav.closest("li");o&&(o.classList.add(e.navClass),t.content.classList.add(e.contentClass),u(o,e),n("gumshoeActivate",o,{link:t.nav,content:t.content,settings:e}))}}(t,m),d=t):d&&(i(d,m),d=null)}},h=function(e){f&&t.cancelAnimationFrame(f),f=t.requestAnimationFrame(v.detect)},g=function(e){f&&t.cancelAnimationFrame(f),f=t.requestAnimationFrame((function(){r(a),v.detect()}))};return v.destroy=function(){d&&i(d,m),t.removeEventListener("scroll",h,!1),m.reflow&&t.removeEventListener("resize",g,!1),a=null,s=null,d=null,f=null,m=null},m=function(){var t={};return Array.prototype.forEach.call(arguments,(function(e){for(var n in e){if(!e.hasOwnProperty(n))return;t[n]=e[n]}})),t}(e,c||{}),v.setup(),v.detect(),t.addEventListener("scroll",h,!1),m.reflow&&t.addEventListener("resize",g,!1),v}}(r)}.apply(e,[]),void 0===o||(t.exports=o)}},e={};function n(o){var r=e[o];if(void 0!==r)return r.exports;var c=e[o]={exports:{}};return t[o].call(c.exports,c,c.exports,n),c.exports}n.n=t=>{var e=t&&t.__esModule?()=>t.default:()=>t;return n.d(e,{a:e}),e},n.d=(t,e)=>{for(var o in e)n.o(e,o)&&!n.o(t,o)&&Object.defineProperty(t,o,{enumerable:!0,get:e[o]})},n.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(t){if("object"==typeof window)return window}}(),n.o=(t,e)=>Object.prototype.hasOwnProperty.call(t,e),(()=>{"use strict";var t=n(212),e=n.n(t),o=null,r=null,c=window.pageYOffset||document.documentElement.scrollTop;function s(){const t=localStorage.getItem("theme")||"auto";var e;"light"!==(e=window.matchMedia("(prefers-color-scheme: dark)").matches?"auto"===t?"light":"light"==t?"dark":"auto":"auto"===t?"dark":"dark"==t?"light":"auto")&&"dark"!==e&&"auto"!==e&&(console.error(`Got invalid theme mode: ${e}. Resetting to auto.`),e="auto"),document.body.dataset.theme=e,localStorage.setItem("theme",e),console.log(`Changed to ${e} mode.`)}function l(){!function(){const t=document.getElementsByClassName("theme-toggle");Array.from(t).forEach((t=>{t.addEventListener("click",s)}))}(),function(){let t=0,e=!1;window.addEventListener("scroll",(function(n){t=window.scrollY,e||(window.requestAnimationFrame((function(){var n;n=t,0==Math.floor(r.getBoundingClientRect().top)?r.classList.add("scrolled"):r.classList.remove("scrolled"),function(t){t<64?document.documentElement.classList.remove("show-back-to-top"):tc&&document.documentElement.classList.remove("show-back-to-top"),c=t}(n),function(t){null!==o&&(0==t?o.scrollTo(0,0):Math.ceil(t)>=Math.floor(document.documentElement.scrollHeight-window.innerHeight)?o.scrollTo(0,o.scrollHeight):document.querySelector(".scroll-current"))}(n),e=!1})),e=!0)})),window.scroll()}(),null!==o&&new(e())(".toc-tree a",{reflow:!0,recursive:!0,navClass:"scroll-current",offset:()=>{let t=parseFloat(getComputedStyle(document.documentElement).fontSize);return r.getBoundingClientRect().height+.5*t+1}})}document.addEventListener("DOMContentLoaded",(function(){document.body.parentNode.classList.remove("no-js"),r=document.querySelector("header"),o=document.querySelector(".toc-scroll"),l()}))})()})(); -//# sourceMappingURL=furo.js.map \ No newline at end of file diff --git a/docs/github/html/_static/scripts/furo.js.LICENSE.txt b/docs/github/html/_static/scripts/furo.js.LICENSE.txt deleted file mode 100644 index 1632189..0000000 --- a/docs/github/html/_static/scripts/furo.js.LICENSE.txt +++ /dev/null @@ -1,7 +0,0 @@ -/*! - * gumshoejs v5.1.2 (patched by @pradyunsg) - * A simple, framework-agnostic scrollspy script. - * (c) 2019 Chris Ferdinandi - * MIT License - * http://github.com/cferdinandi/gumshoe - */ diff --git a/docs/github/html/_static/scripts/furo.js.map b/docs/github/html/_static/scripts/furo.js.map deleted file mode 100644 index 7ed2be8..0000000 --- a/docs/github/html/_static/scripts/furo.js.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"scripts/furo.js","mappings":";iCAAA,MAQWA,SAWS,IAAX,EAAAC,EACH,EAAAA,EACkB,oBAAXC,OACPA,OACAC,KAbS,EAAF,WACP,OAaJ,SAAUD,GACR,aAMA,IAAIE,EAAW,CAEbC,SAAU,SACVC,aAAc,SAGdC,QAAQ,EACRC,YAAa,SAGbC,OAAQ,EACRC,QAAQ,EAGRC,QAAQ,GA6BNC,EAAY,SAAUC,EAAMC,EAAMC,GAEpC,GAAKA,EAAOC,SAASL,OAArB,CAGA,IAAIM,EAAQ,IAAIC,YAAYL,EAAM,CAChCM,SAAS,EACTC,YAAY,EACZL,OAAQA,IAIVD,EAAKO,cAAcJ,KAQjBK,EAAe,SAAUR,GAC3B,IAAIS,EAAW,EACf,GAAIT,EAAKU,aACP,KAAOV,GACLS,GAAYT,EAAKW,UACjBX,EAAOA,EAAKU,aAGhB,OAAOD,GAAY,EAAIA,EAAW,GAOhCG,EAAe,SAAUC,GACvBA,GACFA,EAASC,MAAK,SAAUC,EAAOC,GAG7B,OAFcR,EAAaO,EAAME,SACnBT,EAAaQ,EAAMC,UACF,EACxB,MA2CTC,EAAW,SAAUlB,EAAME,EAAUiB,GACvC,IAAIC,EAASpB,EAAKqB,wBACd1B,EAnCU,SAAUO,GAExB,MAA+B,mBAApBA,EAASP,OACX2B,WAAWpB,EAASP,UAItB2B,WAAWpB,EAASP,QA4Bd4B,CAAUrB,GACvB,OAAIiB,EAEAK,SAASJ,EAAOD,OAAQ,KACvB/B,EAAOqC,aAAeC,SAASC,gBAAgBC,cAG7CJ,SAASJ,EAAOS,IAAK,KAAOlC,GAOjCmC,EAAa,WACf,OACEC,KAAKC,KAAK5C,EAAOqC,YAAcrC,EAAO6C,cAnCjCF,KAAKG,IACVR,SAASS,KAAKC,aACdV,SAASC,gBAAgBS,aACzBV,SAASS,KAAKE,aACdX,SAASC,gBAAgBU,aACzBX,SAASS,KAAKP,aACdF,SAASC,gBAAgBC,eAqDzBU,EAAY,SAAUzB,EAAUX,GAClC,IAAIqC,EAAO1B,EAASA,EAAS2B,OAAS,GACtC,GAbgB,SAAUC,EAAMvC,GAChC,SAAI4B,MAAgBZ,EAASuB,EAAKxB,QAASf,GAAU,IAYjDwC,CAAYH,EAAMrC,GAAW,OAAOqC,EACxC,IAAK,IAAII,EAAI9B,EAAS2B,OAAS,EAAGG,GAAK,EAAGA,IACxC,GAAIzB,EAASL,EAAS8B,GAAG1B,QAASf,GAAW,OAAOW,EAAS8B,IAS7DC,EAAmB,SAAUC,EAAK3C,GAEpC,GAAKA,EAAST,QAAWoD,EAAIC,WAA7B,CAGA,IAAIC,EAAKF,EAAIC,WAAWE,QAAQ,MAC3BD,IAGLA,EAAGE,UAAUC,OAAOhD,EAASR,aAG7BkD,EAAiBG,EAAI7C,MAQnBiD,EAAa,SAAUC,EAAOlD,GAEhC,GAAKkD,EAAL,CAGA,IAAIL,EAAKK,EAAMP,IAAIG,QAAQ,MACtBD,IAGLA,EAAGE,UAAUC,OAAOhD,EAASX,UAC7B6D,EAAMnC,QAAQgC,UAAUC,OAAOhD,EAASV,cAGxCoD,EAAiBG,EAAI7C,GAGrBJ,EAAU,oBAAqBiD,EAAI,CACjCM,KAAMD,EAAMP,IACZ5B,QAASmC,EAAMnC,QACff,SAAUA,OASVoD,EAAiB,SAAUT,EAAK3C,GAElC,GAAKA,EAAST,OAAd,CAGA,IAAIsD,EAAKF,EAAIC,WAAWE,QAAQ,MAC3BD,IAGLA,EAAGE,UAAUM,IAAIrD,EAASR,aAG1B4D,EAAeP,EAAI7C,MA8LrB,OA1JkB,SAAUsD,EAAUC,GAKpC,IACIC,EAAU7C,EAAU8C,EAASC,EAAS1D,EADtC2D,EAAa,CAUjBA,MAAmB,WAEjBH,EAAWhC,SAASoC,iBAAiBN,GAGrC3C,EAAW,GAGXkD,MAAMC,UAAUC,QAAQC,KAAKR,GAAU,SAAUjB,GAE/C,IAAIxB,EAAUS,SAASyC,eACrBC,mBAAmB3B,EAAK4B,KAAKC,OAAO,KAEjCrD,GAGLJ,EAAS0D,KAAK,CACZ1B,IAAKJ,EACLxB,QAASA,OAKbL,EAAaC,IAMfgD,OAAoB,WAElB,IAAIW,EAASlC,EAAUzB,EAAUX,GAG5BsE,EASDb,GAAWa,EAAOvD,UAAY0C,EAAQ1C,UAG1CkC,EAAWQ,EAASzD,GAzFT,SAAUkD,EAAOlD,GAE9B,GAAKkD,EAAL,CAGA,IAAIL,EAAKK,EAAMP,IAAIG,QAAQ,MACtBD,IAGLA,EAAGE,UAAUM,IAAIrD,EAASX,UAC1B6D,EAAMnC,QAAQgC,UAAUM,IAAIrD,EAASV,cAGrC8D,EAAeP,EAAI7C,GAGnBJ,EAAU,kBAAmBiD,EAAI,CAC/BM,KAAMD,EAAMP,IACZ5B,QAASmC,EAAMnC,QACff,SAAUA,MAuEVuE,CAASD,EAAQtE,GAGjByD,EAAUa,GAfJb,IACFR,EAAWQ,EAASzD,GACpByD,EAAU,QAoBZe,EAAgB,SAAUvE,GAExByD,GACFxE,EAAOuF,qBAAqBf,GAI9BA,EAAUxE,EAAOwF,sBAAsBf,EAAWgB,SAOhDC,EAAgB,SAAU3E,GAExByD,GACFxE,EAAOuF,qBAAqBf,GAI9BA,EAAUxE,EAAOwF,uBAAsB,WACrChE,EAAaC,GACbgD,EAAWgB,aAoDf,OA7CAhB,EAAWkB,QAAU,WAEfpB,GACFR,EAAWQ,EAASzD,GAItBd,EAAO4F,oBAAoB,SAAUN,GAAe,GAChDxE,EAASN,QACXR,EAAO4F,oBAAoB,SAAUF,GAAe,GAItDjE,EAAW,KACX6C,EAAW,KACXC,EAAU,KACVC,EAAU,KACV1D,EAAW,MAQXA,EA3XS,WACX,IAAI+E,EAAS,GAOb,OANAlB,MAAMC,UAAUC,QAAQC,KAAKgB,WAAW,SAAUC,GAChD,IAAK,IAAIC,KAAOD,EAAK,CACnB,IAAKA,EAAIE,eAAeD,GAAM,OAC9BH,EAAOG,GAAOD,EAAIC,OAGfH,EAmXMK,CAAOhG,EAAUmE,GAAW,IAGvCI,EAAW0B,QAGX1B,EAAWgB,SAGXzF,EAAOoG,iBAAiB,SAAUd,GAAe,GAC7CxE,EAASN,QACXR,EAAOoG,iBAAiB,SAAUV,GAAe,GAS9CjB,GA7bA4B,CAAQvG,IAChB,QAFM,SAEN,uBCXDwG,EAA2B,GAG/B,SAASC,EAAoBC,GAE5B,IAAIC,EAAeH,EAAyBE,GAC5C,QAAqBE,IAAjBD,EACH,OAAOA,EAAaE,QAGrB,IAAIC,EAASN,EAAyBE,GAAY,CAGjDG,QAAS,IAOV,OAHAE,EAAoBL,GAAU1B,KAAK8B,EAAOD,QAASC,EAAQA,EAAOD,QAASJ,GAGpEK,EAAOD,QCpBfJ,EAAoBO,EAAKF,IACxB,IAAIG,EAASH,GAAUA,EAAOI,WAC7B,IAAOJ,EAAiB,QACxB,IAAM,EAEP,OADAL,EAAoBU,EAAEF,EAAQ,CAAEG,EAAGH,IAC5BA,GCLRR,EAAoBU,EAAI,CAACN,EAASQ,KACjC,IAAI,IAAInB,KAAOmB,EACXZ,EAAoBa,EAAED,EAAYnB,KAASO,EAAoBa,EAAET,EAASX,IAC5EqB,OAAOC,eAAeX,EAASX,EAAK,CAAEuB,YAAY,EAAMC,IAAKL,EAAWnB,MCJ3EO,EAAoBxG,EAAI,WACvB,GAA0B,iBAAf0H,WAAyB,OAAOA,WAC3C,IACC,OAAOxH,MAAQ,IAAIyH,SAAS,cAAb,GACd,MAAOC,GACR,GAAsB,iBAAX3H,OAAqB,OAAOA,QALjB,GCAxBuG,EAAoBa,EAAI,CAACrB,EAAK6B,IAAUP,OAAOzC,UAAUqB,eAAenB,KAAKiB,EAAK6B,4CCK9EC,EAAY,KACZC,EAAS,KACTC,EAAgB/H,OAAO6C,aAAeP,SAASC,gBAAgByF,UA4EnE,SAASC,IACP,MAAMC,EAAeC,aAAaC,QAAQ,UAAY,OAZxD,IAAkBC,EACH,WADGA,EAaIrI,OAAOsI,WAAW,gCAAgCC,QAI/C,SAAjBL,EACO,QACgB,SAAhBA,EACA,OAEA,OAIU,SAAjBA,EACO,OACgB,QAAhBA,EACA,QAEA,SA9BoB,SAATG,GAA4B,SAATA,IACzCG,QAAQC,MAAM,2BAA2BJ,yBACzCA,EAAO,QAGT/F,SAASS,KAAK2F,QAAQC,MAAQN,EAC9BF,aAAaS,QAAQ,QAASP,GAC9BG,QAAQK,IAAI,cAAcR,WA4E5B,SAASlC,KART,WAEE,MAAM2C,EAAUxG,SAASyG,uBAAuB,gBAChDpE,MAAMqE,KAAKF,GAASjE,SAASoE,IAC3BA,EAAI7C,iBAAiB,QAAS6B,MAKhCiB,GA9CF,WAEE,IAAIC,EAA6B,EAC7BC,GAAU,EAEdpJ,OAAOoG,iBAAiB,UAAU,SAAUuB,GAC1CwB,EAA6BnJ,OAAOqJ,QAE/BD,IACHpJ,OAAOwF,uBAAsB,WAzDnC,IAAuB8D,IA0DDH,EA9GkC,GAAlDxG,KAAK4G,MAAMzB,EAAO7F,wBAAwBQ,KAC5CqF,EAAOjE,UAAUM,IAAI,YAErB2D,EAAOjE,UAAUC,OAAO,YAI5B,SAAmCwF,GAC7BA,EAXmB,GAYrBhH,SAASC,gBAAgBsB,UAAUC,OAAO,oBAEtCwF,EAAYvB,EACdzF,SAASC,gBAAgBsB,UAAUM,IAAI,oBAC9BmF,EAAYvB,GACrBzF,SAASC,gBAAgBsB,UAAUC,OAAO,oBAG9CiE,EAAgBuB,EAqChBE,CAA0BF,GAlC5B,SAA6BA,GACT,OAAdzB,IAKa,GAAbyB,EACFzB,EAAU4B,SAAS,EAAG,GAGtB9G,KAAKC,KAAK0G,IACV3G,KAAK4G,MAAMjH,SAASC,gBAAgBS,aAAehD,OAAOqC,aAE1DwF,EAAU4B,SAAS,EAAG5B,EAAU7E,cAGhBV,SAASoH,cAAc,oBAmBzCC,CAAoBL,GAwDdF,GAAU,KAGZA,GAAU,MAGdpJ,OAAO4J,SA8BPC,GA1BkB,OAAdhC,GAKJ,IAAI,IAAJ,CAAY,cAAe,CACzBrH,QAAQ,EACRsJ,WAAW,EACX3J,SAAU,iBACVI,OAAQ,KACN,IAAIwJ,EAAM7H,WAAW8H,iBAAiB1H,SAASC,iBAAiB0H,UAChE,OAAOnC,EAAO7F,wBAAwBiI,OAAS,GAAMH,EAAM,KA+BjEzH,SAAS8D,iBAAiB,oBAT1B,WACE9D,SAASS,KAAKW,WAAWG,UAAUC,OAAO,SAE1CgE,EAASxF,SAASoH,cAAc,UAChC7B,EAAYvF,SAASoH,cAAc,eAEnCvD","sources":["webpack:///./src/furo/assets/scripts/gumshoe-patched.js","webpack:///webpack/bootstrap","webpack:///webpack/runtime/compat get default export","webpack:///webpack/runtime/define property getters","webpack:///webpack/runtime/global","webpack:///webpack/runtime/hasOwnProperty shorthand","webpack:///./src/furo/assets/scripts/furo.js"],"sourcesContent":["/*!\n * gumshoejs v5.1.2 (patched by @pradyunsg)\n * A simple, framework-agnostic scrollspy script.\n * (c) 2019 Chris Ferdinandi\n * MIT License\n * http://github.com/cferdinandi/gumshoe\n */\n\n(function (root, factory) {\n if (typeof define === \"function\" && define.amd) {\n define([], function () {\n return factory(root);\n });\n } else if (typeof exports === \"object\") {\n module.exports = factory(root);\n } else {\n root.Gumshoe = factory(root);\n }\n})(\n typeof global !== \"undefined\"\n ? global\n : typeof window !== \"undefined\"\n ? window\n : this,\n function (window) {\n \"use strict\";\n\n //\n // Defaults\n //\n\n var defaults = {\n // Active classes\n navClass: \"active\",\n contentClass: \"active\",\n\n // Nested navigation\n nested: false,\n nestedClass: \"active\",\n\n // Offset & reflow\n offset: 0,\n reflow: false,\n\n // Event support\n events: true,\n };\n\n //\n // Methods\n //\n\n /**\n * Merge two or more objects together.\n * @param {Object} objects The objects to merge together\n * @returns {Object} Merged values of defaults and options\n */\n var extend = function () {\n var merged = {};\n Array.prototype.forEach.call(arguments, function (obj) {\n for (var key in obj) {\n if (!obj.hasOwnProperty(key)) return;\n merged[key] = obj[key];\n }\n });\n return merged;\n };\n\n /**\n * Emit a custom event\n * @param {String} type The event type\n * @param {Node} elem The element to attach the event to\n * @param {Object} detail Any details to pass along with the event\n */\n var emitEvent = function (type, elem, detail) {\n // Make sure events are enabled\n if (!detail.settings.events) return;\n\n // Create a new event\n var event = new CustomEvent(type, {\n bubbles: true,\n cancelable: true,\n detail: detail,\n });\n\n // Dispatch the event\n elem.dispatchEvent(event);\n };\n\n /**\n * Get an element's distance from the top of the Document.\n * @param {Node} elem The element\n * @return {Number} Distance from the top in pixels\n */\n var getOffsetTop = function (elem) {\n var location = 0;\n if (elem.offsetParent) {\n while (elem) {\n location += elem.offsetTop;\n elem = elem.offsetParent;\n }\n }\n return location >= 0 ? location : 0;\n };\n\n /**\n * Sort content from first to last in the DOM\n * @param {Array} contents The content areas\n */\n var sortContents = function (contents) {\n if (contents) {\n contents.sort(function (item1, item2) {\n var offset1 = getOffsetTop(item1.content);\n var offset2 = getOffsetTop(item2.content);\n if (offset1 < offset2) return -1;\n return 1;\n });\n }\n };\n\n /**\n * Get the offset to use for calculating position\n * @param {Object} settings The settings for this instantiation\n * @return {Float} The number of pixels to offset the calculations\n */\n var getOffset = function (settings) {\n // if the offset is a function run it\n if (typeof settings.offset === \"function\") {\n return parseFloat(settings.offset());\n }\n\n // Otherwise, return it as-is\n return parseFloat(settings.offset);\n };\n\n /**\n * Get the document element's height\n * @private\n * @returns {Number}\n */\n var getDocumentHeight = function () {\n return Math.max(\n document.body.scrollHeight,\n document.documentElement.scrollHeight,\n document.body.offsetHeight,\n document.documentElement.offsetHeight,\n document.body.clientHeight,\n document.documentElement.clientHeight,\n );\n };\n\n /**\n * Determine if an element is in view\n * @param {Node} elem The element\n * @param {Object} settings The settings for this instantiation\n * @param {Boolean} bottom If true, check if element is above bottom of viewport instead\n * @return {Boolean} Returns true if element is in the viewport\n */\n var isInView = function (elem, settings, bottom) {\n var bounds = elem.getBoundingClientRect();\n var offset = getOffset(settings);\n if (bottom) {\n return (\n parseInt(bounds.bottom, 10) <\n (window.innerHeight || document.documentElement.clientHeight)\n );\n }\n return parseInt(bounds.top, 10) <= offset;\n };\n\n /**\n * Check if at the bottom of the viewport\n * @return {Boolean} If true, page is at the bottom of the viewport\n */\n var isAtBottom = function () {\n if (\n Math.ceil(window.innerHeight + window.pageYOffset) >=\n getDocumentHeight()\n )\n return true;\n return false;\n };\n\n /**\n * Check if the last item should be used (even if not at the top of the page)\n * @param {Object} item The last item\n * @param {Object} settings The settings for this instantiation\n * @return {Boolean} If true, use the last item\n */\n var useLastItem = function (item, settings) {\n if (isAtBottom() && isInView(item.content, settings, true)) return true;\n return false;\n };\n\n /**\n * Get the active content\n * @param {Array} contents The content areas\n * @param {Object} settings The settings for this instantiation\n * @return {Object} The content area and matching navigation link\n */\n var getActive = function (contents, settings) {\n var last = contents[contents.length - 1];\n if (useLastItem(last, settings)) return last;\n for (var i = contents.length - 1; i >= 0; i--) {\n if (isInView(contents[i].content, settings)) return contents[i];\n }\n };\n\n /**\n * Deactivate parent navs in a nested navigation\n * @param {Node} nav The starting navigation element\n * @param {Object} settings The settings for this instantiation\n */\n var deactivateNested = function (nav, settings) {\n // If nesting isn't activated, bail\n if (!settings.nested || !nav.parentNode) return;\n\n // Get the parent navigation\n var li = nav.parentNode.closest(\"li\");\n if (!li) return;\n\n // Remove the active class\n li.classList.remove(settings.nestedClass);\n\n // Apply recursively to any parent navigation elements\n deactivateNested(li, settings);\n };\n\n /**\n * Deactivate a nav and content area\n * @param {Object} items The nav item and content to deactivate\n * @param {Object} settings The settings for this instantiation\n */\n var deactivate = function (items, settings) {\n // Make sure there are items to deactivate\n if (!items) return;\n\n // Get the parent list item\n var li = items.nav.closest(\"li\");\n if (!li) return;\n\n // Remove the active class from the nav and content\n li.classList.remove(settings.navClass);\n items.content.classList.remove(settings.contentClass);\n\n // Deactivate any parent navs in a nested navigation\n deactivateNested(li, settings);\n\n // Emit a custom event\n emitEvent(\"gumshoeDeactivate\", li, {\n link: items.nav,\n content: items.content,\n settings: settings,\n });\n };\n\n /**\n * Activate parent navs in a nested navigation\n * @param {Node} nav The starting navigation element\n * @param {Object} settings The settings for this instantiation\n */\n var activateNested = function (nav, settings) {\n // If nesting isn't activated, bail\n if (!settings.nested) return;\n\n // Get the parent navigation\n var li = nav.parentNode.closest(\"li\");\n if (!li) return;\n\n // Add the active class\n li.classList.add(settings.nestedClass);\n\n // Apply recursively to any parent navigation elements\n activateNested(li, settings);\n };\n\n /**\n * Activate a nav and content area\n * @param {Object} items The nav item and content to activate\n * @param {Object} settings The settings for this instantiation\n */\n var activate = function (items, settings) {\n // Make sure there are items to activate\n if (!items) return;\n\n // Get the parent list item\n var li = items.nav.closest(\"li\");\n if (!li) return;\n\n // Add the active class to the nav and content\n li.classList.add(settings.navClass);\n items.content.classList.add(settings.contentClass);\n\n // Activate any parent navs in a nested navigation\n activateNested(li, settings);\n\n // Emit a custom event\n emitEvent(\"gumshoeActivate\", li, {\n link: items.nav,\n content: items.content,\n settings: settings,\n });\n };\n\n /**\n * Create the Constructor object\n * @param {String} selector The selector to use for navigation items\n * @param {Object} options User options and settings\n */\n var Constructor = function (selector, options) {\n //\n // Variables\n //\n\n var publicAPIs = {};\n var navItems, contents, current, timeout, settings;\n\n //\n // Methods\n //\n\n /**\n * Set variables from DOM elements\n */\n publicAPIs.setup = function () {\n // Get all nav items\n navItems = document.querySelectorAll(selector);\n\n // Create contents array\n contents = [];\n\n // Loop through each item, get it's matching content, and push to the array\n Array.prototype.forEach.call(navItems, function (item) {\n // Get the content for the nav item\n var content = document.getElementById(\n decodeURIComponent(item.hash.substr(1)),\n );\n if (!content) return;\n\n // Push to the contents array\n contents.push({\n nav: item,\n content: content,\n });\n });\n\n // Sort contents by the order they appear in the DOM\n sortContents(contents);\n };\n\n /**\n * Detect which content is currently active\n */\n publicAPIs.detect = function () {\n // Get the active content\n var active = getActive(contents, settings);\n\n // if there's no active content, deactivate and bail\n if (!active) {\n if (current) {\n deactivate(current, settings);\n current = null;\n }\n return;\n }\n\n // If the active content is the one currently active, do nothing\n if (current && active.content === current.content) return;\n\n // Deactivate the current content and activate the new content\n deactivate(current, settings);\n activate(active, settings);\n\n // Update the currently active content\n current = active;\n };\n\n /**\n * Detect the active content on scroll\n * Debounced for performance\n */\n var scrollHandler = function (event) {\n // If there's a timer, cancel it\n if (timeout) {\n window.cancelAnimationFrame(timeout);\n }\n\n // Setup debounce callback\n timeout = window.requestAnimationFrame(publicAPIs.detect);\n };\n\n /**\n * Update content sorting on resize\n * Debounced for performance\n */\n var resizeHandler = function (event) {\n // If there's a timer, cancel it\n if (timeout) {\n window.cancelAnimationFrame(timeout);\n }\n\n // Setup debounce callback\n timeout = window.requestAnimationFrame(function () {\n sortContents(contents);\n publicAPIs.detect();\n });\n };\n\n /**\n * Destroy the current instantiation\n */\n publicAPIs.destroy = function () {\n // Undo DOM changes\n if (current) {\n deactivate(current, settings);\n }\n\n // Remove event listeners\n window.removeEventListener(\"scroll\", scrollHandler, false);\n if (settings.reflow) {\n window.removeEventListener(\"resize\", resizeHandler, false);\n }\n\n // Reset variables\n contents = null;\n navItems = null;\n current = null;\n timeout = null;\n settings = null;\n };\n\n /**\n * Initialize the current instantiation\n */\n var init = function () {\n // Merge user options into defaults\n settings = extend(defaults, options || {});\n\n // Setup variables based on the current DOM\n publicAPIs.setup();\n\n // Find the currently active content\n publicAPIs.detect();\n\n // Setup event listeners\n window.addEventListener(\"scroll\", scrollHandler, false);\n if (settings.reflow) {\n window.addEventListener(\"resize\", resizeHandler, false);\n }\n };\n\n //\n // Initialize and return the public APIs\n //\n\n init();\n return publicAPIs;\n };\n\n //\n // Return the Constructor\n //\n\n return Constructor;\n },\n);\n","// The module cache\nvar __webpack_module_cache__ = {};\n\n// The require function\nfunction __webpack_require__(moduleId) {\n\t// Check if module is in cache\n\tvar cachedModule = __webpack_module_cache__[moduleId];\n\tif (cachedModule !== undefined) {\n\t\treturn cachedModule.exports;\n\t}\n\t// Create a new module (and put it into the cache)\n\tvar module = __webpack_module_cache__[moduleId] = {\n\t\t// no module.id needed\n\t\t// no module.loaded needed\n\t\texports: {}\n\t};\n\n\t// Execute the module function\n\t__webpack_modules__[moduleId].call(module.exports, module, module.exports, __webpack_require__);\n\n\t// Return the exports of the module\n\treturn module.exports;\n}\n\n","// getDefaultExport function for compatibility with non-harmony modules\n__webpack_require__.n = (module) => {\n\tvar getter = module && module.__esModule ?\n\t\t() => (module['default']) :\n\t\t() => (module);\n\t__webpack_require__.d(getter, { a: getter });\n\treturn getter;\n};","// define getter functions for harmony exports\n__webpack_require__.d = (exports, definition) => {\n\tfor(var key in definition) {\n\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n\t\t}\n\t}\n};","__webpack_require__.g = (function() {\n\tif (typeof globalThis === 'object') return globalThis;\n\ttry {\n\t\treturn this || new Function('return this')();\n\t} catch (e) {\n\t\tif (typeof window === 'object') return window;\n\t}\n})();","__webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))","import Gumshoe from \"./gumshoe-patched.js\";\n\n////////////////////////////////////////////////////////////////////////////////\n// Scroll Handling\n////////////////////////////////////////////////////////////////////////////////\nvar tocScroll = null;\nvar header = null;\nvar lastScrollTop = window.pageYOffset || document.documentElement.scrollTop;\nconst GO_TO_TOP_OFFSET = 64;\n\nfunction scrollHandlerForHeader() {\n if (Math.floor(header.getBoundingClientRect().top) == 0) {\n header.classList.add(\"scrolled\");\n } else {\n header.classList.remove(\"scrolled\");\n }\n}\n\nfunction scrollHandlerForBackToTop(positionY) {\n if (positionY < GO_TO_TOP_OFFSET) {\n document.documentElement.classList.remove(\"show-back-to-top\");\n } else {\n if (positionY < lastScrollTop) {\n document.documentElement.classList.add(\"show-back-to-top\");\n } else if (positionY > lastScrollTop) {\n document.documentElement.classList.remove(\"show-back-to-top\");\n }\n }\n lastScrollTop = positionY;\n}\n\nfunction scrollHandlerForTOC(positionY) {\n if (tocScroll === null) {\n return;\n }\n\n // top of page.\n if (positionY == 0) {\n tocScroll.scrollTo(0, 0);\n } else if (\n // bottom of page.\n Math.ceil(positionY) >=\n Math.floor(document.documentElement.scrollHeight - window.innerHeight)\n ) {\n tocScroll.scrollTo(0, tocScroll.scrollHeight);\n } else {\n // somewhere in the middle.\n const current = document.querySelector(\".scroll-current\");\n if (current == null) {\n return;\n }\n\n // https://github.com/pypa/pip/issues/9159 This breaks scroll behaviours.\n // // scroll the currently \"active\" heading in toc, into view.\n // const rect = current.getBoundingClientRect();\n // if (0 > rect.top) {\n // current.scrollIntoView(true); // the argument is \"alignTop\"\n // } else if (rect.bottom > window.innerHeight) {\n // current.scrollIntoView(false);\n // }\n }\n}\n\nfunction scrollHandler(positionY) {\n scrollHandlerForHeader();\n scrollHandlerForBackToTop(positionY);\n scrollHandlerForTOC(positionY);\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Theme Toggle\n////////////////////////////////////////////////////////////////////////////////\nfunction setTheme(mode) {\n if (mode !== \"light\" && mode !== \"dark\" && mode !== \"auto\") {\n console.error(`Got invalid theme mode: ${mode}. Resetting to auto.`);\n mode = \"auto\";\n }\n\n document.body.dataset.theme = mode;\n localStorage.setItem(\"theme\", mode);\n console.log(`Changed to ${mode} mode.`);\n}\n\nfunction cycleThemeOnce() {\n const currentTheme = localStorage.getItem(\"theme\") || \"auto\";\n const prefersDark = window.matchMedia(\"(prefers-color-scheme: dark)\").matches;\n\n if (prefersDark) {\n // Auto (dark) -> Light -> Dark\n if (currentTheme === \"auto\") {\n setTheme(\"light\");\n } else if (currentTheme == \"light\") {\n setTheme(\"dark\");\n } else {\n setTheme(\"auto\");\n }\n } else {\n // Auto (light) -> Dark -> Light\n if (currentTheme === \"auto\") {\n setTheme(\"dark\");\n } else if (currentTheme == \"dark\") {\n setTheme(\"light\");\n } else {\n setTheme(\"auto\");\n }\n }\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Setup\n////////////////////////////////////////////////////////////////////////////////\nfunction setupScrollHandler() {\n // Taken from https://developer.mozilla.org/en-US/docs/Web/API/Document/scroll_event\n let last_known_scroll_position = 0;\n let ticking = false;\n\n window.addEventListener(\"scroll\", function (e) {\n last_known_scroll_position = window.scrollY;\n\n if (!ticking) {\n window.requestAnimationFrame(function () {\n scrollHandler(last_known_scroll_position);\n ticking = false;\n });\n\n ticking = true;\n }\n });\n window.scroll();\n}\n\nfunction setupScrollSpy() {\n if (tocScroll === null) {\n return;\n }\n\n // Scrollspy -- highlight table on contents, based on scroll\n new Gumshoe(\".toc-tree a\", {\n reflow: true,\n recursive: true,\n navClass: \"scroll-current\",\n offset: () => {\n let rem = parseFloat(getComputedStyle(document.documentElement).fontSize);\n return header.getBoundingClientRect().height + 0.5 * rem + 1;\n },\n });\n}\n\nfunction setupTheme() {\n // Attach event handlers for toggling themes\n const buttons = document.getElementsByClassName(\"theme-toggle\");\n Array.from(buttons).forEach((btn) => {\n btn.addEventListener(\"click\", cycleThemeOnce);\n });\n}\n\nfunction setup() {\n setupTheme();\n setupScrollHandler();\n setupScrollSpy();\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Main entrypoint\n////////////////////////////////////////////////////////////////////////////////\nfunction main() {\n document.body.parentNode.classList.remove(\"no-js\");\n\n header = document.querySelector(\"header\");\n tocScroll = document.querySelector(\".toc-scroll\");\n\n setup();\n}\n\ndocument.addEventListener(\"DOMContentLoaded\", main);\n"],"names":["root","g","window","this","defaults","navClass","contentClass","nested","nestedClass","offset","reflow","events","emitEvent","type","elem","detail","settings","event","CustomEvent","bubbles","cancelable","dispatchEvent","getOffsetTop","location","offsetParent","offsetTop","sortContents","contents","sort","item1","item2","content","isInView","bottom","bounds","getBoundingClientRect","parseFloat","getOffset","parseInt","innerHeight","document","documentElement","clientHeight","top","isAtBottom","Math","ceil","pageYOffset","max","body","scrollHeight","offsetHeight","getActive","last","length","item","useLastItem","i","deactivateNested","nav","parentNode","li","closest","classList","remove","deactivate","items","link","activateNested","add","selector","options","navItems","current","timeout","publicAPIs","querySelectorAll","Array","prototype","forEach","call","getElementById","decodeURIComponent","hash","substr","push","active","activate","scrollHandler","cancelAnimationFrame","requestAnimationFrame","detect","resizeHandler","destroy","removeEventListener","merged","arguments","obj","key","hasOwnProperty","extend","setup","addEventListener","factory","__webpack_module_cache__","__webpack_require__","moduleId","cachedModule","undefined","exports","module","__webpack_modules__","n","getter","__esModule","d","a","definition","o","Object","defineProperty","enumerable","get","globalThis","Function","e","prop","tocScroll","header","lastScrollTop","scrollTop","cycleThemeOnce","currentTheme","localStorage","getItem","mode","matchMedia","matches","console","error","dataset","theme","setItem","log","buttons","getElementsByClassName","from","btn","setupTheme","last_known_scroll_position","ticking","scrollY","positionY","floor","scrollHandlerForBackToTop","scrollTo","querySelector","scrollHandlerForTOC","scroll","setupScrollHandler","recursive","rem","getComputedStyle","fontSize","height"],"sourceRoot":""} \ No newline at end of file diff --git a/docs/github/html/_static/searchtools.js b/docs/github/html/_static/searchtools.js deleted file mode 100644 index 97d56a7..0000000 --- a/docs/github/html/_static/searchtools.js +++ /dev/null @@ -1,566 +0,0 @@ -/* - * searchtools.js - * ~~~~~~~~~~~~~~~~ - * - * Sphinx JavaScript utilities for the full-text search. - * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ -"use strict"; - -/** - * Simple result scoring code. - */ -if (typeof Scorer === "undefined") { - var Scorer = { - // Implement the following function to further tweak the score for each result - // The function takes a result array [docname, title, anchor, descr, score, filename] - // and returns the new score. - /* - score: result => { - const [docname, title, anchor, descr, score, filename] = result - return score - }, - */ - - // query matches the full name of an object - objNameMatch: 11, - // or matches in the last dotted part of the object name - objPartialMatch: 6, - // Additive scores depending on the priority of the object - objPrio: { - 0: 15, // used to be importantResults - 1: 5, // used to be objectResults - 2: -5, // used to be unimportantResults - }, - // Used when the priority is not in the mapping. - objPrioDefault: 0, - - // query found in title - title: 15, - partialTitle: 7, - // query found in terms - term: 5, - partialTerm: 2, - }; -} - -const _removeChildren = (element) => { - while (element && element.lastChild) element.removeChild(element.lastChild); -}; - -/** - * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping - */ -const _escapeRegExp = (string) => - string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string - -const _displayItem = (item, searchTerms) => { - const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; - const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT; - const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; - const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; - const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; - - const [docName, title, anchor, descr, score, _filename] = item; - - let listItem = document.createElement("li"); - let requestUrl; - let linkUrl; - if (docBuilder === "dirhtml") { - // dirhtml builder - let dirname = docName + "/"; - if (dirname.match(/\/index\/$/)) - dirname = dirname.substring(0, dirname.length - 6); - else if (dirname === "index/") dirname = ""; - requestUrl = docUrlRoot + dirname; - linkUrl = requestUrl; - } else { - // normal html builders - requestUrl = docUrlRoot + docName + docFileSuffix; - linkUrl = docName + docLinkSuffix; - } - let linkEl = listItem.appendChild(document.createElement("a")); - linkEl.href = linkUrl + anchor; - linkEl.dataset.score = score; - linkEl.innerHTML = title; - if (descr) - listItem.appendChild(document.createElement("span")).innerHTML = - " (" + descr + ")"; - else if (showSearchSummary) - fetch(requestUrl) - .then((responseData) => responseData.text()) - .then((data) => { - if (data) - listItem.appendChild( - Search.makeSearchSummary(data, searchTerms) - ); - }); - Search.output.appendChild(listItem); -}; -const _finishSearch = (resultCount) => { - Search.stopPulse(); - Search.title.innerText = _("Search Results"); - if (!resultCount) - Search.status.innerText = Documentation.gettext( - "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." - ); - else - Search.status.innerText = _( - `Search finished, found ${resultCount} page(s) matching the search query.` - ); -}; -const _displayNextItem = ( - results, - resultCount, - searchTerms -) => { - // results left, load the summary and display it - // this is intended to be dynamic (don't sub resultsCount) - if (results.length) { - _displayItem(results.pop(), searchTerms); - setTimeout( - () => _displayNextItem(results, resultCount, searchTerms), - 5 - ); - } - // search finished, update title and status message - else _finishSearch(resultCount); -}; - -/** - * Default splitQuery function. Can be overridden in ``sphinx.search`` with a - * custom function per language. - * - * The regular expression works by splitting the string on consecutive characters - * that are not Unicode letters, numbers, underscores, or emoji characters. - * This is the same as ``\W+`` in Python, preserving the surrogate pair area. - */ -if (typeof splitQuery === "undefined") { - var splitQuery = (query) => query - .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) - .filter(term => term) // remove remaining empty strings -} - -/** - * Search Module - */ -const Search = { - _index: null, - _queued_query: null, - _pulse_status: -1, - - htmlToText: (htmlString) => { - const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); - htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); - const docContent = htmlElement.querySelector('[role="main"]'); - if (docContent !== undefined) return docContent.textContent; - console.warn( - "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." - ); - return ""; - }, - - init: () => { - const query = new URLSearchParams(window.location.search).get("q"); - document - .querySelectorAll('input[name="q"]') - .forEach((el) => (el.value = query)); - if (query) Search.performSearch(query); - }, - - loadIndex: (url) => - (document.body.appendChild(document.createElement("script")).src = url), - - setIndex: (index) => { - Search._index = index; - if (Search._queued_query !== null) { - const query = Search._queued_query; - Search._queued_query = null; - Search.query(query); - } - }, - - hasIndex: () => Search._index !== null, - - deferQuery: (query) => (Search._queued_query = query), - - stopPulse: () => (Search._pulse_status = -1), - - startPulse: () => { - if (Search._pulse_status >= 0) return; - - const pulse = () => { - Search._pulse_status = (Search._pulse_status + 1) % 4; - Search.dots.innerText = ".".repeat(Search._pulse_status); - if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); - }; - pulse(); - }, - - /** - * perform a search for something (or wait until index is loaded) - */ - performSearch: (query) => { - // create the required interface elements - const searchText = document.createElement("h2"); - searchText.textContent = _("Searching"); - const searchSummary = document.createElement("p"); - searchSummary.classList.add("search-summary"); - searchSummary.innerText = ""; - const searchList = document.createElement("ul"); - searchList.classList.add("search"); - - const out = document.getElementById("search-results"); - Search.title = out.appendChild(searchText); - Search.dots = Search.title.appendChild(document.createElement("span")); - Search.status = out.appendChild(searchSummary); - Search.output = out.appendChild(searchList); - - const searchProgress = document.getElementById("search-progress"); - // Some themes don't use the search progress node - if (searchProgress) { - searchProgress.innerText = _("Preparing search..."); - } - Search.startPulse(); - - // index already loaded, the browser was quick! - if (Search.hasIndex()) Search.query(query); - else Search.deferQuery(query); - }, - - /** - * execute search (requires search index to be loaded) - */ - query: (query) => { - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const titles = Search._index.titles; - const allTitles = Search._index.alltitles; - const indexEntries = Search._index.indexentries; - - // stem the search terms and add them to the correct list - const stemmer = new Stemmer(); - const searchTerms = new Set(); - const excludedTerms = new Set(); - const highlightTerms = new Set(); - const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); - splitQuery(query.trim()).forEach((queryTerm) => { - const queryTermLower = queryTerm.toLowerCase(); - - // maybe skip this "word" - // stopwords array is from language_data.js - if ( - stopwords.indexOf(queryTermLower) !== -1 || - queryTerm.match(/^\d+$/) - ) - return; - - // stem the word - let word = stemmer.stemWord(queryTermLower); - // select the correct list - if (word[0] === "-") excludedTerms.add(word.substr(1)); - else { - searchTerms.add(word); - highlightTerms.add(queryTermLower); - } - }); - - if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js - localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) - } - - // console.debug("SEARCH: searching for:"); - // console.info("required: ", [...searchTerms]); - // console.info("excluded: ", [...excludedTerms]); - - // array of [docname, title, anchor, descr, score, filename] - let results = []; - _removeChildren(document.getElementById("search-progress")); - - const queryLower = query.toLowerCase(); - for (const [title, foundTitles] of Object.entries(allTitles)) { - if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { - for (const [file, id] of foundTitles) { - let score = Math.round(100 * queryLower.length / title.length) - results.push([ - docNames[file], - titles[file] !== title ? `${titles[file]} > ${title}` : title, - id !== null ? "#" + id : "", - null, - score, - filenames[file], - ]); - } - } - } - - // search for explicit entries in index directives - for (const [entry, foundEntries] of Object.entries(indexEntries)) { - if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { - for (const [file, id] of foundEntries) { - let score = Math.round(100 * queryLower.length / entry.length) - results.push([ - docNames[file], - titles[file], - id ? "#" + id : "", - null, - score, - filenames[file], - ]); - } - } - } - - // lookup as object - objectTerms.forEach((term) => - results.push(...Search.performObjectSearch(term, objectTerms)) - ); - - // lookup as search terms in fulltext - results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); - - // let the scorer override scores with a custom scoring function - if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); - - // now sort the results by score (in opposite order of appearance, since the - // display function below uses pop() to retrieve items) and then - // alphabetically - results.sort((a, b) => { - const leftScore = a[4]; - const rightScore = b[4]; - if (leftScore === rightScore) { - // same score: sort alphabetically - const leftTitle = a[1].toLowerCase(); - const rightTitle = b[1].toLowerCase(); - if (leftTitle === rightTitle) return 0; - return leftTitle > rightTitle ? -1 : 1; // inverted is intentional - } - return leftScore > rightScore ? 1 : -1; - }); - - // remove duplicate search results - // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept - let seen = new Set(); - results = results.reverse().reduce((acc, result) => { - let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); - if (!seen.has(resultStr)) { - acc.push(result); - seen.add(resultStr); - } - return acc; - }, []); - - results = results.reverse(); - - // for debugging - //Search.lastresults = results.slice(); // a copy - // console.info("search results:", Search.lastresults); - - // print the results - _displayNextItem(results, results.length, searchTerms); - }, - - /** - * search for object names - */ - performObjectSearch: (object, objectTerms) => { - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const objects = Search._index.objects; - const objNames = Search._index.objnames; - const titles = Search._index.titles; - - const results = []; - - const objectSearchCallback = (prefix, match) => { - const name = match[4] - const fullname = (prefix ? prefix + "." : "") + name; - const fullnameLower = fullname.toLowerCase(); - if (fullnameLower.indexOf(object) < 0) return; - - let score = 0; - const parts = fullnameLower.split("."); - - // check for different match types: exact matches of full name or - // "last name" (i.e. last dotted part) - if (fullnameLower === object || parts.slice(-1)[0] === object) - score += Scorer.objNameMatch; - else if (parts.slice(-1)[0].indexOf(object) > -1) - score += Scorer.objPartialMatch; // matches in last name - - const objName = objNames[match[1]][2]; - const title = titles[match[0]]; - - // If more than one term searched for, we require other words to be - // found in the name/title/description - const otherTerms = new Set(objectTerms); - otherTerms.delete(object); - if (otherTerms.size > 0) { - const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); - if ( - [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) - ) - return; - } - - let anchor = match[3]; - if (anchor === "") anchor = fullname; - else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; - - const descr = objName + _(", in ") + title; - - // add custom score for some objects according to scorer - if (Scorer.objPrio.hasOwnProperty(match[2])) - score += Scorer.objPrio[match[2]]; - else score += Scorer.objPrioDefault; - - results.push([ - docNames[match[0]], - fullname, - "#" + anchor, - descr, - score, - filenames[match[0]], - ]); - }; - Object.keys(objects).forEach((prefix) => - objects[prefix].forEach((array) => - objectSearchCallback(prefix, array) - ) - ); - return results; - }, - - /** - * search for full-text terms in the index - */ - performTermsSearch: (searchTerms, excludedTerms) => { - // prepare search - const terms = Search._index.terms; - const titleTerms = Search._index.titleterms; - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const titles = Search._index.titles; - - const scoreMap = new Map(); - const fileMap = new Map(); - - // perform the search on the required terms - searchTerms.forEach((word) => { - const files = []; - const arr = [ - { files: terms[word], score: Scorer.term }, - { files: titleTerms[word], score: Scorer.title }, - ]; - // add support for partial matches - if (word.length > 2) { - const escapedWord = _escapeRegExp(word); - Object.keys(terms).forEach((term) => { - if (term.match(escapedWord) && !terms[word]) - arr.push({ files: terms[term], score: Scorer.partialTerm }); - }); - Object.keys(titleTerms).forEach((term) => { - if (term.match(escapedWord) && !titleTerms[word]) - arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); - }); - } - - // no match but word was a required one - if (arr.every((record) => record.files === undefined)) return; - - // found search word in contents - arr.forEach((record) => { - if (record.files === undefined) return; - - let recordFiles = record.files; - if (recordFiles.length === undefined) recordFiles = [recordFiles]; - files.push(...recordFiles); - - // set score for the word in each file - recordFiles.forEach((file) => { - if (!scoreMap.has(file)) scoreMap.set(file, {}); - scoreMap.get(file)[word] = record.score; - }); - }); - - // create the mapping - files.forEach((file) => { - if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) - fileMap.get(file).push(word); - else fileMap.set(file, [word]); - }); - }); - - // now check if the files don't contain excluded terms - const results = []; - for (const [file, wordList] of fileMap) { - // check if all requirements are matched - - // as search terms with length < 3 are discarded - const filteredTermCount = [...searchTerms].filter( - (term) => term.length > 2 - ).length; - if ( - wordList.length !== searchTerms.size && - wordList.length !== filteredTermCount - ) - continue; - - // ensure that none of the excluded terms is in the search result - if ( - [...excludedTerms].some( - (term) => - terms[term] === file || - titleTerms[term] === file || - (terms[term] || []).includes(file) || - (titleTerms[term] || []).includes(file) - ) - ) - break; - - // select one (max) score for the file. - const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); - // add result to the result list - results.push([ - docNames[file], - titles[file], - "", - null, - score, - filenames[file], - ]); - } - return results; - }, - - /** - * helper function to return a node containing the - * search summary for a given text. keywords is a list - * of stemmed words. - */ - makeSearchSummary: (htmlText, keywords) => { - const text = Search.htmlToText(htmlText); - if (text === "") return null; - - const textLower = text.toLowerCase(); - const actualStartPosition = [...keywords] - .map((k) => textLower.indexOf(k.toLowerCase())) - .filter((i) => i > -1) - .slice(-1)[0]; - const startWithContext = Math.max(actualStartPosition - 120, 0); - - const top = startWithContext === 0 ? "" : "..."; - const tail = startWithContext + 240 < text.length ? "..." : ""; - - let summary = document.createElement("p"); - summary.classList.add("context"); - summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; - - return summary; - }, -}; - -_ready(Search.init); diff --git a/docs/github/html/_static/skeleton.css b/docs/github/html/_static/skeleton.css deleted file mode 100644 index 467c878..0000000 --- a/docs/github/html/_static/skeleton.css +++ /dev/null @@ -1,296 +0,0 @@ -/* Some sane resets. */ -html { - height: 100%; -} - -body { - margin: 0; - min-height: 100%; -} - -/* All the flexbox magic! */ -body, -.sb-announcement, -.sb-content, -.sb-main, -.sb-container, -.sb-container__inner, -.sb-article-container, -.sb-footer-content, -.sb-header, -.sb-header-secondary, -.sb-footer { - display: flex; -} - -/* These order things vertically */ -body, -.sb-main, -.sb-article-container { - flex-direction: column; -} - -/* Put elements in the center */ -.sb-header, -.sb-header-secondary, -.sb-container, -.sb-content, -.sb-footer, -.sb-footer-content { - justify-content: center; -} -/* Put elements at the ends */ -.sb-article-container { - justify-content: space-between; -} - -/* These elements grow. */ -.sb-main, -.sb-content, -.sb-container, -article { - flex-grow: 1; -} - -/* Because padding making this wider is not fun */ -article { - box-sizing: border-box; -} - -/* The announcements element should never be wider than the page. */ -.sb-announcement { - max-width: 100%; -} - -.sb-sidebar-primary, -.sb-sidebar-secondary { - flex-shrink: 0; - width: 17rem; -} - -.sb-announcement__inner { - justify-content: center; - - box-sizing: border-box; - height: 3rem; - - overflow-x: auto; - white-space: nowrap; -} - -/* Sidebars, with checkbox-based toggle */ -.sb-sidebar-primary, -.sb-sidebar-secondary { - position: fixed; - height: 100%; - top: 0; -} - -.sb-sidebar-primary { - left: -17rem; - transition: left 250ms ease-in-out; -} -.sb-sidebar-secondary { - right: -17rem; - transition: right 250ms ease-in-out; -} - -.sb-sidebar-toggle { - display: none; -} -.sb-sidebar-overlay { - position: fixed; - top: 0; - width: 0; - height: 0; - - transition: width 0ms ease 250ms, height 0ms ease 250ms, opacity 250ms ease; - - opacity: 0; - background-color: rgba(0, 0, 0, 0.54); -} - -#sb-sidebar-toggle--primary:checked - ~ .sb-sidebar-overlay[for="sb-sidebar-toggle--primary"], -#sb-sidebar-toggle--secondary:checked - ~ .sb-sidebar-overlay[for="sb-sidebar-toggle--secondary"] { - width: 100%; - height: 100%; - opacity: 1; - transition: width 0ms ease, height 0ms ease, opacity 250ms ease; -} - -#sb-sidebar-toggle--primary:checked ~ .sb-container .sb-sidebar-primary { - left: 0; -} -#sb-sidebar-toggle--secondary:checked ~ .sb-container .sb-sidebar-secondary { - right: 0; -} - -/* Full-width mode */ -.drop-secondary-sidebar-for-full-width-content - .hide-when-secondary-sidebar-shown { - display: none !important; -} -.drop-secondary-sidebar-for-full-width-content .sb-sidebar-secondary { - display: none !important; -} - -/* Mobile views */ -.sb-page-width { - width: 100%; -} - -.sb-article-container, -.sb-footer-content__inner, -.drop-secondary-sidebar-for-full-width-content .sb-article, -.drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 100vw; -} - -.sb-article, -.match-content-width { - padding: 0 1rem; - box-sizing: border-box; -} - -@media (min-width: 32rem) { - .sb-article, - .match-content-width { - padding: 0 2rem; - } -} - -/* Tablet views */ -@media (min-width: 42rem) { - .sb-article-container { - width: auto; - } - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 42rem; - } - .sb-article, - .match-content-width { - width: 42rem; - } -} -@media (min-width: 46rem) { - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 46rem; - } - .sb-article, - .match-content-width { - width: 46rem; - } -} -@media (min-width: 50rem) { - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 50rem; - } - .sb-article, - .match-content-width { - width: 50rem; - } -} - -/* Tablet views */ -@media (min-width: 59rem) { - .sb-sidebar-secondary { - position: static; - } - .hide-when-secondary-sidebar-shown { - display: none !important; - } - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 59rem; - } - .sb-article, - .match-content-width { - width: 42rem; - } -} -@media (min-width: 63rem) { - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 63rem; - } - .sb-article, - .match-content-width { - width: 46rem; - } -} -@media (min-width: 67rem) { - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 67rem; - } - .sb-article, - .match-content-width { - width: 50rem; - } -} - -/* Desktop views */ -@media (min-width: 76rem) { - .sb-sidebar-primary { - position: static; - } - .hide-when-primary-sidebar-shown { - display: none !important; - } - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 59rem; - } - .sb-article, - .match-content-width { - width: 42rem; - } -} - -/* Full desktop views */ -@media (min-width: 80rem) { - .sb-article, - .match-content-width { - width: 46rem; - } - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 63rem; - } -} - -@media (min-width: 84rem) { - .sb-article, - .match-content-width { - width: 50rem; - } - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 67rem; - } -} - -@media (min-width: 88rem) { - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 67rem; - } - .sb-page-width { - width: 88rem; - } -} diff --git a/docs/github/html/_static/sphinx_highlight.js b/docs/github/html/_static/sphinx_highlight.js deleted file mode 100644 index aae669d..0000000 --- a/docs/github/html/_static/sphinx_highlight.js +++ /dev/null @@ -1,144 +0,0 @@ -/* Highlighting utilities for Sphinx HTML documentation. */ -"use strict"; - -const SPHINX_HIGHLIGHT_ENABLED = true - -/** - * highlight a given string on a node by wrapping it in - * span elements with the given class name. - */ -const _highlight = (node, addItems, text, className) => { - if (node.nodeType === Node.TEXT_NODE) { - const val = node.nodeValue; - const parent = node.parentNode; - const pos = val.toLowerCase().indexOf(text); - if ( - pos >= 0 && - !parent.classList.contains(className) && - !parent.classList.contains("nohighlight") - ) { - let span; - - const closestNode = parent.closest("body, svg, foreignObject"); - const isInSVG = closestNode && closestNode.matches("svg"); - if (isInSVG) { - span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); - } else { - span = document.createElement("span"); - span.classList.add(className); - } - - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - parent.insertBefore( - span, - parent.insertBefore( - document.createTextNode(val.substr(pos + text.length)), - node.nextSibling - ) - ); - node.nodeValue = val.substr(0, pos); - - if (isInSVG) { - const rect = document.createElementNS( - "http://www.w3.org/2000/svg", - "rect" - ); - const bbox = parent.getBBox(); - rect.x.baseVal.value = bbox.x; - rect.y.baseVal.value = bbox.y; - rect.width.baseVal.value = bbox.width; - rect.height.baseVal.value = bbox.height; - rect.setAttribute("class", className); - addItems.push({ parent: parent, target: rect }); - } - } - } else if (node.matches && !node.matches("button, select, textarea")) { - node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); - } -}; -const _highlightText = (thisNode, text, className) => { - let addItems = []; - _highlight(thisNode, addItems, text, className); - addItems.forEach((obj) => - obj.parent.insertAdjacentElement("beforebegin", obj.target) - ); -}; - -/** - * Small JavaScript module for the documentation. - */ -const SphinxHighlight = { - - /** - * highlight the search words provided in localstorage in the text - */ - highlightSearchWords: () => { - if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight - - // get and clear terms from localstorage - const url = new URL(window.location); - const highlight = - localStorage.getItem("sphinx_highlight_terms") - || url.searchParams.get("highlight") - || ""; - localStorage.removeItem("sphinx_highlight_terms") - url.searchParams.delete("highlight"); - window.history.replaceState({}, "", url); - - // get individual terms from highlight string - const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); - if (terms.length === 0) return; // nothing to do - - // There should never be more than one element matching "div.body" - const divBody = document.querySelectorAll("div.body"); - const body = divBody.length ? divBody[0] : document.querySelector("body"); - window.setTimeout(() => { - terms.forEach((term) => _highlightText(body, term, "highlighted")); - }, 10); - - const searchBox = document.getElementById("searchbox"); - if (searchBox === null) return; - searchBox.appendChild( - document - .createRange() - .createContextualFragment( - '

' + - '' + - _("Hide Search Matches") + - "

" - ) - ); - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords: () => { - document - .querySelectorAll("#searchbox .highlight-link") - .forEach((el) => el.remove()); - document - .querySelectorAll("span.highlighted") - .forEach((el) => el.classList.remove("highlighted")); - localStorage.removeItem("sphinx_highlight_terms") - }, - - initEscapeListener: () => { - // only install a listener if it is really needed - if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; - - document.addEventListener("keydown", (event) => { - // bail for input elements - if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; - // bail with special keys - if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; - if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { - SphinxHighlight.hideSearchWords(); - event.preventDefault(); - } - }); - }, -}; - -_ready(SphinxHighlight.highlightSearchWords); -_ready(SphinxHighlight.initEscapeListener); diff --git a/docs/github/html/_static/styles/furo-extensions.css b/docs/github/html/_static/styles/furo-extensions.css deleted file mode 100644 index bc447f2..0000000 --- a/docs/github/html/_static/styles/furo-extensions.css +++ /dev/null @@ -1,2 +0,0 @@ -#furo-sidebar-ad-placement{padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)}#furo-sidebar-ad-placement .ethical-sidebar{background:var(--color-background-secondary);border:none;box-shadow:none}#furo-sidebar-ad-placement .ethical-sidebar:hover{background:var(--color-background-hover)}#furo-sidebar-ad-placement .ethical-sidebar a{color:var(--color-foreground-primary)}#furo-sidebar-ad-placement .ethical-callout a{color:var(--color-foreground-secondary)!important}#furo-readthedocs-versions{background:transparent;display:block;position:static;width:100%}#furo-readthedocs-versions .rst-versions{background:#1a1c1e}#furo-readthedocs-versions .rst-current-version{background:var(--color-sidebar-item-background);cursor:unset}#furo-readthedocs-versions .rst-current-version:hover{background:var(--color-sidebar-item-background)}#furo-readthedocs-versions .rst-current-version .fa-book{color:var(--color-foreground-primary)}#furo-readthedocs-versions>.rst-other-versions{padding:0}#furo-readthedocs-versions>.rst-other-versions small{opacity:1}#furo-readthedocs-versions .injected .rst-versions{position:unset}#furo-readthedocs-versions:focus-within,#furo-readthedocs-versions:hover{box-shadow:0 0 0 1px var(--color-sidebar-background-border)}#furo-readthedocs-versions:focus-within .rst-current-version,#furo-readthedocs-versions:hover .rst-current-version{background:#1a1c1e;font-size:inherit;height:auto;line-height:inherit;padding:12px;text-align:right}#furo-readthedocs-versions:focus-within .rst-current-version .fa-book,#furo-readthedocs-versions:hover .rst-current-version .fa-book{color:#fff;float:left}#furo-readthedocs-versions:focus-within .fa-caret-down,#furo-readthedocs-versions:hover .fa-caret-down{display:none}#furo-readthedocs-versions:focus-within .injected,#furo-readthedocs-versions:focus-within .rst-current-version,#furo-readthedocs-versions:focus-within .rst-other-versions,#furo-readthedocs-versions:hover .injected,#furo-readthedocs-versions:hover .rst-current-version,#furo-readthedocs-versions:hover .rst-other-versions{display:block}#furo-readthedocs-versions:focus-within>.rst-current-version,#furo-readthedocs-versions:hover>.rst-current-version{display:none}.highlight:hover button.copybtn{color:var(--color-code-foreground)}.highlight button.copybtn{align-items:center;background-color:var(--color-code-background);border:none;color:var(--color-background-item);cursor:pointer;height:1.25em;opacity:1;right:.5rem;top:.625rem;transition:color .3s,opacity .3s;width:1.25em}.highlight button.copybtn:hover{background-color:var(--color-code-background);color:var(--color-brand-content)}.highlight button.copybtn:after{background-color:transparent;color:var(--color-code-foreground);display:none}.highlight button.copybtn.success{color:#22863a;transition:color 0ms}.highlight button.copybtn.success:after{display:block}.highlight button.copybtn svg{padding:0}body{--sd-color-primary:var(--color-brand-primary);--sd-color-primary-highlight:var(--color-brand-content);--sd-color-primary-text:var(--color-background-primary);--sd-color-shadow:rgba(0,0,0,.05);--sd-color-card-border:var(--color-card-border);--sd-color-card-border-hover:var(--color-brand-content);--sd-color-card-background:var(--color-card-background);--sd-color-card-text:var(--color-foreground-primary);--sd-color-card-header:var(--color-card-marginals-background);--sd-color-card-footer:var(--color-card-marginals-background);--sd-color-tabs-label-active:var(--color-brand-content);--sd-color-tabs-label-hover:var(--color-foreground-muted);--sd-color-tabs-label-inactive:var(--color-foreground-muted);--sd-color-tabs-underline-active:var(--color-brand-content);--sd-color-tabs-underline-hover:var(--color-foreground-border);--sd-color-tabs-underline-inactive:var(--color-background-border);--sd-color-tabs-overline:var(--color-background-border);--sd-color-tabs-underline:var(--color-background-border)}.sd-tab-content{box-shadow:0 -2px var(--sd-color-tabs-overline),0 1px var(--sd-color-tabs-underline)}.sd-card{box-shadow:0 .1rem .25rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)}.sd-shadow-sm{box-shadow:0 .1rem .25rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-shadow-md{box-shadow:0 .3rem .75rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-shadow-lg{box-shadow:0 .6rem 1.5rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-card-hover:hover{transform:none}.sd-cards-carousel{gap:.25rem;padding:.25rem}body{--tabs--label-text:var(--color-foreground-muted);--tabs--label-text--hover:var(--color-foreground-muted);--tabs--label-text--active:var(--color-brand-content);--tabs--label-text--active--hover:var(--color-brand-content);--tabs--label-background:transparent;--tabs--label-background--hover:transparent;--tabs--label-background--active:transparent;--tabs--label-background--active--hover:transparent;--tabs--padding-x:0.25em;--tabs--margin-x:1em;--tabs--border:var(--color-background-border);--tabs--label-border:transparent;--tabs--label-border--hover:var(--color-foreground-muted);--tabs--label-border--active:var(--color-brand-content);--tabs--label-border--active--hover:var(--color-brand-content)}[role=main] .container{max-width:none;padding-left:0;padding-right:0}.shadow.docutils{border:none;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1)!important}.sphinx-bs .card{background-color:var(--color-background-secondary);color:var(--color-foreground)} -/*# sourceMappingURL=furo-extensions.css.map*/ \ No newline at end of file diff --git a/docs/github/html/_static/styles/furo-extensions.css.map b/docs/github/html/_static/styles/furo-extensions.css.map deleted file mode 100644 index 9ba5637..0000000 --- a/docs/github/html/_static/styles/furo-extensions.css.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"styles/furo-extensions.css","mappings":"AAGA,2BACE,oFACA,4CAKE,6CAHA,YACA,eAEA,CACA,kDACE,yCAEF,8CACE,sCAEJ,8CACE,kDAEJ,2BAGE,uBACA,cAHA,gBACA,UAEA,CAGA,yCACE,mBAEF,gDAEE,gDADA,YACA,CACA,sDACE,gDACF,yDACE,sCAEJ,+CACE,UACA,qDACE,UAGF,mDACE,eAEJ,yEAEE,4DAEA,mHASE,mBAPA,kBAEA,YADA,oBAGA,aADA,gBAIA,CAEA,qIAEE,WADA,UACA,CAEJ,uGACE,aAEF,iUAGE,cAEF,mHACE,aC1EJ,gCACE,mCAEF,0BAKE,mBAUA,8CACA,YAFA,mCAKA,eAZA,cALA,UASA,YADA,YAYA,iCAdA,YAcA,CAEA,gCAEE,8CADA,gCACA,CAEF,gCAGE,6BADA,mCADA,YAEA,CAEF,kCAEE,cADA,oBACA,CACA,wCACE,cAEJ,8BACE,UC5CN,KAEE,6CAA8C,CAC9C,uDAAwD,CACxD,uDAAwD,CAGxD,iCAAsC,CAGtC,+CAAgD,CAChD,uDAAwD,CACxD,uDAAwD,CACxD,oDAAqD,CACrD,6DAA8D,CAC9D,6DAA8D,CAG9D,uDAAwD,CACxD,yDAA0D,CAC1D,4DAA6D,CAC7D,2DAA4D,CAC5D,8DAA+D,CAC/D,iEAAkE,CAClE,uDAAwD,CACxD,wDAAyD,CAG3D,gBACE,qFAGF,SACE,6EAEF,cACE,uFAEF,cACE,uFAEF,cACE,uFAGF,qBACE,eAEF,mBACE,WACA,eChDF,KACE,gDAAiD,CACjD,uDAAwD,CACxD,qDAAsD,CACtD,4DAA6D,CAC7D,oCAAqC,CACrC,2CAA4C,CAC5C,4CAA6C,CAC7C,mDAAoD,CACpD,wBAAyB,CACzB,oBAAqB,CACrB,6CAA8C,CAC9C,gCAAiC,CACjC,yDAA0D,CAC1D,uDAAwD,CACxD,8DAA+D,CCbjE,uBACE,eACA,eACA,gBAGF,iBACE,YACA,+EAGF,iBACE,mDACA","sources":["webpack:///./src/furo/assets/styles/extensions/_readthedocs.sass","webpack:///./src/furo/assets/styles/extensions/_copybutton.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-design.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-inline-tabs.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-panels.sass"],"sourcesContent":["// This file contains the styles used for tweaking how ReadTheDoc's embedded\n// contents would show up inside the theme.\n\n#furo-sidebar-ad-placement\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n .ethical-sidebar\n // Remove the border and box-shadow.\n border: none\n box-shadow: none\n // Manage the background colors.\n background: var(--color-background-secondary)\n &:hover\n background: var(--color-background-hover)\n // Ensure the text is legible.\n a\n color: var(--color-foreground-primary)\n\n .ethical-callout a\n color: var(--color-foreground-secondary) !important\n\n#furo-readthedocs-versions\n position: static\n width: 100%\n background: transparent\n display: block\n\n // Make the background color fit with the theme's aesthetic.\n .rst-versions\n background: rgb(26, 28, 30)\n\n .rst-current-version\n cursor: unset\n background: var(--color-sidebar-item-background)\n &:hover\n background: var(--color-sidebar-item-background)\n .fa-book\n color: var(--color-foreground-primary)\n\n > .rst-other-versions\n padding: 0\n small\n opacity: 1\n\n .injected\n .rst-versions\n position: unset\n\n &:hover,\n &:focus-within\n box-shadow: 0 0 0 1px var(--color-sidebar-background-border)\n\n .rst-current-version\n // Undo the tweaks done in RTD's CSS\n font-size: inherit\n line-height: inherit\n height: auto\n text-align: right\n padding: 12px\n\n // Match the rest of the body\n background: #1a1c1e\n\n .fa-book\n float: left\n color: white\n\n .fa-caret-down\n display: none\n\n .rst-current-version,\n .rst-other-versions,\n .injected\n display: block\n\n > .rst-current-version\n display: none\n",".highlight\n &:hover button.copybtn\n color: var(--color-code-foreground)\n\n button.copybtn\n // Make it visible\n opacity: 1\n\n // Align things correctly\n align-items: center\n\n height: 1.25em\n width: 1.25em\n\n top: 0.625rem // $code-spacing-vertical\n right: 0.5rem\n\n // Make it look better\n color: var(--color-background-item)\n background-color: var(--color-code-background)\n border: none\n\n // Change to cursor to make it obvious that you can click on it\n cursor: pointer\n\n // Transition smoothly, for aesthetics\n transition: color 300ms, opacity 300ms\n\n &:hover\n color: var(--color-brand-content)\n background-color: var(--color-code-background)\n\n &::after\n display: none\n color: var(--color-code-foreground)\n background-color: transparent\n\n &.success\n transition: color 0ms\n color: #22863a\n &::after\n display: block\n\n svg\n padding: 0\n","body\n // Colors\n --sd-color-primary: var(--color-brand-primary)\n --sd-color-primary-highlight: var(--color-brand-content)\n --sd-color-primary-text: var(--color-background-primary)\n\n // Shadows\n --sd-color-shadow: rgba(0, 0, 0, 0.05)\n\n // Cards\n --sd-color-card-border: var(--color-card-border)\n --sd-color-card-border-hover: var(--color-brand-content)\n --sd-color-card-background: var(--color-card-background)\n --sd-color-card-text: var(--color-foreground-primary)\n --sd-color-card-header: var(--color-card-marginals-background)\n --sd-color-card-footer: var(--color-card-marginals-background)\n\n // Tabs\n --sd-color-tabs-label-active: var(--color-brand-content)\n --sd-color-tabs-label-hover: var(--color-foreground-muted)\n --sd-color-tabs-label-inactive: var(--color-foreground-muted)\n --sd-color-tabs-underline-active: var(--color-brand-content)\n --sd-color-tabs-underline-hover: var(--color-foreground-border)\n --sd-color-tabs-underline-inactive: var(--color-background-border)\n --sd-color-tabs-overline: var(--color-background-border)\n --sd-color-tabs-underline: var(--color-background-border)\n\n// Tabs\n.sd-tab-content\n box-shadow: 0 -2px var(--sd-color-tabs-overline), 0 1px var(--sd-color-tabs-underline)\n\n// Shadows\n.sd-card // Have a shadow by default\n box-shadow: 0 0.1rem 0.25rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1)\n\n.sd-shadow-sm\n box-shadow: 0 0.1rem 0.25rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n.sd-shadow-md\n box-shadow: 0 0.3rem 0.75rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n.sd-shadow-lg\n box-shadow: 0 0.6rem 1.5rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n// Cards\n.sd-card-hover:hover // Don't change scale on hover\n transform: none\n\n.sd-cards-carousel // Have a bit of gap in the carousel by default\n gap: 0.25rem\n padding: 0.25rem\n","// This file contains styles to tweak sphinx-inline-tabs to work well with Furo.\n\nbody\n --tabs--label-text: var(--color-foreground-muted)\n --tabs--label-text--hover: var(--color-foreground-muted)\n --tabs--label-text--active: var(--color-brand-content)\n --tabs--label-text--active--hover: var(--color-brand-content)\n --tabs--label-background: transparent\n --tabs--label-background--hover: transparent\n --tabs--label-background--active: transparent\n --tabs--label-background--active--hover: transparent\n --tabs--padding-x: 0.25em\n --tabs--margin-x: 1em\n --tabs--border: var(--color-background-border)\n --tabs--label-border: transparent\n --tabs--label-border--hover: var(--color-foreground-muted)\n --tabs--label-border--active: var(--color-brand-content)\n --tabs--label-border--active--hover: var(--color-brand-content)\n","// This file contains styles to tweak sphinx-panels to work well with Furo.\n\n// sphinx-panels includes Bootstrap 4, which uses .container which can conflict\n// with docutils' `.. container::` directive.\n[role=\"main\"] .container\n max-width: initial\n padding-left: initial\n padding-right: initial\n\n// Make the panels look nicer!\n.shadow.docutils\n border: none\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n// Make panel colors respond to dark mode\n.sphinx-bs .card\n background-color: var(--color-background-secondary)\n color: var(--color-foreground)\n"],"names":[],"sourceRoot":""} \ No newline at end of file diff --git a/docs/github/html/_static/styles/furo.css b/docs/github/html/_static/styles/furo.css deleted file mode 100644 index 6a887ad..0000000 --- a/docs/github/html/_static/styles/furo.css +++ /dev/null @@ -1,2 +0,0 @@ -/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */html{-webkit-text-size-adjust:100%;line-height:1.15}body{margin:0}main{display:block}h1{font-size:2em;margin:.67em 0}hr{box-sizing:content-box;height:0;overflow:visible}pre{font-family:monospace,monospace;font-size:1em}a{background-color:transparent}abbr[title]{border-bottom:none;text-decoration:underline;text-decoration:underline dotted}b,strong{font-weight:bolder}code,kbd,samp{font-family:monospace,monospace;font-size:1em}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}img{border-style:none}button,input,optgroup,select,textarea{font-family:inherit;font-size:100%;line-height:1.15;margin:0}button,input{overflow:visible}button,select{text-transform:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner,button::-moz-focus-inner{border-style:none;padding:0}[type=button]:-moz-focusring,[type=reset]:-moz-focusring,[type=submit]:-moz-focusring,button:-moz-focusring{outline:1px dotted ButtonText}fieldset{padding:.35em .75em .625em}legend{box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{vertical-align:baseline}textarea{overflow:auto}[type=checkbox],[type=radio]{box-sizing:border-box;padding:0}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}details{display:block}summary{display:list-item}[hidden],template{display:none}@media print{.content-icon-container,.headerlink,.mobile-header,.related-pages{display:none!important}.highlight{border:.1pt solid var(--color-foreground-border)}a,blockquote,dl,ol,pre,table,ul{page-break-inside:avoid}caption,figure,h1,h2,h3,h4,h5,h6,img{page-break-after:avoid;page-break-inside:avoid}dl,ol,ul{page-break-before:avoid}}.visually-hidden{clip:rect(0,0,0,0)!important;border:0!important;height:1px!important;margin:-1px!important;overflow:hidden!important;padding:0!important;position:absolute!important;white-space:nowrap!important;width:1px!important}:-moz-focusring{outline:auto}body{--font-stack:-apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji;--font-stack--monospace:"SFMono-Regular",Menlo,Consolas,Monaco,Liberation Mono,Lucida Console,monospace;--font-size--normal:100%;--font-size--small:87.5%;--font-size--small--2:81.25%;--font-size--small--3:75%;--font-size--small--4:62.5%;--sidebar-caption-font-size:var(--font-size--small--2);--sidebar-item-font-size:var(--font-size--small);--sidebar-search-input-font-size:var(--font-size--small);--toc-font-size:var(--font-size--small--3);--toc-font-size--mobile:var(--font-size--normal);--toc-title-font-size:var(--font-size--small--4);--admonition-font-size:0.8125rem;--admonition-title-font-size:0.8125rem;--code-font-size:var(--font-size--small--2);--api-font-size:var(--font-size--small);--header-height:calc(var(--sidebar-item-line-height) + var(--sidebar-item-spacing-vertical)*4);--header-padding:0.5rem;--sidebar-tree-space-above:1.5rem;--sidebar-caption-space-above:1rem;--sidebar-item-line-height:1rem;--sidebar-item-spacing-vertical:0.5rem;--sidebar-item-spacing-horizontal:1rem;--sidebar-item-height:calc(var(--sidebar-item-line-height) + var(--sidebar-item-spacing-vertical)*2);--sidebar-expander-width:var(--sidebar-item-height);--sidebar-search-space-above:0.5rem;--sidebar-search-input-spacing-vertical:0.5rem;--sidebar-search-input-spacing-horizontal:0.5rem;--sidebar-search-input-height:1rem;--sidebar-search-icon-size:var(--sidebar-search-input-height);--toc-title-padding:0.25rem 0;--toc-spacing-vertical:1.5rem;--toc-spacing-horizontal:1.5rem;--toc-item-spacing-vertical:0.4rem;--toc-item-spacing-horizontal:1rem;--icon-search:url('data:image/svg+xml;charset=utf-8,');--icon-pencil:url('data:image/svg+xml;charset=utf-8,');--icon-abstract:url('data:image/svg+xml;charset=utf-8,');--icon-info:url('data:image/svg+xml;charset=utf-8,');--icon-flame:url('data:image/svg+xml;charset=utf-8,');--icon-question:url('data:image/svg+xml;charset=utf-8,');--icon-warning:url('data:image/svg+xml;charset=utf-8,');--icon-failure:url('data:image/svg+xml;charset=utf-8,');--icon-spark:url('data:image/svg+xml;charset=utf-8,');--color-admonition-title--caution:#ff9100;--color-admonition-title-background--caution:rgba(255,145,0,.1);--color-admonition-title--warning:#ff9100;--color-admonition-title-background--warning:rgba(255,145,0,.1);--color-admonition-title--danger:#ff5252;--color-admonition-title-background--danger:rgba(255,82,82,.1);--color-admonition-title--attention:#ff5252;--color-admonition-title-background--attention:rgba(255,82,82,.1);--color-admonition-title--error:#ff5252;--color-admonition-title-background--error:rgba(255,82,82,.1);--color-admonition-title--hint:#00c852;--color-admonition-title-background--hint:rgba(0,200,82,.1);--color-admonition-title--tip:#00c852;--color-admonition-title-background--tip:rgba(0,200,82,.1);--color-admonition-title--important:#00bfa5;--color-admonition-title-background--important:rgba(0,191,165,.1);--color-admonition-title--note:#00b0ff;--color-admonition-title-background--note:rgba(0,176,255,.1);--color-admonition-title--seealso:#448aff;--color-admonition-title-background--seealso:rgba(68,138,255,.1);--color-admonition-title--admonition-todo:grey;--color-admonition-title-background--admonition-todo:hsla(0,0%,50%,.1);--color-admonition-title:#651fff;--color-admonition-title-background:rgba(101,31,255,.1);--icon-admonition-default:var(--icon-abstract);--color-topic-title:#14b8a6;--color-topic-title-background:rgba(20,184,166,.1);--icon-topic-default:var(--icon-pencil);--color-problematic:#b30000;--color-foreground-primary:#000;--color-foreground-secondary:#5a5c63;--color-foreground-muted:#646776;--color-foreground-border:#878787;--color-background-primary:#fff;--color-background-secondary:#f8f9fb;--color-background-hover:#efeff4;--color-background-hover--transparent:#efeff400;--color-background-border:#eeebee;--color-background-item:#ccc;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#2962ff;--color-brand-content:#2a5adf;--color-api-background:var(--color-background-secondary);--color-api-background-hover:var(--color-background-hover);--color-api-overall:var(--color-foreground-secondary);--color-api-name:var(--color-problematic);--color-api-pre-name:var(--color-problematic);--color-api-paren:var(--color-foreground-secondary);--color-api-keyword:var(--color-foreground-primary);--color-highlight-on-target:#ffc;--color-inline-code-background:var(--color-background-secondary);--color-highlighted-background:#def;--color-highlighted-text:var(--color-foreground-primary);--color-guilabel-background:#ddeeff80;--color-guilabel-border:#bedaf580;--color-guilabel-text:var(--color-foreground-primary);--color-admonition-background:transparent;--color-table-header-background:var(--color-background-secondary);--color-table-border:var(--color-background-border);--color-card-border:var(--color-background-secondary);--color-card-background:transparent;--color-card-marginals-background:var(--color-background-secondary);--color-header-background:var(--color-background-primary);--color-header-border:var(--color-background-border);--color-header-text:var(--color-foreground-primary);--color-sidebar-background:var(--color-background-secondary);--color-sidebar-background-border:var(--color-background-border);--color-sidebar-brand-text:var(--color-foreground-primary);--color-sidebar-caption-text:var(--color-foreground-muted);--color-sidebar-link-text:var(--color-foreground-secondary);--color-sidebar-link-text--top-level:var(--color-brand-primary);--color-sidebar-item-background:var(--color-sidebar-background);--color-sidebar-item-background--current:var( --color-sidebar-item-background );--color-sidebar-item-background--hover:linear-gradient(90deg,var(--color-background-hover--transparent) 0%,var(--color-background-hover) var(--sidebar-item-spacing-horizontal),var(--color-background-hover) 100%);--color-sidebar-item-expander-background:transparent;--color-sidebar-item-expander-background--hover:var( --color-background-hover );--color-sidebar-search-text:var(--color-foreground-primary);--color-sidebar-search-background:var(--color-background-secondary);--color-sidebar-search-background--focus:var(--color-background-primary);--color-sidebar-search-border:var(--color-background-border);--color-sidebar-search-icon:var(--color-foreground-muted);--color-toc-background:var(--color-background-primary);--color-toc-title-text:var(--color-foreground-muted);--color-toc-item-text:var(--color-foreground-secondary);--color-toc-item-text--hover:var(--color-foreground-primary);--color-toc-item-text--active:var(--color-brand-primary);--color-content-foreground:var(--color-foreground-primary);--color-content-background:transparent;--color-link:var(--color-brand-content);--color-link--hover:var(--color-brand-content);--color-link-underline:var(--color-background-border);--color-link-underline--hover:var(--color-foreground-border)}.only-light{display:block!important}html body .only-dark{display:none!important}@media not print{body[data-theme=dark]{--color-problematic:#ee5151;--color-foreground-primary:#ffffffcc;--color-foreground-secondary:#9ca0a5;--color-foreground-muted:#81868d;--color-foreground-border:#666;--color-background-primary:#131416;--color-background-secondary:#1a1c1e;--color-background-hover:#1e2124;--color-background-hover--transparent:#1e212400;--color-background-border:#303335;--color-background-item:#444;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#2b8cee;--color-brand-content:#368ce2;--color-highlighted-background:#083563;--color-guilabel-background:#08356380;--color-guilabel-border:#13395f80;--color-api-keyword:var(--color-foreground-secondary);--color-highlight-on-target:#330;--color-admonition-background:#18181a;--color-card-border:var(--color-background-secondary);--color-card-background:#18181a;--color-card-marginals-background:var(--color-background-hover)}html body[data-theme=dark] .only-light{display:none!important}body[data-theme=dark] .only-dark{display:block!important}@media(prefers-color-scheme:dark){body:not([data-theme=light]){--color-problematic:#ee5151;--color-foreground-primary:#ffffffcc;--color-foreground-secondary:#9ca0a5;--color-foreground-muted:#81868d;--color-foreground-border:#666;--color-background-primary:#131416;--color-background-secondary:#1a1c1e;--color-background-hover:#1e2124;--color-background-hover--transparent:#1e212400;--color-background-border:#303335;--color-background-item:#444;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#2b8cee;--color-brand-content:#368ce2;--color-highlighted-background:#083563;--color-guilabel-background:#08356380;--color-guilabel-border:#13395f80;--color-api-keyword:var(--color-foreground-secondary);--color-highlight-on-target:#330;--color-admonition-background:#18181a;--color-card-border:var(--color-background-secondary);--color-card-background:#18181a;--color-card-marginals-background:var(--color-background-hover)}html body:not([data-theme=light]) .only-light{display:none!important}body:not([data-theme=light]) .only-dark{display:block!important}}}body[data-theme=auto] .theme-toggle svg.theme-icon-when-auto,body[data-theme=dark] .theme-toggle svg.theme-icon-when-dark,body[data-theme=light] .theme-toggle svg.theme-icon-when-light{display:block}body{font-family:var(--font-stack)}code,kbd,pre,samp{font-family:var(--font-stack--monospace)}body{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}article{line-height:1.5}h1,h2,h3,h4,h5,h6{border-radius:.5rem;font-weight:700;line-height:1.25;margin:.5rem -.5rem;padding-left:.5rem;padding-right:.5rem}h1+p,h2+p,h3+p,h4+p,h5+p,h6+p{margin-top:0}h1{font-size:2.5em;margin-bottom:1rem}h1,h2{margin-top:1.75rem}h2{font-size:2em}h3{font-size:1.5em}h4{font-size:1.25em}h5{font-size:1.125em}h6{font-size:1em}small{font-size:80%;opacity:75%}p{margin-bottom:.75rem;margin-top:.5rem}hr.docutils{background-color:var(--color-background-border);border:0;height:1px;margin:2rem 0;padding:0}.centered{text-align:center}a{color:var(--color-link);text-decoration:underline;-webkit-text-decoration-color:var(--color-link-underline);text-decoration-color:var(--color-link-underline)}a:hover{color:var(--color-link--hover);-webkit-text-decoration-color:var(--color-link-underline--hover);text-decoration-color:var(--color-link-underline--hover)}a.muted-link{color:inherit}a.muted-link:hover{color:var(--color-link);-webkit-text-decoration-color:var(--color-link-underline--hover);text-decoration-color:var(--color-link-underline--hover)}html{overflow-x:hidden;overflow-y:scroll;scroll-behavior:smooth}.sidebar-scroll,.toc-scroll,article[role=main] *{scrollbar-color:var(--color-foreground-border) transparent;scrollbar-width:thin}.sidebar-scroll::-webkit-scrollbar,.toc-scroll::-webkit-scrollbar,article[role=main] ::-webkit-scrollbar{height:.25rem;width:.25rem}.sidebar-scroll::-webkit-scrollbar-thumb,.toc-scroll::-webkit-scrollbar-thumb,article[role=main] ::-webkit-scrollbar-thumb{background-color:var(--color-foreground-border);border-radius:.125rem}body,html{background:var(--color-background-primary);color:var(--color-foreground-primary);height:100%}article{background:var(--color-content-background);color:var(--color-content-foreground)}.page{display:flex;min-height:100%}.mobile-header{background-color:var(--color-header-background);border-bottom:1px solid var(--color-header-border);color:var(--color-header-text);display:none;height:var(--header-height);width:100%;z-index:10}.mobile-header.scrolled{border-bottom:none;box-shadow:0 0 .2rem rgba(0,0,0,.1),0 .2rem .4rem rgba(0,0,0,.2)}.mobile-header .header-center a{color:var(--color-header-text);text-decoration:none}.main{display:flex;flex:1}.sidebar-drawer{background:var(--color-sidebar-background);border-right:1px solid var(--color-sidebar-background-border);box-sizing:border-box;display:flex;justify-content:flex-end;min-width:15em;width:calc(50% - 26em)}.sidebar-container,.toc-drawer{box-sizing:border-box;width:15em}.toc-drawer{background:var(--color-toc-background);padding-right:1rem}.sidebar-sticky,.toc-sticky{display:flex;flex-direction:column;height:min(100%,100vh);height:100vh;position:-webkit-sticky;position:sticky;top:0}.sidebar-scroll,.toc-scroll{flex-grow:1;flex-shrink:1;overflow:auto;scroll-behavior:smooth}.content{display:flex;flex-direction:column;justify-content:space-between;padding:0 3em;width:46em}.icon{display:inline-block;height:1rem;width:1rem}.icon svg{height:100%;width:100%}.announcement{align-items:center;background-color:var(--color-announcement-background);color:var(--color-announcement-text);display:flex;height:var(--header-height);overflow-x:auto}.announcement+.page{min-height:calc(100% - var(--header-height))}.announcement-content{box-sizing:border-box;min-width:100%;padding:.5rem;text-align:center;white-space:nowrap}.announcement-content a{color:var(--color-announcement-text);-webkit-text-decoration-color:var(--color-announcement-text);text-decoration-color:var(--color-announcement-text)}.announcement-content a:hover{color:var(--color-announcement-text);-webkit-text-decoration-color:var(--color-link--hover);text-decoration-color:var(--color-link--hover)}.no-js .theme-toggle-container{display:none}.theme-toggle-container{vertical-align:middle}.theme-toggle{background:transparent;border:none;cursor:pointer;padding:0}.theme-toggle svg{color:var(--color-foreground-primary);display:none;height:1rem;vertical-align:middle;width:1rem}.theme-toggle-header{float:left;padding:1rem .5rem}.nav-overlay-icon,.toc-overlay-icon{cursor:pointer;display:none}.nav-overlay-icon .icon,.toc-overlay-icon .icon{color:var(--color-foreground-secondary);height:1rem;width:1rem}.nav-overlay-icon,.toc-header-icon{align-items:center;justify-content:center}.toc-content-icon{height:1.5rem;width:1.5rem}.content-icon-container{display:flex;float:right;gap:.5rem;margin-bottom:1rem;margin-left:1rem;margin-top:1.5rem}.content-icon-container .edit-this-page svg{color:inherit;height:1rem;width:1rem}.sidebar-toggle{display:none;position:absolute}.sidebar-toggle[name=__toc]{left:20px}.sidebar-toggle:checked{left:40px}.overlay{background-color:rgba(0,0,0,.54);height:0;opacity:0;position:fixed;top:0;transition:width 0ms,height 0ms,opacity .25s ease-out;width:0}.sidebar-overlay{z-index:20}.toc-overlay{z-index:40}.sidebar-drawer{transition:left .25s ease-in-out;z-index:30}.toc-drawer{transition:right .25s ease-in-out;z-index:50}#__navigation:checked~.sidebar-overlay{height:100%;opacity:1;width:100%}#__navigation:checked~.page .sidebar-drawer{left:0;top:0}#__toc:checked~.toc-overlay{height:100%;opacity:1;width:100%}#__toc:checked~.page .toc-drawer{right:0;top:0}.back-to-top{background:var(--color-background-primary);border-radius:1rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 1px 0 hsla(220,9%,46%,.502);display:none;font-size:.8125rem;left:0;margin-left:50%;padding:.5rem .75rem .5rem .5rem;position:fixed;text-decoration:none;top:1rem;transform:translateX(-50%);z-index:10}.back-to-top svg{fill:currentColor;display:inline-block;height:1rem;width:1rem}.back-to-top span{margin-left:.25rem}.show-back-to-top .back-to-top{align-items:center;display:flex}@media(min-width:97em){html{font-size:110%}}@media(max-width:82em){.toc-content-icon{display:flex}.toc-drawer{border-left:1px solid var(--color-background-muted);height:100vh;position:fixed;right:-15em;top:0}.toc-tree{border-left:none;font-size:var(--toc-font-size--mobile)}.sidebar-drawer{width:calc(50% - 18.5em)}}@media(max-width:67em){.nav-overlay-icon{display:flex}.sidebar-drawer{height:100vh;left:-15em;position:fixed;top:0;width:15em}.toc-header-icon{display:flex}.theme-toggle-content,.toc-content-icon{display:none}.theme-toggle-header{display:block}.mobile-header{align-items:center;display:flex;justify-content:space-between;position:-webkit-sticky;position:sticky;top:0}.mobile-header .header-left,.mobile-header .header-right{display:flex;height:var(--header-height);padding:0 var(--header-padding)}.mobile-header .header-left label,.mobile-header .header-right label{height:100%;-webkit-user-select:none;-moz-user-select:none;user-select:none;width:100%}:target{scroll-margin-top:var(--header-height)}.back-to-top{top:calc(var(--header-height) + .5rem)}.page{flex-direction:column;justify-content:center}.content{margin-left:auto;margin-right:auto}}@media(max-width:52em){.content{overflow-x:auto;width:100%}}@media(max-width:46em){.content{padding:0 1em}article aside.sidebar{float:none;margin:1rem 0;width:100%}}.admonition,.topic{background:var(--color-admonition-background);border-radius:.2rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1);font-size:var(--admonition-font-size);margin:1rem auto;overflow:hidden;padding:0 .5rem .5rem;page-break-inside:avoid}.admonition>:nth-child(2),.topic>:nth-child(2){margin-top:0}.admonition>:last-child,.topic>:last-child{margin-bottom:0}p.admonition-title,p.topic-title{font-size:var(--admonition-title-font-size);font-weight:500;line-height:1.3;margin:0 -.5rem .5rem;padding:.4rem .5rem .4rem 2rem;position:relative}p.admonition-title:before,p.topic-title:before{content:"";height:1rem;left:.5rem;position:absolute;width:1rem}p.admonition-title{background-color:var(--color-admonition-title-background)}p.admonition-title:before{background-color:var(--color-admonition-title);-webkit-mask-image:var(--icon-admonition-default);mask-image:var(--icon-admonition-default);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}p.topic-title{background-color:var(--color-topic-title-background)}p.topic-title:before{background-color:var(--color-topic-title);-webkit-mask-image:var(--icon-topic-default);mask-image:var(--icon-topic-default);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.admonition{border-left:.2rem solid var(--color-admonition-title)}.admonition.caution{border-left-color:var(--color-admonition-title--caution)}.admonition.caution>.admonition-title{background-color:var(--color-admonition-title-background--caution)}.admonition.caution>.admonition-title:before{background-color:var(--color-admonition-title--caution);-webkit-mask-image:var(--icon-spark);mask-image:var(--icon-spark)}.admonition.warning{border-left-color:var(--color-admonition-title--warning)}.admonition.warning>.admonition-title{background-color:var(--color-admonition-title-background--warning)}.admonition.warning>.admonition-title:before{background-color:var(--color-admonition-title--warning);-webkit-mask-image:var(--icon-warning);mask-image:var(--icon-warning)}.admonition.danger{border-left-color:var(--color-admonition-title--danger)}.admonition.danger>.admonition-title{background-color:var(--color-admonition-title-background--danger)}.admonition.danger>.admonition-title:before{background-color:var(--color-admonition-title--danger);-webkit-mask-image:var(--icon-spark);mask-image:var(--icon-spark)}.admonition.attention{border-left-color:var(--color-admonition-title--attention)}.admonition.attention>.admonition-title{background-color:var(--color-admonition-title-background--attention)}.admonition.attention>.admonition-title:before{background-color:var(--color-admonition-title--attention);-webkit-mask-image:var(--icon-warning);mask-image:var(--icon-warning)}.admonition.error{border-left-color:var(--color-admonition-title--error)}.admonition.error>.admonition-title{background-color:var(--color-admonition-title-background--error)}.admonition.error>.admonition-title:before{background-color:var(--color-admonition-title--error);-webkit-mask-image:var(--icon-failure);mask-image:var(--icon-failure)}.admonition.hint{border-left-color:var(--color-admonition-title--hint)}.admonition.hint>.admonition-title{background-color:var(--color-admonition-title-background--hint)}.admonition.hint>.admonition-title:before{background-color:var(--color-admonition-title--hint);-webkit-mask-image:var(--icon-question);mask-image:var(--icon-question)}.admonition.tip{border-left-color:var(--color-admonition-title--tip)}.admonition.tip>.admonition-title{background-color:var(--color-admonition-title-background--tip)}.admonition.tip>.admonition-title:before{background-color:var(--color-admonition-title--tip);-webkit-mask-image:var(--icon-info);mask-image:var(--icon-info)}.admonition.important{border-left-color:var(--color-admonition-title--important)}.admonition.important>.admonition-title{background-color:var(--color-admonition-title-background--important)}.admonition.important>.admonition-title:before{background-color:var(--color-admonition-title--important);-webkit-mask-image:var(--icon-flame);mask-image:var(--icon-flame)}.admonition.note{border-left-color:var(--color-admonition-title--note)}.admonition.note>.admonition-title{background-color:var(--color-admonition-title-background--note)}.admonition.note>.admonition-title:before{background-color:var(--color-admonition-title--note);-webkit-mask-image:var(--icon-pencil);mask-image:var(--icon-pencil)}.admonition.seealso{border-left-color:var(--color-admonition-title--seealso)}.admonition.seealso>.admonition-title{background-color:var(--color-admonition-title-background--seealso)}.admonition.seealso>.admonition-title:before{background-color:var(--color-admonition-title--seealso);-webkit-mask-image:var(--icon-info);mask-image:var(--icon-info)}.admonition.admonition-todo{border-left-color:var(--color-admonition-title--admonition-todo)}.admonition.admonition-todo>.admonition-title{background-color:var(--color-admonition-title-background--admonition-todo)}.admonition.admonition-todo>.admonition-title:before{background-color:var(--color-admonition-title--admonition-todo);-webkit-mask-image:var(--icon-pencil);mask-image:var(--icon-pencil)}.admonition-todo>.admonition-title{text-transform:uppercase}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd{margin-left:2rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd>:first-child{margin-top:.125rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list,dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd>:last-child{margin-bottom:.75rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list>dt{font-size:var(--font-size--small);text-transform:uppercase}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd:empty{margin-bottom:.5rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul{margin-left:-1.2rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul>li>p:nth-child(2){margin-top:0}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul>li>p+p:last-child:empty{margin-bottom:0;margin-top:0}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt{color:var(--color-api-overall)}.sig:not(.sig-inline){background:var(--color-api-background);border-radius:.25rem;font-family:var(--font-stack--monospace);font-size:var(--api-font-size);font-weight:700;padding:.25rem .5rem .25rem 3em;text-indent:-2.5em}.sig:not(.sig-inline):hover{background:var(--color-api-background-hover)}.sig:not(.sig-inline) a.reference .viewcode-link{font-weight:400;width:3.5rem}.sig:not(.sig-inline) span.pre{overflow-wrap:anywhere}em.property{font-style:normal}em.property:first-child{color:var(--color-api-keyword)}.sig-name{color:var(--color-api-name)}.sig-prename{color:var(--color-api-pre-name);font-weight:400}.sig-paren{color:var(--color-api-paren)}.sig-param{font-style:normal}.versionmodified{font-style:italic}div.deprecated p,div.versionadded p,div.versionchanged p{margin-bottom:.125rem;margin-top:.125rem}.viewcode-back,.viewcode-link{float:right;text-align:right}.line-block{margin-bottom:.75rem;margin-top:.5rem}.line-block .line-block{margin-bottom:0;margin-top:0;padding-left:1rem}.code-block-caption,article p.caption,table>caption{font-size:var(--font-size--small);text-align:center}.toctree-wrapper.compound .caption,.toctree-wrapper.compound :not(.caption)>.caption-text{font-size:var(--font-size--small);margin-bottom:0;text-align:initial;text-transform:uppercase}.toctree-wrapper.compound>ul{margin-bottom:0;margin-top:0}.sig-inline,code.literal{background:var(--color-inline-code-background);border-radius:.2em;font-size:var(--font-size--small--2);padding:.1em .2em}p .sig-inline,p code.literal{border:1px solid var(--color-background-border)}.sig-inline{font-family:var(--font-stack--monospace)}div[class*=" highlight-"],div[class^=highlight-]{display:flex;margin:1em 0}div[class*=" highlight-"] .table-wrapper,div[class^=highlight-] .table-wrapper,pre{margin:0;padding:0}article[role=main] .highlight pre{line-height:1.5}.highlight pre,pre.literal-block{font-size:var(--code-font-size);overflow:auto;padding:.625rem .875rem}pre.literal-block{background-color:var(--color-code-background);border-radius:.2rem;color:var(--color-code-foreground);margin-bottom:1rem;margin-top:1rem}.highlight{border-radius:.2rem;width:100%}.highlight .gp,.highlight span.linenos{pointer-events:none;-webkit-user-select:none;-moz-user-select:none;user-select:none}.highlight .hll{display:block;margin-left:-.875rem;margin-right:-.875rem;padding-left:.875rem;padding-right:.875rem}.code-block-caption{background-color:var(--color-code-background);border-bottom:1px solid;border-radius:.25rem;border-bottom-left-radius:0;border-bottom-right-radius:0;border-color:var(--color-background-border);color:var(--color-code-foreground);display:flex;font-weight:300;padding:.625rem .875rem}.code-block-caption+div[class]{margin-top:0}.code-block-caption+div[class] pre{border-top-left-radius:0;border-top-right-radius:0}.highlighttable{display:block;width:100%}.highlighttable tbody{display:block}.highlighttable tr{display:flex}.highlighttable td.linenos{background-color:var(--color-code-background);border-bottom-left-radius:.2rem;border-top-left-radius:.2rem;color:var(--color-code-foreground);padding:.625rem 0 .625rem .875rem}.highlighttable .linenodiv{box-shadow:-.0625rem 0 var(--color-foreground-border) inset;font-size:var(--code-font-size);padding-right:.875rem}.highlighttable td.code{display:block;flex:1;overflow:hidden;padding:0}.highlighttable td.code .highlight{border-bottom-left-radius:0;border-top-left-radius:0}.highlight span.linenos{box-shadow:-.0625rem 0 var(--color-foreground-border) inset;display:inline-block;margin-right:.875rem;padding-left:0;padding-right:.875rem}.footnote-reference{font-size:var(--font-size--small--4);vertical-align:super}dl.footnote.brackets{color:var(--color-foreground-secondary);display:grid;font-size:var(--font-size--small);grid-template-columns:-webkit-max-content auto;grid-template-columns:max-content auto}dl.footnote.brackets dt{margin:0}dl.footnote.brackets dt>.fn-backref{margin-left:.25rem}dl.footnote.brackets dt:after{content:":"}dl.footnote.brackets dt .brackets:before{content:"["}dl.footnote.brackets dt .brackets:after{content:"]"}dl.footnote.brackets dd{margin:0;padding:0 1rem}aside.footnote{color:var(--color-foreground-secondary);font-size:var(--font-size--small)}aside.footnote>span,div.citation>span{float:left;font-weight:500;padding-right:.25rem}aside.footnote>p,div.citation>p{margin-left:2rem}img{box-sizing:border-box;height:auto;max-width:100%}article .figure,article figure{border-radius:.2rem;margin:0}article .figure :last-child,article figure :last-child{margin-bottom:0}article .align-left{clear:left;float:left;margin:0 1rem 1rem}article .align-right{clear:right;float:right;margin:0 1rem 1rem}article .align-center,article .align-default{display:block;margin-left:auto;margin-right:auto;text-align:center}article table.align-default{display:table;text-align:initial}.domainindex-jumpbox,.genindex-jumpbox{border-bottom:1px solid var(--color-background-border);border-top:1px solid var(--color-background-border);padding:.25rem}.domainindex-section h2,.genindex-section h2{margin-bottom:.5rem;margin-top:.75rem}.domainindex-section ul,.genindex-section ul{margin-bottom:0;margin-top:0}ol,ul{margin-bottom:1rem;margin-top:1rem;padding-left:1.2rem}ol li>p:first-child,ul li>p:first-child{margin-bottom:.25rem;margin-top:.25rem}ol li>p:last-child,ul li>p:last-child{margin-top:.25rem}ol li>ol,ol li>ul,ul li>ol,ul li>ul{margin-bottom:.5rem;margin-top:.5rem}ol.arabic{list-style:decimal}ol.loweralpha{list-style:lower-alpha}ol.upperalpha{list-style:upper-alpha}ol.lowerroman{list-style:lower-roman}ol.upperroman{list-style:upper-roman}.simple li>ol,.simple li>ul,.toctree-wrapper li>ol,.toctree-wrapper li>ul{margin-bottom:0;margin-top:0}.field-list dt,.option-list dt,dl.footnote dt,dl.glossary dt,dl.simple dt,dl:not([class]) dt{font-weight:500;margin-top:.25rem}.field-list dt+dt,.option-list dt+dt,dl.footnote dt+dt,dl.glossary dt+dt,dl.simple dt+dt,dl:not([class]) dt+dt{margin-top:0}.field-list dt .classifier:before,.option-list dt .classifier:before,dl.footnote dt .classifier:before,dl.glossary dt .classifier:before,dl.simple dt .classifier:before,dl:not([class]) dt .classifier:before{content:":";margin-left:.2rem;margin-right:.2rem}.field-list dd ul,.field-list dd>p:first-child,.option-list dd ul,.option-list dd>p:first-child,dl.footnote dd ul,dl.footnote dd>p:first-child,dl.glossary dd ul,dl.glossary dd>p:first-child,dl.simple dd ul,dl.simple dd>p:first-child,dl:not([class]) dd ul,dl:not([class]) dd>p:first-child{margin-top:.125rem}.field-list dd ul,.option-list dd ul,dl.footnote dd ul,dl.glossary dd ul,dl.simple dd ul,dl:not([class]) dd ul{margin-bottom:.125rem}.math-wrapper{overflow-x:auto;width:100%}div.math{position:relative;text-align:center}div.math .headerlink,div.math:focus .headerlink{display:none}div.math:hover .headerlink{display:inline-block}div.math span.eqno{position:absolute;right:.5rem;top:50%;transform:translateY(-50%);z-index:1}abbr[title]{cursor:help}.problematic{color:var(--color-problematic)}kbd:not(.compound){background-color:var(--color-background-secondary);border:1px solid var(--color-foreground-border);border-radius:.2rem;box-shadow:0 .0625rem 0 rgba(0,0,0,.2),inset 0 0 0 .125rem var(--color-background-primary);color:var(--color-foreground-primary);display:inline-block;font-size:var(--font-size--small--3);margin:0 .2rem;padding:0 .2rem;vertical-align:text-bottom}blockquote{background:var(--color-background-secondary);border-left:4px solid var(--color-background-border);margin-left:0;margin-right:0;padding:.5rem 1rem}blockquote .attribution{font-weight:600;text-align:right}blockquote.highlights,blockquote.pull-quote{font-size:1.25em}blockquote.epigraph,blockquote.pull-quote{border-left-width:0;border-radius:.5rem}blockquote.highlights{background:transparent;border-left-width:0}p .reference img{vertical-align:middle}p.rubric{font-size:1.125em;font-weight:700;line-height:1.25}dd p.rubric{font-size:var(--font-size--small);font-weight:inherit;line-height:inherit;text-transform:uppercase}article .sidebar{background-color:var(--color-background-secondary);border:1px solid var(--color-background-border);border-radius:.2rem;clear:right;float:right;margin-left:1rem;margin-right:0;width:30%}article .sidebar>*{padding-left:1rem;padding-right:1rem}article .sidebar>ol,article .sidebar>ul{padding-left:2.2rem}article .sidebar .sidebar-title{border-bottom:1px solid var(--color-background-border);font-weight:500;margin:0;padding:.5rem 1rem}.table-wrapper{margin-bottom:.5rem;margin-top:1rem;overflow-x:auto;padding:.2rem .2rem .75rem;width:100%}table.docutils{border-collapse:collapse;border-radius:.2rem;border-spacing:0;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1)}table.docutils th{background:var(--color-table-header-background)}table.docutils td,table.docutils th{border-bottom:1px solid var(--color-table-border);border-left:1px solid var(--color-table-border);border-right:1px solid var(--color-table-border);padding:0 .25rem}table.docutils td p,table.docutils th p{margin:.25rem}table.docutils td:first-child,table.docutils th:first-child{border-left:none}table.docutils td:last-child,table.docutils th:last-child{border-right:none}table.docutils td.text-left,table.docutils th.text-left{text-align:left}table.docutils td.text-right,table.docutils th.text-right{text-align:right}table.docutils td.text-center,table.docutils th.text-center{text-align:center}:target{scroll-margin-top:.5rem}@media(max-width:67em){:target{scroll-margin-top:calc(.5rem + var(--header-height))}section>span:target{scroll-margin-top:calc(.8rem + var(--header-height))}}.headerlink{font-weight:100;-webkit-user-select:none;-moz-user-select:none;user-select:none}.code-block-caption>.headerlink,dl dt>.headerlink,figcaption p>.headerlink,h1>.headerlink,h2>.headerlink,h3>.headerlink,h4>.headerlink,h5>.headerlink,h6>.headerlink,p.caption>.headerlink,table>caption>.headerlink{margin-left:.5rem;visibility:hidden}.code-block-caption:hover>.headerlink,dl dt:hover>.headerlink,figcaption p:hover>.headerlink,h1:hover>.headerlink,h2:hover>.headerlink,h3:hover>.headerlink,h4:hover>.headerlink,h5:hover>.headerlink,h6:hover>.headerlink,p.caption:hover>.headerlink,table>caption:hover>.headerlink{visibility:visible}.code-block-caption>.toc-backref,dl dt>.toc-backref,figcaption p>.toc-backref,h1>.toc-backref,h2>.toc-backref,h3>.toc-backref,h4>.toc-backref,h5>.toc-backref,h6>.toc-backref,p.caption>.toc-backref,table>caption>.toc-backref{color:inherit;-webkit-text-decoration-line:none;text-decoration-line:none}figure:hover>figcaption>p>.headerlink,table:hover>caption>.headerlink{visibility:visible}:target>h1:first-of-type,:target>h2:first-of-type,:target>h3:first-of-type,:target>h4:first-of-type,:target>h5:first-of-type,:target>h6:first-of-type,span:target~h1:first-of-type,span:target~h2:first-of-type,span:target~h3:first-of-type,span:target~h4:first-of-type,span:target~h5:first-of-type,span:target~h6:first-of-type{background-color:var(--color-highlight-on-target)}:target>h1:first-of-type code.literal,:target>h2:first-of-type code.literal,:target>h3:first-of-type code.literal,:target>h4:first-of-type code.literal,:target>h5:first-of-type code.literal,:target>h6:first-of-type code.literal,span:target~h1:first-of-type code.literal,span:target~h2:first-of-type code.literal,span:target~h3:first-of-type code.literal,span:target~h4:first-of-type code.literal,span:target~h5:first-of-type code.literal,span:target~h6:first-of-type code.literal{background-color:transparent}.literal-block-wrapper:target .code-block-caption,.this-will-duplicate-information-and-it-is-still-useful-here li :target,figure:target,table:target>caption{background-color:var(--color-highlight-on-target)}dt:target{background-color:var(--color-highlight-on-target)!important}.footnote-reference:target,.footnote>dt:target+dd{background-color:var(--color-highlight-on-target)}.guilabel{background-color:var(--color-guilabel-background);border:1px solid var(--color-guilabel-border);border-radius:.5em;color:var(--color-guilabel-text);font-size:.9em;padding:0 .3em}footer{display:flex;flex-direction:column;font-size:var(--font-size--small);margin-top:2rem}.bottom-of-page{align-items:center;border-top:1px solid var(--color-background-border);color:var(--color-foreground-secondary);display:flex;justify-content:space-between;line-height:1.5;margin-top:1rem;padding-bottom:1rem;padding-top:1rem}@media(max-width:46em){.bottom-of-page{flex-direction:column-reverse;gap:.25rem;text-align:center}}.bottom-of-page .left-details{font-size:var(--font-size--small)}.bottom-of-page .right-details{display:flex;flex-direction:column;gap:.25rem;text-align:right}.bottom-of-page .icons{display:flex;font-size:1rem;gap:.25rem;justify-content:flex-end}.bottom-of-page .icons a{text-decoration:none}.bottom-of-page .icons img,.bottom-of-page .icons svg{font-size:1.125rem;height:1em;width:1em}.related-pages a{align-items:center;display:flex;text-decoration:none}.related-pages a:hover .page-info .title{color:var(--color-link);text-decoration:underline;-webkit-text-decoration-color:var(--color-link-underline);text-decoration-color:var(--color-link-underline)}.related-pages a svg.furo-related-icon,.related-pages a svg.furo-related-icon>use{color:var(--color-foreground-border);flex-shrink:0;height:.75rem;margin:0 .5rem;width:.75rem}.related-pages a.next-page{clear:right;float:right;max-width:50%;text-align:right}.related-pages a.prev-page{clear:left;float:left;max-width:50%}.related-pages a.prev-page svg{transform:rotate(180deg)}.page-info{display:flex;flex-direction:column;overflow-wrap:anywhere}.next-page .page-info{align-items:flex-end}.page-info .context{align-items:center;color:var(--color-foreground-muted);display:flex;font-size:var(--font-size--small);padding-bottom:.1rem;text-decoration:none}ul.search{list-style:none;padding-left:0}ul.search li{border-bottom:1px solid var(--color-background-border);padding:1rem 0}[role=main] .highlighted{background-color:var(--color-highlighted-background);color:var(--color-highlighted-text)}.sidebar-brand{display:flex;flex-direction:column;flex-shrink:0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-decoration:none}.sidebar-brand-text{color:var(--color-sidebar-brand-text);font-size:1.5rem;overflow-wrap:break-word}.sidebar-brand-text,.sidebar-logo-container{margin:var(--sidebar-item-spacing-vertical) 0}.sidebar-logo{display:block;margin:0 auto;max-width:100%}.sidebar-search-container{align-items:center;background:var(--color-sidebar-search-background);display:flex;margin-top:var(--sidebar-search-space-above);position:relative}.sidebar-search-container:focus-within,.sidebar-search-container:hover{background:var(--color-sidebar-search-background--focus)}.sidebar-search-container:before{background-color:var(--color-sidebar-search-icon);content:"";height:var(--sidebar-search-icon-size);left:var(--sidebar-item-spacing-horizontal);-webkit-mask-image:var(--icon-search);mask-image:var(--icon-search);position:absolute;width:var(--sidebar-search-icon-size)}.sidebar-search{background:transparent;border:none;border-bottom:1px solid var(--color-sidebar-search-border);border-top:1px solid var(--color-sidebar-search-border);box-sizing:border-box;color:var(--color-sidebar-search-foreground);padding:var(--sidebar-search-input-spacing-vertical) var(--sidebar-search-input-spacing-horizontal) var(--sidebar-search-input-spacing-vertical) calc(var(--sidebar-item-spacing-horizontal) + var(--sidebar-search-input-spacing-horizontal) + var(--sidebar-search-icon-size));width:100%;z-index:10}.sidebar-search:focus{outline:none}.sidebar-search::-moz-placeholder{font-size:var(--sidebar-search-input-font-size)}.sidebar-search::placeholder{font-size:var(--sidebar-search-input-font-size)}#searchbox .highlight-link{margin:0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal) 0;text-align:center}#searchbox .highlight-link a{color:var(--color-sidebar-search-icon);font-size:var(--font-size--small--2)}.sidebar-tree{font-size:var(--sidebar-item-font-size);margin-bottom:var(--sidebar-item-spacing-vertical);margin-top:var(--sidebar-tree-space-above)}.sidebar-tree ul{display:flex;flex-direction:column;list-style:none;margin-bottom:0;margin-top:0;padding:0}.sidebar-tree li{margin:0;position:relative}.sidebar-tree li>ul{margin-left:var(--sidebar-item-spacing-horizontal)}.sidebar-tree .icon,.sidebar-tree .reference{color:var(--color-sidebar-link-text)}.sidebar-tree .reference{box-sizing:border-box;display:inline-block;height:100%;line-height:var(--sidebar-item-line-height);overflow-wrap:anywhere;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-decoration:none;width:100%}.sidebar-tree .reference:hover{background:var(--color-sidebar-item-background--hover)}.sidebar-tree .reference.external:after{color:var(--color-sidebar-link-text);content:url("data:image/svg+xml;charset=utf-8,%3Csvg width='12' height='12' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' stroke-width='1.5' stroke='%23607D8B' fill='none' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M0 0h24v24H0z' stroke='none'/%3E%3Cpath d='M11 7H6a2 2 0 0 0-2 2v9a2 2 0 0 0 2 2h9a2 2 0 0 0 2-2v-5M10 14 20 4M15 4h5v5'/%3E%3C/svg%3E");margin:0 .25rem;vertical-align:middle}.sidebar-tree .current-page>.reference{font-weight:700}.sidebar-tree label{align-items:center;cursor:pointer;display:flex;height:var(--sidebar-item-height);justify-content:center;position:absolute;right:0;top:0;-webkit-user-select:none;-moz-user-select:none;user-select:none;width:var(--sidebar-expander-width)}.sidebar-tree .caption,.sidebar-tree :not(.caption)>.caption-text{color:var(--color-sidebar-caption-text);font-size:var(--sidebar-caption-font-size);font-weight:700;margin:var(--sidebar-caption-space-above) 0 0 0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-transform:uppercase}.sidebar-tree li.has-children>.reference{padding-right:var(--sidebar-expander-width)}.sidebar-tree .toctree-l1>.reference,.sidebar-tree .toctree-l1>label .icon{color:var(--color-sidebar-link-text--top-level)}.sidebar-tree label{background:var(--color-sidebar-item-expander-background)}.sidebar-tree label:hover{background:var(--color-sidebar-item-expander-background--hover)}.sidebar-tree .current>.reference{background:var(--color-sidebar-item-background--current)}.sidebar-tree .current>.reference:hover{background:var(--color-sidebar-item-background--hover)}.toctree-checkbox{display:none;position:absolute}.toctree-checkbox~ul{display:none}.toctree-checkbox~label .icon svg{transform:rotate(90deg)}.toctree-checkbox:checked~ul{display:block}.toctree-checkbox:checked~label .icon svg{transform:rotate(-90deg)}.toc-title-container{padding:var(--toc-title-padding);padding-top:var(--toc-spacing-vertical)}.toc-title{color:var(--color-toc-title-text);font-size:var(--toc-title-font-size);padding-left:var(--toc-spacing-horizontal);text-transform:uppercase}.no-toc{display:none}.toc-tree-container{padding-bottom:var(--toc-spacing-vertical)}.toc-tree{border-left:1px solid var(--color-background-border);font-size:var(--toc-font-size);line-height:1.3;padding-left:calc(var(--toc-spacing-horizontal) - var(--toc-item-spacing-horizontal))}.toc-tree>ul>li:first-child{padding-top:0}.toc-tree>ul>li:first-child>ul{padding-left:0}.toc-tree>ul>li:first-child>a{display:none}.toc-tree ul{list-style-type:none;margin-bottom:0;margin-top:0;padding-left:var(--toc-item-spacing-horizontal)}.toc-tree li{padding-top:var(--toc-item-spacing-vertical)}.toc-tree li.scroll-current>.reference{color:var(--color-toc-item-text--active);font-weight:700}.toc-tree .reference{color:var(--color-toc-item-text);overflow-wrap:anywhere;text-decoration:none}.toc-scroll{max-height:100vh;overflow-y:scroll}.contents:not(.this-will-duplicate-information-and-it-is-still-useful-here){background:rgba(255,0,0,.25);color:var(--color-problematic)}.contents:not(.this-will-duplicate-information-and-it-is-still-useful-here):before{content:"ERROR: Adding a table of contents in Furo-based documentation is unnecessary, and does not work well with existing styling.Add a 'this-will-duplicate-information-and-it-is-still-useful-here' class, if you want an escape hatch."}.text-align\:left>p{text-align:left}.text-align\:center>p{text-align:center}.text-align\:right>p{text-align:right} -/*# sourceMappingURL=furo.css.map*/ \ No newline at end of file diff --git a/docs/github/html/_static/styles/furo.css.map b/docs/github/html/_static/styles/furo.css.map deleted file mode 100644 index d4a86ca..0000000 --- a/docs/github/html/_static/styles/furo.css.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"styles/furo.css","mappings":"AAAA,2EAA2E,CAU3E,KAEE,6BAA8B,CAD9B,gBAEF,CASA,KACE,QACF,CAMA,KACE,aACF,CAOA,GACE,aAAc,CACd,cACF,CAUA,GACE,sBAAuB,CACvB,QAAS,CACT,gBACF,CAOA,IACE,+BAAiC,CACjC,aACF,CASA,EACE,4BACF,CAOA,YACE,kBAAmB,CACnB,yBAA0B,CAC1B,gCACF,CAMA,SAEE,kBACF,CAOA,cAGE,+BAAiC,CACjC,aACF,CAeA,QAEE,aAAc,CACd,aAAc,CACd,iBAAkB,CAClB,uBACF,CAEA,IACE,aACF,CAEA,IACE,SACF,CASA,IACE,iBACF,CAUA,sCAKE,mBAAoB,CACpB,cAAe,CACf,gBAAiB,CACjB,QACF,CAOA,aAEE,gBACF,CAOA,cAEE,mBACF,CAMA,gDAIE,yBACF,CAMA,wHAIE,iBAAkB,CAClB,SACF,CAMA,4GAIE,6BACF,CAMA,SACE,0BACF,CASA,OACE,qBAAsB,CACtB,aAAc,CACd,aAAc,CACd,cAAe,CACf,SAAU,CACV,kBACF,CAMA,SACE,uBACF,CAMA,SACE,aACF,CAOA,6BAEE,qBAAsB,CACtB,SACF,CAMA,kFAEE,WACF,CAOA,cACE,4BAA6B,CAC7B,mBACF,CAMA,yCACE,uBACF,CAOA,6BACE,yBAA0B,CAC1B,YACF,CASA,QACE,aACF,CAMA,QACE,iBACF,CAiBA,kBACE,YACF,CCvVA,aAcE,kEACE,uBAOF,WACE,iDAMF,gCACE,wBAEF,qCAEE,uBADA,uBACA,CAEF,SACE,wBAtBA,CCpBJ,iBAOE,6BAEA,mBANA,qBAEA,sBACA,0BAFA,oBAHA,4BAOA,6BANA,mBAOA,CAEF,gBACE,aCPF,KCGE,mHAEA,wGAGA,wBAAyB,CACzB,wBAAyB,CACzB,4BAA6B,CAC7B,yBAA0B,CAC1B,2BAA4B,CAG5B,sDAAuD,CACvD,gDAAiD,CACjD,wDAAyD,CAGzD,0CAA2C,CAC3C,gDAAiD,CACjD,gDAAiD,CAKjD,gCAAiC,CACjC,sCAAuC,CAGvC,2CAA4C,CAG5C,uCAAwC,CChCxC,+FAGA,uBAAwB,CAGxB,iCAAkC,CAClC,kCAAmC,CAEnC,+BAAgC,CAChC,sCAAuC,CACvC,sCAAuC,CACvC,qGAIA,mDAAoD,CAEpD,mCAAoC,CACpC,8CAA+C,CAC/C,gDAAiD,CACjD,kCAAmC,CACnC,6DAA8D,CAG9D,6BAA8B,CAC9B,6BAA8B,CAC9B,+BAAgC,CAChC,kCAAmC,CACnC,kCAAmC,CCPjC,ukBCYA,srCAZF,kaCVA,mLAOA,oTAWA,2UAaA,0CACA,gEACA,0CAGA,gEAUA,yCACA,+DAIA,4CACA,kEAGA,sGAEA,mGAGA,sCACA,2DAEA,4CACA,kEACA,uCACA,6DAEA,2GACA,+CAGA,+MAOA,4BACA,2FAIA,4DACA,sEACA,kEACA,sEACA,gDAGA,kCACA,uEACA,mCACA,4DACA,yDAGA,2DACA,qDAGA,0CACA,8CACA,oDACA,oDL7GF,iCAEA,iEAME,oCKyGA,yDAIA,sCACA,kCACA,sDAGA,0CACA,kEACA,oDAEA,sDAGA,oCACA,oEAIA,CAGA,yDAGA,qDACA,oDAGA,6DAIA,iEAGA,2DAEA,2DL9IE,4DAEA,gEAIF,gEKgGA,gFAIA,oNAOA,qDAEA,gFAIA,4DAIA,oEAMA,yEAIA,6DACA,0DAGA,uDAGA,qDAEA,wDLpII,6DAEA,yDACE,2DAMN,uCAIA,yCACE,8CAGF,sDMjDA,6DAKA,oCAIA,4CACA,kBAGF,sBAMA,2BAME,qCAGA,qCAEA,iCAEA,+BAEA,mCAEA,qCAIA,CACA,gCACA,gDAKA,kCAIA,6BAEA,0CAQA,kCAIF,8BAGE,8BACA,uCAGF,sCAKE,kCAEA,sDACA,uEAGE,sDACA,gGACF,wCAGI,sBACA,yHCzEJ,2BACA,qCAGF,sEAGE,kEAGA,sHAGA,2IACE,8BACA,8BAOF,uCAEA,wEAGA,sDACA,iCAKA,CAEF,qCAEE,sDACA,gCACA,gEAKA,+CAOE,sBACA,gEAGA,GAYF,yLACA,gDAGA,mBAEA,wCACA,wCAGF,CAEE,iCAGF,wBACE,mBAIF,oBAFE,eAEF,CAJE,gBAEA,CAMA,mBACA,mBAGA,mDAIA,YACA,mBAEA,CACA,kBAGF,OAJE,kBAQA,CAJF,GACE,aAGA,IACA,mCACA,qBAEF,IACE,oBAEA,aACA,CAFA,WAEA,GAEE,oBAKJ,CAPE,gBAOF,aACE,+CAGA,UAHA,kCAGA,4BACA,GAEA,uBACA,CAHA,yBAEA,CACA,yDAGF,kDAEE,SACA,8BAEA,iEAGE,yDACA,sEAEA,iEAEE,yHAKN,kDAMA,0DAIE,CANA,oBAMA,0GAOA,aAEF,CAHE,YAGF,4HAWE,+CACE,iCAIJ,0CAGE,CALE,qCAEJ,CAHI,WAMF,SAIA,0CAIA,CANF,qCAME,mBACA,gBACA,gBAIA,+CAEE,CAIF,kDAGF,CAPI,8BAGJ,CAKE,YACF,CAbE,2BAEA,CAHA,WAYF,UAEA,yBACE,kBAIA,iEAKA,iCAGA,mDAEA,mBACF,OACE,iBAQA,0CAIA,CAPA,6DAGA,CALF,qBAEE,CAOA,qCAEE,CAGA,eAHA,sBAGA,gCAKF,qBACE,WACA,aACA,sCAEA,mBAOJ,6BASE,kCACA,CAHA,sBACA,aACA,CARA,uBAGA,gBAEA,MAIA,6BAEA,yBACA,2DAEA,sBAGA,8BACA,CANA,wBAMA,2BAEE,YACA,sBACA,WAEF,CAFE,UAEF,eAeF,kBAEE,CAhBE,qDAGA,qCAOJ,CAEI,YAEJ,CAJA,2BAEI,CAIF,eACE,qBACF,4CAIE,uBACA,sBACF,cACE,CAFA,aACF,CAEE,kBADA,kBACA,yBAGF,oCACE,6DAMF,qDAGE,CC1VY,8BDgWd,oCAEA,uDAEA,CACE,8CAIA,gCAEA,YACA,8CACA,CAEA,oCAGE,CAHF,oCAGE,mBAEA,mDADA,YADA,qBACA,WACA,sBAEE,WACA,uDAGN,cACE,CAJI,YAIJ,iDAIA,uCAIA,uBACA,oCAGA,kBAEJ,CAHI,sBAGJ,mBAEE,aACE,CACA,qCAGF,YACE,CAFJ,WACE,CAME,SE3ZJ,CF0ZI,kBACA,CAHF,gBACE,CAHA,iBEtZJ,6CAEE,yBAEA,4BAEA,aAFA,iBAGA,wEAEA,UAMA,gCAIA,CARA,SAIA,UANA,qBAEA,qDAIA,CANA,OAUA,0CACE,UAEJ,iDAEE,CAFF,UAEE,aACA,iCAEA,CAFA,UAEA,wCAIA,sBADA,UACA,6CAIA,yCAEE,qBACA,CAFA,UAEA,kCAKJ,OACE,CADF,KACE,cAGE,2CADA,kBACC,CAAD,wEAGJ,CANE,aAGE,mBAFF,OAMA,gBALE,iCAFF,cACA,CADA,qBACA,SAMA,2BADF,UACE,kBAEE,sCACA,CAFF,WACE,WACA,qEACA,mBADA,YACA,6BAKJ,cACE,uDAGE,aACE,mDAEE,CAFF,6CAEE,kEACA,yCACE,uDACA,8BANN,WAMM,oBANN,CAMM,UANN,kBACE,qDACA,kCACE,6BAEE,mBADF,0CACE,CAFF,uCACA,MACE,0DACA,wCANN,gCACE,sEACA,WACE,gEACA,CADA,UACA,+CACE,oDACA,6DANN,kCACE,kCACA,gBADA,UACA,yBACE,wDACA,cADA,UACA,qBACE,6CACA,yFALJ,sCACA,CAEE,gBACE,CAHJ,gBAGI,sBAHJ,uBACE,4DACA,4CACE,iDAJJ,2CACA,CADA,gBAEE,gBAGE,sBALJ,+BAII,iBAFF,gDACA,WACE,YADF,uCACE,6EACA,2BANN,8CACE,kDACA,0CACE,8BACA,yFACE,sBACA,sFALJ,mEACA,sBACE,kEACA,6EACE,uCACA,kEALJ,qGAEE,kEACA,6EACE,uCACA,kEALJ,8CACA,uDACE,sEACA,2EACE,sCACA,iEALJ,mGACA,qCACE,oDACA,0DACE,6GACA,gDAGR,yDCpEA,sEACE,CACA,6GACE,gEACF,iGAIF,wFACE,qDAGA,mGAEE,2CAEF,4FACE,gCACF,wGACE,8DAEE,6FAIA,iJAKN,6GACE,gDAKF,yDACA,qCAGA,6BACA,kBAGA,qDAKA,oCAEA,+DACE,2CAIA,oDAKF,sCACE,8BAGF,qBACA,wDAGA,uCAEA,kEAGA,8CAEA,uDAKA,gEAEE,6BAGJ,gEC5FE,+CAEA,0ECFF,sDAGE,+DAKA,qEACE,mCACA,wBAEA,4FAKA,gBCjBJ,yGAIE,kBACA,CAMA,2MAYA,4HAUE,iCAEF,CAHA,wBAGA,8GAQE,mBACA,2GAOJ,mBACE,CACA,4HAKE,+IAWJ,eAEE,CAFF,YAEE,4FAIA,8BAEA,uBASI,sCACA,CAFF,oBACE,CANJ,wCACA,CAFA,8BACA,CADA,gBAIA,+BAEE,mBAEE,6BAIJ,4CAGE,kDAMF,gBACE,kEACA,8BACA,yBAEA,8BACA,sCAEF,cACE,+BACA,CAFF,eAEE,YACA,2EAGF,iBACE,CACA,yDAKE,sBADF,kBAEE,+BAIJ,4BACE,aAEA,qBAFA,gBAhHsB,CAmHtB,wBACA,mGClIF,iCAKF,mBACE,0FAIA,iDACA,CADA,2CACA,8BAEE,6BACE,yBAEF,8CAIE,wDAEA,gDAGJ,+CAKF,aACE,wCACA,kDAEF,YAEE,CAFF,YAEE,CClCA,qGACA,mCAIA,gBACE,iCAGA,gCACE,aAEJ,CAHE,uBAGF,mBAKA,6CAGE,CALA,mBAEF,CAGE,kCAEF,CARE,kBACA,CAFA,eASF,YAEE,mBACA,CAHF,UAGE,wCC7BJ,oBDkCE,8CAEE,iBCpCJ,iBACE,wDACA,gEASE,6CCLF,CDIE,uBACA,CALF,oBACE,4BAEF,8BCAE,2CAEE,CALJ,kCAGE,CDHF,aAGA,eACE,CAJF,uBCKI,gCAEF,gDAGA,kDAGE,iBAIF,cADF,UACE,uBAEA,iCAEA,wCAEA,6CAEA,CASE,+BASJ,CAZE,4BAGE,CATF,kCAMA,kCAYF,4BACE,2DAEA,CAHF,+BACE,CADF,qBAGE,2GAGA,wIAEE,CAFF,8EAEE,qBACA,oCAGF,6RAIA,sGACE,oDChEJ,WAEF,yBACE,QACA,eAEA,gBAEE,uCAGA,CALF,iCAKE,uCAGA,0BACA,CACA,oBACA,iCClBJ,gBACE,KAGF,qBACE,YAGF,CAHE,cAGF,gCAEE,mBACA,iEAEA,oCACA,wCAEA,sBACA,WAEA,CAFA,YAEA,8EAEA,mCAFA,iBAEA,6BAIA,wEAKA,sDAIE,CARF,mDAIA,CAIE,cAEF,8CAIA,oBAFE,iBAEF,8CAGE,eAEF,CAFE,YAEF,OAEE,kBAGJ,CAJI,eACA,CAFF,mBAKF,yCCjDE,oBACA,CAFA,iBAEA,uCAKE,iBACA,qCAGA,mBCZJ,CDWI,gBCXJ,6BAEE,eACA,sBAGA,eAEA,sBACA,oDACA,iGAMA,gBAFE,YAEF,8FAME,iJClBF,YACA,gNAUE,6BAEF,oTAcI,kBACF,gHAIA,qBACE,eACF,qDACE,kBACF,6DACE,4BCxCJ,oBAEF,qCAEI,+CAGF,uBACE,uDAGJ,oBAkBE,mDAhBA,+CAaA,CAbA,oBAaA,0FAEE,CAFF,gGAbA,+BAaA,0BAGA,mQAIA,oNAEE,kCADA,gBACA,aAGJ,sDAHI,mBAGJ,yBAYI,+VACE,sDAGA,iBAHA,2BAGA,kWAGN,iDAEE,CALI,gGAGN,CAHM,gBAKJ,yCAGF,0EACE,2EAGF,iBACE,yDAOA,0EAGF,6EAEE,iBC/EA,wDACA,4DACA,qBAEA,oDCDA,6BACA,yBACA,sBAEA,iBAGF,sNAYE,iBAEA,kBAdF,wRA8BI,kBACA,iOAkBA,aACA,4DACE,uEAEA,uVAoBA,iDAKA,ieC1EJ,4BACA,CCFF,6JAEE,iDACA,sEAIA,mDAGA,iDAOF,4DAGE,8CAEA,CAEA,kBACA,CAHA,gCAEA,CACA,eADA,cACA,oBAEE,uBAFF,kCAEE,gCAEF,kBACE,CAIA,mDAEA,CAHA,uCACA,CALF,aACE,6BAEA,CAIA,gBAJA,mCACA,CADA,gBAIA,wBACA,6CAGF,YAHE,iBAGF,gCAGA,iEACA,6CAEA,qDACA,6EACA,2EACA,8GAEA,yCAGA,uBACA,CAFA,yBACA,CACA,yDAKA,kDACE,mFAKJ,oCACE,CANE,aAKJ,CACE,qEAIA,YAFA,WAEA,CAHA,aACA,CAEA,gBACE,4BACA,sBADA,aACA,gCAMF,oCACA,yDACA,2CAEA,qBAGE,kBAEA,CACA,mCAIF,CARE,YACA,CAOF,iCAEE,CAPA,oBACA,CAQA,oBACE,uDAEJ,sDAGA,CAHA,cAGA,0BACE,oDAIA,oCACA,4BACA,sBAGA,cAEA,oFAGA,sBAEA,yDACE,CAIA,iBAJA,wBAIA,6CAJA,6CAOA,4BAGJ,CAHI,cAGJ,yCAGA,kBACE,CAIA,iDAEA,CATA,YAEF,CACE,4CAGA,kBAIA,wEAEA,wDAIF,kCAOE,iDACA,CARF,WAIE,sCAGA,CANA,2CACA,CAMA,oEARF,iBACE,CACA,qCAMA,iBAuBE,uBAlBF,YAKA,2DALA,uDAKA,CALA,sBAiBA,4CACE,CALA,gRAIF,YACE,UAEN,uBACE,YACA,mCAOE,+CAGA,8BAGF,+CAGA,4BCjNA,SDiNA,qFCjNA,gDAGA,sCACA,qCACA,sDAIF,CAIE,kDAGA,CAPF,0CAOE,kBAEA,kDAEA,CAHA,eACA,CAFA,YACA,CADA,SAIA,mHAIE,CAGA,6CAFA,oCAeE,CAbF,yBACE,qBAEJ,CAGE,oBACA,CAEA,YAFA,2CACF,CACE,uBAEA,mFAEE,CALJ,oBACE,CAEA,UAEE,gCAGF,sDAEA,yCC7CJ,oCAGA,CD6CE,yXAQE,sCCrDJ,wCAGA,oCACE","sources":["webpack:///./node_modules/normalize.css/normalize.css","webpack:///./src/furo/assets/styles/base/_print.sass","webpack:///./src/furo/assets/styles/base/_screen-readers.sass","webpack:///./src/furo/assets/styles/base/_theme.sass","webpack:///./src/furo/assets/styles/variables/_fonts.scss","webpack:///./src/furo/assets/styles/variables/_spacing.scss","webpack:///./src/furo/assets/styles/variables/_icons.scss","webpack:///./src/furo/assets/styles/variables/_admonitions.scss","webpack:///./src/furo/assets/styles/variables/_colors.scss","webpack:///./src/furo/assets/styles/base/_typography.sass","webpack:///./src/furo/assets/styles/_scaffold.sass","webpack:///./src/furo/assets/styles/variables/_layout.scss","webpack:///./src/furo/assets/styles/content/_admonitions.sass","webpack:///./src/furo/assets/styles/content/_api.sass","webpack:///./src/furo/assets/styles/content/_blocks.sass","webpack:///./src/furo/assets/styles/content/_captions.sass","webpack:///./src/furo/assets/styles/content/_code.sass","webpack:///./src/furo/assets/styles/content/_footnotes.sass","webpack:///./src/furo/assets/styles/content/_images.sass","webpack:///./src/furo/assets/styles/content/_indexes.sass","webpack:///./src/furo/assets/styles/content/_lists.sass","webpack:///./src/furo/assets/styles/content/_math.sass","webpack:///./src/furo/assets/styles/content/_misc.sass","webpack:///./src/furo/assets/styles/content/_rubrics.sass","webpack:///./src/furo/assets/styles/content/_sidebar.sass","webpack:///./src/furo/assets/styles/content/_tables.sass","webpack:///./src/furo/assets/styles/content/_target.sass","webpack:///./src/furo/assets/styles/content/_gui-labels.sass","webpack:///./src/furo/assets/styles/components/_footer.sass","webpack:///./src/furo/assets/styles/components/_search.sass","webpack:///./src/furo/assets/styles/components/_sidebar.sass","webpack:///./src/furo/assets/styles/components/_table_of_contents.sass","webpack:///./src/furo/assets/styles/_shame.sass"],"sourcesContent":["/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */\n\n/* Document\n ========================================================================== */\n\n/**\n * 1. Correct the line height in all browsers.\n * 2. Prevent adjustments of font size after orientation changes in iOS.\n */\n\nhtml {\n line-height: 1.15; /* 1 */\n -webkit-text-size-adjust: 100%; /* 2 */\n}\n\n/* Sections\n ========================================================================== */\n\n/**\n * Remove the margin in all browsers.\n */\n\nbody {\n margin: 0;\n}\n\n/**\n * Render the `main` element consistently in IE.\n */\n\nmain {\n display: block;\n}\n\n/**\n * Correct the font size and margin on `h1` elements within `section` and\n * `article` contexts in Chrome, Firefox, and Safari.\n */\n\nh1 {\n font-size: 2em;\n margin: 0.67em 0;\n}\n\n/* Grouping content\n ========================================================================== */\n\n/**\n * 1. Add the correct box sizing in Firefox.\n * 2. Show the overflow in Edge and IE.\n */\n\nhr {\n box-sizing: content-box; /* 1 */\n height: 0; /* 1 */\n overflow: visible; /* 2 */\n}\n\n/**\n * 1. Correct the inheritance and scaling of font size in all browsers.\n * 2. Correct the odd `em` font sizing in all browsers.\n */\n\npre {\n font-family: monospace, monospace; /* 1 */\n font-size: 1em; /* 2 */\n}\n\n/* Text-level semantics\n ========================================================================== */\n\n/**\n * Remove the gray background on active links in IE 10.\n */\n\na {\n background-color: transparent;\n}\n\n/**\n * 1. Remove the bottom border in Chrome 57-\n * 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.\n */\n\nabbr[title] {\n border-bottom: none; /* 1 */\n text-decoration: underline; /* 2 */\n text-decoration: underline dotted; /* 2 */\n}\n\n/**\n * Add the correct font weight in Chrome, Edge, and Safari.\n */\n\nb,\nstrong {\n font-weight: bolder;\n}\n\n/**\n * 1. Correct the inheritance and scaling of font size in all browsers.\n * 2. Correct the odd `em` font sizing in all browsers.\n */\n\ncode,\nkbd,\nsamp {\n font-family: monospace, monospace; /* 1 */\n font-size: 1em; /* 2 */\n}\n\n/**\n * Add the correct font size in all browsers.\n */\n\nsmall {\n font-size: 80%;\n}\n\n/**\n * Prevent `sub` and `sup` elements from affecting the line height in\n * all browsers.\n */\n\nsub,\nsup {\n font-size: 75%;\n line-height: 0;\n position: relative;\n vertical-align: baseline;\n}\n\nsub {\n bottom: -0.25em;\n}\n\nsup {\n top: -0.5em;\n}\n\n/* Embedded content\n ========================================================================== */\n\n/**\n * Remove the border on images inside links in IE 10.\n */\n\nimg {\n border-style: none;\n}\n\n/* Forms\n ========================================================================== */\n\n/**\n * 1. Change the font styles in all browsers.\n * 2. Remove the margin in Firefox and Safari.\n */\n\nbutton,\ninput,\noptgroup,\nselect,\ntextarea {\n font-family: inherit; /* 1 */\n font-size: 100%; /* 1 */\n line-height: 1.15; /* 1 */\n margin: 0; /* 2 */\n}\n\n/**\n * Show the overflow in IE.\n * 1. Show the overflow in Edge.\n */\n\nbutton,\ninput { /* 1 */\n overflow: visible;\n}\n\n/**\n * Remove the inheritance of text transform in Edge, Firefox, and IE.\n * 1. Remove the inheritance of text transform in Firefox.\n */\n\nbutton,\nselect { /* 1 */\n text-transform: none;\n}\n\n/**\n * Correct the inability to style clickable types in iOS and Safari.\n */\n\nbutton,\n[type=\"button\"],\n[type=\"reset\"],\n[type=\"submit\"] {\n -webkit-appearance: button;\n}\n\n/**\n * Remove the inner border and padding in Firefox.\n */\n\nbutton::-moz-focus-inner,\n[type=\"button\"]::-moz-focus-inner,\n[type=\"reset\"]::-moz-focus-inner,\n[type=\"submit\"]::-moz-focus-inner {\n border-style: none;\n padding: 0;\n}\n\n/**\n * Restore the focus styles unset by the previous rule.\n */\n\nbutton:-moz-focusring,\n[type=\"button\"]:-moz-focusring,\n[type=\"reset\"]:-moz-focusring,\n[type=\"submit\"]:-moz-focusring {\n outline: 1px dotted ButtonText;\n}\n\n/**\n * Correct the padding in Firefox.\n */\n\nfieldset {\n padding: 0.35em 0.75em 0.625em;\n}\n\n/**\n * 1. Correct the text wrapping in Edge and IE.\n * 2. Correct the color inheritance from `fieldset` elements in IE.\n * 3. Remove the padding so developers are not caught out when they zero out\n * `fieldset` elements in all browsers.\n */\n\nlegend {\n box-sizing: border-box; /* 1 */\n color: inherit; /* 2 */\n display: table; /* 1 */\n max-width: 100%; /* 1 */\n padding: 0; /* 3 */\n white-space: normal; /* 1 */\n}\n\n/**\n * Add the correct vertical alignment in Chrome, Firefox, and Opera.\n */\n\nprogress {\n vertical-align: baseline;\n}\n\n/**\n * Remove the default vertical scrollbar in IE 10+.\n */\n\ntextarea {\n overflow: auto;\n}\n\n/**\n * 1. Add the correct box sizing in IE 10.\n * 2. Remove the padding in IE 10.\n */\n\n[type=\"checkbox\"],\n[type=\"radio\"] {\n box-sizing: border-box; /* 1 */\n padding: 0; /* 2 */\n}\n\n/**\n * Correct the cursor style of increment and decrement buttons in Chrome.\n */\n\n[type=\"number\"]::-webkit-inner-spin-button,\n[type=\"number\"]::-webkit-outer-spin-button {\n height: auto;\n}\n\n/**\n * 1. Correct the odd appearance in Chrome and Safari.\n * 2. Correct the outline style in Safari.\n */\n\n[type=\"search\"] {\n -webkit-appearance: textfield; /* 1 */\n outline-offset: -2px; /* 2 */\n}\n\n/**\n * Remove the inner padding in Chrome and Safari on macOS.\n */\n\n[type=\"search\"]::-webkit-search-decoration {\n -webkit-appearance: none;\n}\n\n/**\n * 1. Correct the inability to style clickable types in iOS and Safari.\n * 2. Change font properties to `inherit` in Safari.\n */\n\n::-webkit-file-upload-button {\n -webkit-appearance: button; /* 1 */\n font: inherit; /* 2 */\n}\n\n/* Interactive\n ========================================================================== */\n\n/*\n * Add the correct display in Edge, IE 10+, and Firefox.\n */\n\ndetails {\n display: block;\n}\n\n/*\n * Add the correct display in all browsers.\n */\n\nsummary {\n display: list-item;\n}\n\n/* Misc\n ========================================================================== */\n\n/**\n * Add the correct display in IE 10+.\n */\n\ntemplate {\n display: none;\n}\n\n/**\n * Add the correct display in IE 10.\n */\n\n[hidden] {\n display: none;\n}\n","// This file contains styles for managing print media.\n\n////////////////////////////////////////////////////////////////////////////////\n// Hide elements not relevant to print media.\n////////////////////////////////////////////////////////////////////////////////\n@media print\n // Hide icon container.\n .content-icon-container\n display: none !important\n\n // Hide showing header links if hovering over when printing.\n .headerlink\n display: none !important\n\n // Hide mobile header.\n .mobile-header\n display: none !important\n\n // Hide navigation links.\n .related-pages\n display: none !important\n\n////////////////////////////////////////////////////////////////////////////////\n// Tweaks related to decolorization.\n////////////////////////////////////////////////////////////////////////////////\n@media print\n // Apply a border around code which no longer have a color background.\n .highlight\n border: 0.1pt solid var(--color-foreground-border)\n\n////////////////////////////////////////////////////////////////////////////////\n// Avoid page break in some relevant cases.\n////////////////////////////////////////////////////////////////////////////////\n@media print\n ul, ol, dl, a, table, pre, blockquote\n page-break-inside: avoid\n\n h1, h2, h3, h4, h5, h6, img, figure, caption\n page-break-inside: avoid\n page-break-after: avoid\n\n ul, ol, dl\n page-break-before: avoid\n",".visually-hidden\n position: absolute !important\n width: 1px !important\n height: 1px !important\n padding: 0 !important\n margin: -1px !important\n overflow: hidden !important\n clip: rect(0,0,0,0) !important\n white-space: nowrap !important\n border: 0 !important\n\n:-moz-focusring\n outline: auto\n","// This file serves as the \"skeleton\" of the theming logic.\n//\n// This contains the bulk of the logic for handling dark mode, color scheme\n// toggling and the handling of color-scheme-specific hiding of elements.\n\nbody\n @include fonts\n @include spacing\n @include icons\n @include admonitions\n @include default-admonition(#651fff, \"abstract\")\n @include default-topic(#14B8A6, \"pencil\")\n\n @include colors\n\n.only-light\n display: block !important\nhtml body .only-dark\n display: none !important\n\n// Ignore dark-mode hints if print media.\n@media not print\n // Enable dark-mode, if requested.\n body[data-theme=\"dark\"]\n @include colors-dark\n\n html & .only-light\n display: none !important\n .only-dark\n display: block !important\n\n // Enable dark mode, unless explicitly told to avoid.\n @media (prefers-color-scheme: dark)\n body:not([data-theme=\"light\"])\n @include colors-dark\n\n html & .only-light\n display: none !important\n .only-dark\n display: block !important\n\n//\n// Theme toggle presentation\n//\nbody[data-theme=\"auto\"]\n .theme-toggle svg.theme-icon-when-auto\n display: block\n\nbody[data-theme=\"dark\"]\n .theme-toggle svg.theme-icon-when-dark\n display: block\n\nbody[data-theme=\"light\"]\n .theme-toggle svg.theme-icon-when-light\n display: block\n","// Fonts used by this theme.\n//\n// There are basically two things here -- using the system font stack and\n// defining sizes for various elements in %ages. We could have also used `em`\n// but %age is easier to reason about for me.\n\n@mixin fonts {\n // These are adapted from https://systemfontstack.com/\n --font-stack: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial,\n sans-serif, Apple Color Emoji, Segoe UI Emoji;\n --font-stack--monospace: \"SFMono-Regular\", Menlo, Consolas, Monaco,\n Liberation Mono, Lucida Console, monospace;\n\n --font-size--normal: 100%;\n --font-size--small: 87.5%;\n --font-size--small--2: 81.25%;\n --font-size--small--3: 75%;\n --font-size--small--4: 62.5%;\n\n // Sidebar\n --sidebar-caption-font-size: var(--font-size--small--2);\n --sidebar-item-font-size: var(--font-size--small);\n --sidebar-search-input-font-size: var(--font-size--small);\n\n // Table of Contents\n --toc-font-size: var(--font-size--small--3);\n --toc-font-size--mobile: var(--font-size--normal);\n --toc-title-font-size: var(--font-size--small--4);\n\n // Admonitions\n //\n // These aren't defined in terms of %ages, since nesting these is permitted.\n --admonition-font-size: 0.8125rem;\n --admonition-title-font-size: 0.8125rem;\n\n // Code\n --code-font-size: var(--font-size--small--2);\n\n // API\n --api-font-size: var(--font-size--small);\n}\n","// Spacing for various elements on the page\n//\n// If the user wants to tweak things in a certain way, they are permitted to.\n// They also have to deal with the consequences though!\n\n@mixin spacing {\n // Header!\n --header-height: calc(\n var(--sidebar-item-line-height) + 4 * #{var(--sidebar-item-spacing-vertical)}\n );\n --header-padding: 0.5rem;\n\n // Sidebar\n --sidebar-tree-space-above: 1.5rem;\n --sidebar-caption-space-above: 1rem;\n\n --sidebar-item-line-height: 1rem;\n --sidebar-item-spacing-vertical: 0.5rem;\n --sidebar-item-spacing-horizontal: 1rem;\n --sidebar-item-height: calc(\n var(--sidebar-item-line-height) + 2 *#{var(--sidebar-item-spacing-vertical)}\n );\n\n --sidebar-expander-width: var(--sidebar-item-height); // be square\n\n --sidebar-search-space-above: 0.5rem;\n --sidebar-search-input-spacing-vertical: 0.5rem;\n --sidebar-search-input-spacing-horizontal: 0.5rem;\n --sidebar-search-input-height: 1rem;\n --sidebar-search-icon-size: var(--sidebar-search-input-height);\n\n // Table of Contents\n --toc-title-padding: 0.25rem 0;\n --toc-spacing-vertical: 1.5rem;\n --toc-spacing-horizontal: 1.5rem;\n --toc-item-spacing-vertical: 0.4rem;\n --toc-item-spacing-horizontal: 1rem;\n}\n","// Expose theme icons as CSS variables.\n\n$icons: (\n // Adapted from tabler-icons\n // url: https://tablericons.com/\n \"search\":\n url('data:image/svg+xml;charset=utf-8,'),\n // Factored out from mkdocs-material on 24-Aug-2020.\n // url: https://squidfunk.github.io/mkdocs-material/reference/admonitions/\n \"pencil\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"abstract\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"info\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"flame\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"question\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"warning\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"failure\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"spark\":\n url('data:image/svg+xml;charset=utf-8,')\n);\n\n@mixin icons {\n @each $name, $glyph in $icons {\n --icon-#{$name}: #{$glyph};\n }\n}\n","// Admonitions\n\n// Structure of these is:\n// admonition-class: color \"icon-name\";\n//\n// The colors are translated into CSS variables below. The icons are\n// used directly in the main declarations to set the `mask-image` in\n// the title.\n\n// prettier-ignore\n$admonitions: (\n // Each of these has an reST directives for it.\n \"caution\": #ff9100 \"spark\",\n \"warning\": #ff9100 \"warning\",\n \"danger\": #ff5252 \"spark\",\n \"attention\": #ff5252 \"warning\",\n \"error\": #ff5252 \"failure\",\n \"hint\": #00c852 \"question\",\n \"tip\": #00c852 \"info\",\n \"important\": #00bfa5 \"flame\",\n \"note\": #00b0ff \"pencil\",\n \"seealso\": #448aff \"info\",\n \"admonition-todo\": #808080 \"pencil\"\n);\n\n@mixin default-admonition($color, $icon-name) {\n --color-admonition-title: #{$color};\n --color-admonition-title-background: #{rgba($color, 0.1)};\n\n --icon-admonition-default: var(--icon-#{$icon-name});\n}\n\n@mixin default-topic($color, $icon-name) {\n --color-topic-title: #{$color};\n --color-topic-title-background: #{rgba($color, 0.1)};\n\n --icon-topic-default: var(--icon-#{$icon-name});\n}\n\n@mixin admonitions {\n @each $name, $values in $admonitions {\n --color-admonition-title--#{$name}: #{nth($values, 1)};\n --color-admonition-title-background--#{$name}: #{rgba(\n nth($values, 1),\n 0.1\n )};\n }\n}\n","// Colors used throughout this theme.\n//\n// The aim is to give the user more control. Thus, instead of hard-coding colors\n// in various parts of the stylesheet, the approach taken is to define all\n// colors as CSS variables and reusing them in all the places.\n//\n// `colors-dark` depends on `colors` being included at a lower specificity.\n\n@mixin colors {\n --color-problematic: #b30000;\n\n // Base Colors\n --color-foreground-primary: black; // for main text and headings\n --color-foreground-secondary: #5a5c63; // for secondary text\n --color-foreground-muted: #646776; // for muted text\n --color-foreground-border: #878787; // for content borders\n\n --color-background-primary: white; // for content\n --color-background-secondary: #f8f9fb; // for navigation + ToC\n --color-background-hover: #efeff4ff; // for navigation-item hover\n --color-background-hover--transparent: #efeff400;\n --color-background-border: #eeebee; // for UI borders\n --color-background-item: #ccc; // for \"background\" items (eg: copybutton)\n\n // Announcements\n --color-announcement-background: #000000dd;\n --color-announcement-text: #eeebee;\n\n // Brand colors\n --color-brand-primary: #2962ff;\n --color-brand-content: #2a5adf;\n\n // API documentation\n --color-api-background: var(--color-background-secondary);\n --color-api-background-hover: var(--color-background-hover);\n --color-api-overall: var(--color-foreground-secondary);\n --color-api-name: var(--color-problematic);\n --color-api-pre-name: var(--color-problematic);\n --color-api-paren: var(--color-foreground-secondary);\n --color-api-keyword: var(--color-foreground-primary);\n --color-highlight-on-target: #ffffcc;\n\n // Inline code background\n --color-inline-code-background: var(--color-background-secondary);\n\n // Highlighted text (search)\n --color-highlighted-background: #ddeeff;\n --color-highlighted-text: var(--color-foreground-primary);\n\n // GUI Labels\n --color-guilabel-background: #ddeeff80;\n --color-guilabel-border: #bedaf580;\n --color-guilabel-text: var(--color-foreground-primary);\n\n // Admonitions!\n --color-admonition-background: transparent;\n\n //////////////////////////////////////////////////////////////////////////////\n // Everything below this should be one of:\n // - var(...)\n // - *-gradient(...)\n // - special literal values (eg: transparent, none)\n //////////////////////////////////////////////////////////////////////////////\n\n // Tables\n --color-table-header-background: var(--color-background-secondary);\n --color-table-border: var(--color-background-border);\n\n // Cards\n --color-card-border: var(--color-background-secondary);\n --color-card-background: transparent;\n --color-card-marginals-background: var(--color-background-secondary);\n\n // Header\n --color-header-background: var(--color-background-primary);\n --color-header-border: var(--color-background-border);\n --color-header-text: var(--color-foreground-primary);\n\n // Sidebar (left)\n --color-sidebar-background: var(--color-background-secondary);\n --color-sidebar-background-border: var(--color-background-border);\n\n --color-sidebar-brand-text: var(--color-foreground-primary);\n --color-sidebar-caption-text: var(--color-foreground-muted);\n --color-sidebar-link-text: var(--color-foreground-secondary);\n --color-sidebar-link-text--top-level: var(--color-brand-primary);\n\n --color-sidebar-item-background: var(--color-sidebar-background);\n --color-sidebar-item-background--current: var(\n --color-sidebar-item-background\n );\n --color-sidebar-item-background--hover: linear-gradient(\n 90deg,\n var(--color-background-hover--transparent) 0%,\n var(--color-background-hover) var(--sidebar-item-spacing-horizontal),\n var(--color-background-hover) 100%\n );\n\n --color-sidebar-item-expander-background: transparent;\n --color-sidebar-item-expander-background--hover: var(\n --color-background-hover\n );\n\n --color-sidebar-search-text: var(--color-foreground-primary);\n --color-sidebar-search-background: var(--color-background-secondary);\n --color-sidebar-search-background--focus: var(--color-background-primary);\n --color-sidebar-search-border: var(--color-background-border);\n --color-sidebar-search-icon: var(--color-foreground-muted);\n\n // Table of Contents (right)\n --color-toc-background: var(--color-background-primary);\n --color-toc-title-text: var(--color-foreground-muted);\n --color-toc-item-text: var(--color-foreground-secondary);\n --color-toc-item-text--hover: var(--color-foreground-primary);\n --color-toc-item-text--active: var(--color-brand-primary);\n\n // Actual page contents\n --color-content-foreground: var(--color-foreground-primary);\n --color-content-background: transparent;\n\n // Links\n --color-link: var(--color-brand-content);\n --color-link--hover: var(--color-brand-content);\n --color-link-underline: var(--color-background-border);\n --color-link-underline--hover: var(--color-foreground-border);\n}\n\n@mixin colors-dark {\n --color-problematic: #ee5151;\n\n // Base Colors\n --color-foreground-primary: #ffffffcc; // for main text and headings\n --color-foreground-secondary: #9ca0a5; // for secondary text\n --color-foreground-muted: #81868d; // for muted text\n --color-foreground-border: #666666; // for content borders\n\n --color-background-primary: #131416; // for content\n --color-background-secondary: #1a1c1e; // for navigation + ToC\n --color-background-hover: #1e2124ff; // for navigation-item hover\n --color-background-hover--transparent: #1e212400;\n --color-background-border: #303335; // for UI borders\n --color-background-item: #444; // for \"background\" items (eg: copybutton)\n\n // Announcements\n --color-announcement-background: #000000dd;\n --color-announcement-text: #eeebee;\n\n // Brand colors\n --color-brand-primary: #2b8cee;\n --color-brand-content: #368ce2;\n\n // Highlighted text (search)\n --color-highlighted-background: #083563;\n\n // GUI Labels\n --color-guilabel-background: #08356380;\n --color-guilabel-border: #13395f80;\n\n // API documentation\n --color-api-keyword: var(--color-foreground-secondary);\n --color-highlight-on-target: #333300;\n\n // Admonitions\n --color-admonition-background: #18181a;\n\n // Cards\n --color-card-border: var(--color-background-secondary);\n --color-card-background: #18181a;\n --color-card-marginals-background: var(--color-background-hover);\n}\n","// This file contains the styling for making the content throughout the page,\n// including fonts, paragraphs, headings and spacing among these elements.\n\nbody\n font-family: var(--font-stack)\npre,\ncode,\nkbd,\nsamp\n font-family: var(--font-stack--monospace)\n\n// Make fonts look slightly nicer.\nbody\n -webkit-font-smoothing: antialiased\n -moz-osx-font-smoothing: grayscale\n\n// Line height from Bootstrap 4.1\narticle\n line-height: 1.5\n\n//\n// Headings\n//\nh1,\nh2,\nh3,\nh4,\nh5,\nh6\n line-height: 1.25\n font-weight: bold\n\n border-radius: 0.5rem\n margin-top: 0.5rem\n margin-bottom: 0.5rem\n margin-left: -0.5rem\n margin-right: -0.5rem\n padding-left: 0.5rem\n padding-right: 0.5rem\n\n + p\n margin-top: 0\n\nh1\n font-size: 2.5em\n margin-top: 1.75rem\n margin-bottom: 1rem\nh2\n font-size: 2em\n margin-top: 1.75rem\nh3\n font-size: 1.5em\nh4\n font-size: 1.25em\nh5\n font-size: 1.125em\nh6\n font-size: 1em\n\nsmall\n opacity: 75%\n font-size: 80%\n\n// Paragraph\np\n margin-top: 0.5rem\n margin-bottom: 0.75rem\n\n// Horizontal rules\nhr.docutils\n height: 1px\n padding: 0\n margin: 2rem 0\n background-color: var(--color-background-border)\n border: 0\n\n.centered\n text-align: center\n\n// Links\na\n text-decoration: underline\n\n color: var(--color-link)\n text-decoration-color: var(--color-link-underline)\n\n &:hover\n color: var(--color-link--hover)\n text-decoration-color: var(--color-link-underline--hover)\n &.muted-link\n color: inherit\n &:hover\n color: var(--color-link)\n text-decoration-color: var(--color-link-underline--hover)\n","// This file contains the styles for the overall layouting of the documentation\n// skeleton, including the responsive changes as well as sidebar toggles.\n//\n// This is implemented as a mobile-last design, which isn't ideal, but it is\n// reasonably good-enough and I got pretty tired by the time I'd finished this\n// to move the rules around to fix this. Shouldn't take more than 3-4 hours,\n// if you know what you're doing tho.\n\n// HACK: Not all browsers account for the scrollbar width in media queries.\n// This results in horizontal scrollbars in the breakpoint where we go\n// from displaying everything to hiding the ToC. We accomodate for this by\n// adding a bit of padding to the TOC drawer, disabling the horizontal\n// scrollbar and allowing the scrollbars to cover the padding.\n// https://www.456bereastreet.com/archive/201301/media_query_width_and_vertical_scrollbars/\n\n// HACK: Always having the scrollbar visible, prevents certain browsers from\n// causing the content to stutter horizontally between taller-than-viewport and\n// not-taller-than-viewport pages.\n\nhtml\n overflow-x: hidden\n overflow-y: scroll\n scroll-behavior: smooth\n\n.sidebar-scroll, .toc-scroll, article[role=main] *\n // Override Firefox scrollbar style\n scrollbar-width: thin\n scrollbar-color: var(--color-foreground-border) transparent\n\n // Override Chrome scrollbar styles\n &::-webkit-scrollbar\n width: 0.25rem\n height: 0.25rem\n &::-webkit-scrollbar-thumb\n background-color: var(--color-foreground-border)\n border-radius: 0.125rem\n\n//\n// Overalls\n//\nhtml,\nbody\n height: 100%\n color: var(--color-foreground-primary)\n background: var(--color-background-primary)\n\narticle\n color: var(--color-content-foreground)\n background: var(--color-content-background)\n\n.page\n display: flex\n // fill the viewport for pages with little content.\n min-height: 100%\n\n.mobile-header\n width: 100%\n height: var(--header-height)\n background-color: var(--color-header-background)\n color: var(--color-header-text)\n border-bottom: 1px solid var(--color-header-border)\n\n // Looks like sub-script/super-script have this, and we need this to\n // be \"on top\" of those.\n z-index: 10\n\n // We don't show the header on large screens.\n display: none\n\n // Add shadow when scrolled\n &.scrolled\n border-bottom: none\n box-shadow: 0 0 0.2rem rgba(0, 0, 0, 0.1), 0 0.2rem 0.4rem rgba(0, 0, 0, 0.2)\n\n .header-center\n a\n color: var(--color-header-text)\n text-decoration: none\n\n.main\n display: flex\n flex: 1\n\n// Sidebar (left) also covers the entire left portion of screen.\n.sidebar-drawer\n box-sizing: border-box\n\n border-right: 1px solid var(--color-sidebar-background-border)\n background: var(--color-sidebar-background)\n\n display: flex\n justify-content: flex-end\n // These next two lines took me two days to figure out.\n width: calc((100% - #{$full-width}) / 2 + #{$sidebar-width})\n min-width: $sidebar-width\n\n// Scroll-along sidebars\n.sidebar-container,\n.toc-drawer\n box-sizing: border-box\n width: $sidebar-width\n\n.toc-drawer\n background: var(--color-toc-background)\n // See HACK described on top of this document\n padding-right: 1rem\n\n.sidebar-sticky,\n.toc-sticky\n position: sticky\n top: 0\n height: min(100%, 100vh)\n height: 100vh\n\n display: flex\n flex-direction: column\n\n.sidebar-scroll,\n.toc-scroll\n flex-grow: 1\n flex-shrink: 1\n\n overflow: auto\n scroll-behavior: smooth\n\n// Central items.\n.content\n padding: 0 $content-padding\n width: $content-width\n\n display: flex\n flex-direction: column\n justify-content: space-between\n\n.icon\n display: inline-block\n height: 1rem\n width: 1rem\n svg\n width: 100%\n height: 100%\n\n//\n// Accommodate announcement banner\n//\n.announcement\n background-color: var(--color-announcement-background)\n color: var(--color-announcement-text)\n\n height: var(--header-height)\n display: flex\n align-items: center\n overflow-x: auto\n & + .page\n min-height: calc(100% - var(--header-height))\n\n.announcement-content\n box-sizing: border-box\n padding: 0.5rem\n min-width: 100%\n white-space: nowrap\n text-align: center\n\n a\n color: var(--color-announcement-text)\n text-decoration-color: var(--color-announcement-text)\n\n &:hover\n color: var(--color-announcement-text)\n text-decoration-color: var(--color-link--hover)\n\n////////////////////////////////////////////////////////////////////////////////\n// Toggles for theme\n////////////////////////////////////////////////////////////////////////////////\n.no-js .theme-toggle-container // don't show theme toggle if there's no JS\n display: none\n\n.theme-toggle-container\n vertical-align: middle\n\n.theme-toggle\n cursor: pointer\n border: none\n padding: 0\n background: transparent\n\n.theme-toggle svg\n vertical-align: middle\n height: 1rem\n width: 1rem\n color: var(--color-foreground-primary)\n display: none\n\n.theme-toggle-header\n float: left\n padding: 1rem 0.5rem\n\n////////////////////////////////////////////////////////////////////////////////\n// Toggles for elements\n////////////////////////////////////////////////////////////////////////////////\n.toc-overlay-icon, .nav-overlay-icon\n display: none\n cursor: pointer\n\n .icon\n color: var(--color-foreground-secondary)\n height: 1rem\n width: 1rem\n\n.toc-header-icon, .nav-overlay-icon\n // for when we set display: flex\n justify-content: center\n align-items: center\n\n.toc-content-icon\n height: 1.5rem\n width: 1.5rem\n\n.content-icon-container\n float: right\n display: flex\n margin-top: 1.5rem\n margin-left: 1rem\n margin-bottom: 1rem\n gap: 0.5rem\n\n .edit-this-page svg\n color: inherit\n height: 1rem\n width: 1rem\n\n.sidebar-toggle\n position: absolute\n display: none\n// \n.sidebar-toggle[name=\"__toc\"]\n left: 20px\n.sidebar-toggle:checked\n left: 40px\n// \n\n.overlay\n position: fixed\n top: 0\n width: 0\n height: 0\n\n transition: width 0ms, height 0ms, opacity 250ms ease-out\n\n opacity: 0\n background-color: rgba(0, 0, 0, 0.54)\n.sidebar-overlay\n z-index: 20\n.toc-overlay\n z-index: 40\n\n// Keep things on top and smooth.\n.sidebar-drawer\n z-index: 30\n transition: left 250ms ease-in-out\n.toc-drawer\n z-index: 50\n transition: right 250ms ease-in-out\n\n// Show the Sidebar\n#__navigation:checked\n & ~ .sidebar-overlay\n width: 100%\n height: 100%\n opacity: 1\n & ~ .page\n .sidebar-drawer\n top: 0\n left: 0\n // Show the toc sidebar\n#__toc:checked\n & ~ .toc-overlay\n width: 100%\n height: 100%\n opacity: 1\n & ~ .page\n .toc-drawer\n top: 0\n right: 0\n\n////////////////////////////////////////////////////////////////////////////////\n// Back to top\n////////////////////////////////////////////////////////////////////////////////\n.back-to-top\n text-decoration: none\n\n display: none\n position: fixed\n left: 0\n top: 1rem\n padding: 0.5rem\n padding-right: 0.75rem\n border-radius: 1rem\n font-size: 0.8125rem\n\n background: var(--color-background-primary)\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), #6b728080 0px 0px 1px 0px\n\n z-index: 10\n\n margin-left: 50%\n transform: translateX(-50%)\n svg\n height: 1rem\n width: 1rem\n fill: currentColor\n display: inline-block\n\n span\n margin-left: 0.25rem\n\n .show-back-to-top &\n display: flex\n align-items: center\n\n////////////////////////////////////////////////////////////////////////////////\n// Responsive layouting\n////////////////////////////////////////////////////////////////////////////////\n// Make things a bit bigger on bigger screens.\n@media (min-width: $full-width + $sidebar-width)\n html\n font-size: 110%\n\n@media (max-width: $full-width)\n // Collapse \"toc\" into the icon.\n .toc-content-icon\n display: flex\n .toc-drawer\n position: fixed\n height: 100vh\n top: 0\n right: -$sidebar-width\n border-left: 1px solid var(--color-background-muted)\n .toc-tree\n border-left: none\n font-size: var(--toc-font-size--mobile)\n\n // Accomodate for a changed content width.\n .sidebar-drawer\n width: calc((100% - #{$full-width - $sidebar-width}) / 2 + #{$sidebar-width})\n\n@media (max-width: $full-width - $sidebar-width)\n // Collapse \"navigation\".\n .nav-overlay-icon\n display: flex\n .sidebar-drawer\n position: fixed\n height: 100vh\n width: $sidebar-width\n\n top: 0\n left: -$sidebar-width\n\n // Swap which icon is visible.\n .toc-header-icon\n display: flex\n .toc-content-icon, .theme-toggle-content\n display: none\n .theme-toggle-header\n display: block\n\n // Show the header.\n .mobile-header\n position: sticky\n top: 0\n display: flex\n justify-content: space-between\n align-items: center\n\n .header-left,\n .header-right\n display: flex\n height: var(--header-height)\n padding: 0 var(--header-padding)\n label\n height: 100%\n width: 100%\n user-select: none\n\n // Add a scroll margin for the content\n :target\n scroll-margin-top: var(--header-height)\n\n // Show back-to-top below the header\n .back-to-top\n top: calc(var(--header-height) + 0.5rem)\n\n // Center the page, and accommodate for the header.\n .page\n flex-direction: column\n justify-content: center\n .content\n margin-left: auto\n margin-right: auto\n\n@media (max-width: $content-width + 2* $content-padding)\n // Content should respect window limits.\n .content\n width: 100%\n overflow-x: auto\n\n@media (max-width: $content-width)\n .content\n padding: 0 $content-padding--small\n // Don't float sidebars to the right.\n article aside.sidebar\n float: none\n width: 100%\n margin: 1rem 0\n","// Overall Layout Variables\n//\n// Because CSS variables can't be used in media queries. The fact that this\n// makes the layout non-user-configurable is a good thing.\n$content-padding: 3em;\n$content-padding--small: 1em;\n$content-width: 46em;\n$sidebar-width: 15em;\n$full-width: $content-width + 2 * ($content-padding + $sidebar-width);\n","//\n// The design here is strongly inspired by mkdocs-material.\n.admonition, .topic\n margin: 1rem auto\n padding: 0 0.5rem 0.5rem 0.5rem\n\n background: var(--color-admonition-background)\n\n border-radius: 0.2rem\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), 0 0 0.0625rem rgba(0, 0, 0, 0.1)\n\n font-size: var(--admonition-font-size)\n\n overflow: hidden\n page-break-inside: avoid\n\n // First element should have no margin, since the title has it.\n > :nth-child(2)\n margin-top: 0\n\n // Last item should have no margin, since we'll control that w/ padding\n > :last-child\n margin-bottom: 0\n\np.admonition-title, p.topic-title\n position: relative\n margin: 0 -0.5rem 0.5rem\n padding-left: 2rem\n padding-right: .5rem\n padding-top: .4rem\n padding-bottom: .4rem\n\n font-weight: 500\n font-size: var(--admonition-title-font-size)\n line-height: 1.3\n\n // Our fancy icon\n &::before\n content: \"\"\n position: absolute\n left: 0.5rem\n width: 1rem\n height: 1rem\n\n// Default styles\np.admonition-title\n background-color: var(--color-admonition-title-background)\n &::before\n background-color: var(--color-admonition-title)\n mask-image: var(--icon-admonition-default)\n mask-repeat: no-repeat\n\np.topic-title\n background-color: var(--color-topic-title-background)\n &::before\n background-color: var(--color-topic-title)\n mask-image: var(--icon-topic-default)\n mask-repeat: no-repeat\n\n//\n// Variants\n//\n.admonition\n border-left: 0.2rem solid var(--color-admonition-title)\n\n @each $type, $value in $admonitions\n &.#{$type}\n border-left-color: var(--color-admonition-title--#{$type})\n > .admonition-title\n background-color: var(--color-admonition-title-background--#{$type})\n &::before\n background-color: var(--color-admonition-title--#{$type})\n mask-image: var(--icon-#{nth($value, 2)})\n\n.admonition-todo > .admonition-title\n text-transform: uppercase\n","// This file stylizes the API documentation (stuff generated by autodoc). It's\n// deeply nested due to how autodoc structures the HTML without enough classes\n// to select the relevant items.\n\n// API docs!\ndl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)\n // Tweak the spacing of all the things!\n dd\n margin-left: 2rem\n > :first-child\n margin-top: 0.125rem\n > :last-child\n margin-bottom: 0.75rem\n\n // This is used for the arguments\n .field-list\n margin-bottom: 0.75rem\n\n // \"Headings\" (like \"Parameters\" and \"Return\")\n > dt\n text-transform: uppercase\n font-size: var(--font-size--small)\n\n dd:empty\n margin-bottom: 0.5rem\n dd > ul\n margin-left: -1.2rem\n > li\n > p:nth-child(2)\n margin-top: 0\n // When the last-empty-paragraph follows a paragraph, it doesn't need\n // to augument the existing spacing.\n > p + p:last-child:empty\n margin-top: 0\n margin-bottom: 0\n\n // Colorize the elements\n > dt\n color: var(--color-api-overall)\n\n.sig:not(.sig-inline)\n font-weight: bold\n\n font-size: var(--api-font-size)\n font-family: var(--font-stack--monospace)\n\n padding-top: 0.25rem\n padding-bottom: 0.25rem\n padding-right: 0.5rem\n\n // These are intentionally em, to properly match the font size.\n padding-left: 3em\n text-indent: -2.5em\n\n border-radius: 0.25rem\n\n background: var(--color-api-background)\n\n &:hover\n background: var(--color-api-background-hover)\n\n // adjust the size of the [source] link on the right.\n a.reference\n .viewcode-link\n font-weight: normal\n width: 3.5rem\n\n // Break words when they're too long\n span.pre\n overflow-wrap: anywhere\n\nem.property\n font-style: normal\n &:first-child\n color: var(--color-api-keyword)\n.sig-name\n color: var(--color-api-name)\n.sig-prename\n font-weight: normal\n color: var(--color-api-pre-name)\n.sig-paren\n color: var(--color-api-paren)\n.sig-param\n font-style: normal\n\n.versionmodified\n font-style: italic\ndiv.versionadded, div.versionchanged, div.deprecated\n p\n margin-top: 0.125rem\n margin-bottom: 0.125rem\n\n// Align the [docs] and [source] to the right.\n.viewcode-link, .viewcode-back\n float: right\n text-align: right\n",".line-block\n margin-top: 0.5rem\n margin-bottom: 0.75rem\n .line-block\n margin-top: 0rem\n margin-bottom: 0rem\n padding-left: 1rem\n","// Captions\narticle p.caption,\ntable > caption,\n.code-block-caption\n font-size: var(--font-size--small)\n text-align: center\n\n// Caption above a TOCTree\n.toctree-wrapper.compound\n .caption, :not(.caption) > .caption-text\n font-size: var(--font-size--small)\n text-transform: uppercase\n\n text-align: initial\n margin-bottom: 0\n\n > ul\n margin-top: 0\n margin-bottom: 0\n","// Inline code\ncode.literal, .sig-inline\n background: var(--color-inline-code-background)\n border-radius: 0.2em\n // Make the font smaller, and use padding to recover.\n font-size: var(--font-size--small--2)\n padding: 0.1em 0.2em\n\n p &\n border: 1px solid var(--color-background-border)\n\n.sig-inline\n font-family: var(--font-stack--monospace)\n\n// Code and Literal Blocks\n$code-spacing-vertical: 0.625rem\n$code-spacing-horizontal: 0.875rem\n\n// Wraps every literal block + line numbers.\ndiv[class*=\" highlight-\"],\ndiv[class^=\"highlight-\"]\n margin: 1em 0\n display: flex\n\n .table-wrapper\n margin: 0\n padding: 0\n\npre\n margin: 0\n padding: 0\n\n // Needed to have more specificity than pygments' \"pre\" selector. :(\n article[role=\"main\"] .highlight &\n line-height: 1.5\n\n &.literal-block,\n .highlight &\n font-size: var(--code-font-size)\n padding: $code-spacing-vertical $code-spacing-horizontal\n overflow: auto\n\n // Make it look like all the other blocks.\n &.literal-block\n margin-top: 1rem\n margin-bottom: 1rem\n\n border-radius: 0.2rem\n background-color: var(--color-code-background)\n color: var(--color-code-foreground)\n\n// All code is always contained in this.\n.highlight\n width: 100%\n border-radius: 0.2rem\n\n // Make line numbers and prompts un-selectable.\n .gp, span.linenos\n user-select: none\n pointer-events: none\n\n // Expand the line-highlighting.\n .hll\n display: block\n margin-left: -$code-spacing-horizontal\n margin-right: -$code-spacing-horizontal\n padding-left: $code-spacing-horizontal\n padding-right: $code-spacing-horizontal\n\n/* Make code block captions be nicely integrated */\n.code-block-caption\n display: flex\n padding: $code-spacing-vertical $code-spacing-horizontal\n\n border-radius: 0.25rem\n border-bottom-left-radius: 0\n border-bottom-right-radius: 0\n font-weight: 300\n border-bottom: 1px solid\n\n background-color: var(--color-code-background)\n color: var(--color-code-foreground)\n border-color: var(--color-background-border)\n\n + div[class]\n margin-top: 0\n pre\n border-top-left-radius: 0\n border-top-right-radius: 0\n\n// When `html_codeblock_linenos_style` is table.\n.highlighttable\n width: 100%\n display: block\n tbody\n display: block\n\n tr\n display: flex\n\n // Line numbers\n td.linenos\n background-color: var(--color-code-background)\n color: var(--color-code-foreground)\n padding: $code-spacing-vertical $code-spacing-horizontal\n padding-right: 0\n border-top-left-radius: 0.2rem\n border-bottom-left-radius: 0.2rem\n\n .linenodiv\n padding-right: $code-spacing-horizontal\n font-size: var(--code-font-size)\n box-shadow: -0.0625rem 0 var(--color-foreground-border) inset\n\n // Actual code\n td.code\n padding: 0\n display: block\n flex: 1\n overflow: hidden\n\n .highlight\n border-top-left-radius: 0\n border-bottom-left-radius: 0\n\n// When `html_codeblock_linenos_style` is inline.\n.highlight\n span.linenos\n display: inline-block\n padding-left: 0\n padding-right: $code-spacing-horizontal\n margin-right: $code-spacing-horizontal\n box-shadow: -0.0625rem 0 var(--color-foreground-border) inset\n","// Inline Footnote Reference\n.footnote-reference\n font-size: var(--font-size--small--4)\n vertical-align: super\n\n// Definition list, listing the content of each note.\n// docutils <= 0.17\ndl.footnote.brackets\n font-size: var(--font-size--small)\n color: var(--color-foreground-secondary)\n\n display: grid\n grid-template-columns: max-content auto\n dt\n margin: 0\n > .fn-backref\n margin-left: 0.25rem\n\n &:after\n content: \":\"\n\n .brackets\n &:before\n content: \"[\"\n &:after\n content: \"]\"\n\n dd\n margin: 0\n padding: 0 1rem\n\n// docutils >= 0.18\naside.footnote\n font-size: var(--font-size--small)\n color: var(--color-foreground-secondary)\n\naside.footnote > span,\ndiv.citation > span\n float: left\n font-weight: 500\n padding-right: 0.25rem\n\naside.footnote > p,\ndiv.citation > p\n margin-left: 2rem\n","//\n// Figures\n//\nimg\n box-sizing: border-box\n max-width: 100%\n height: auto\n\narticle\n figure, .figure\n border-radius: 0.2rem\n\n margin: 0\n :last-child\n margin-bottom: 0\n\n .align-left\n float: left\n clear: left\n margin: 0 1rem 1rem\n\n .align-right\n float: right\n clear: right\n margin: 0 1rem 1rem\n\n .align-default,\n .align-center\n display: block\n text-align: center\n margin-left: auto\n margin-right: auto\n\n // WELL, table needs to be stylised like a table.\n table.align-default\n display: table\n text-align: initial\n",".genindex-jumpbox, .domainindex-jumpbox\n border-top: 1px solid var(--color-background-border)\n border-bottom: 1px solid var(--color-background-border)\n padding: 0.25rem\n\n.genindex-section, .domainindex-section\n h2\n margin-top: 0.75rem\n margin-bottom: 0.5rem\n ul\n margin-top: 0\n margin-bottom: 0\n","ul,\nol\n padding-left: 1.2rem\n\n // Space lists out like paragraphs\n margin-top: 1rem\n margin-bottom: 1rem\n // reduce margins within li.\n li\n > p:first-child\n margin-top: 0.25rem\n margin-bottom: 0.25rem\n\n > p:last-child\n margin-top: 0.25rem\n\n > ul,\n > ol\n margin-top: 0.5rem\n margin-bottom: 0.5rem\n\nol\n &.arabic\n list-style: decimal\n &.loweralpha\n list-style: lower-alpha\n &.upperalpha\n list-style: upper-alpha\n &.lowerroman\n list-style: lower-roman\n &.upperroman\n list-style: upper-roman\n\n// Don't space lists out when they're \"simple\" or in a `.. toctree::`\n.simple,\n.toctree-wrapper\n li\n > ul,\n > ol\n margin-top: 0\n margin-bottom: 0\n\n// Definition Lists\n.field-list,\n.option-list,\ndl:not([class]),\ndl.simple,\ndl.footnote,\ndl.glossary\n dt\n font-weight: 500\n margin-top: 0.25rem\n + dt\n margin-top: 0\n\n .classifier::before\n content: \":\"\n margin-left: 0.2rem\n margin-right: 0.2rem\n\n dd\n > p:first-child,\n ul\n margin-top: 0.125rem\n\n ul\n margin-bottom: 0.125rem\n",".math-wrapper\n width: 100%\n overflow-x: auto\n\ndiv.math\n position: relative\n text-align: center\n\n .headerlink,\n &:focus .headerlink\n display: none\n\n &:hover .headerlink\n display: inline-block\n\n span.eqno\n position: absolute\n right: 0.5rem\n top: 50%\n transform: translate(0, -50%)\n z-index: 1\n","// Abbreviations\nabbr[title]\n cursor: help\n\n// \"Problematic\" content, as identified by Sphinx\n.problematic\n color: var(--color-problematic)\n\n// Keyboard / Mouse \"instructions\"\nkbd:not(.compound)\n margin: 0 0.2rem\n padding: 0 0.2rem\n border-radius: 0.2rem\n border: 1px solid var(--color-foreground-border)\n color: var(--color-foreground-primary)\n vertical-align: text-bottom\n\n font-size: var(--font-size--small--3)\n display: inline-block\n\n box-shadow: 0 0.0625rem 0 rgba(0, 0, 0, 0.2), inset 0 0 0 0.125rem var(--color-background-primary)\n\n background-color: var(--color-background-secondary)\n\n// Blockquote\nblockquote\n border-left: 4px solid var(--color-background-border)\n background: var(--color-background-secondary)\n\n margin-left: 0\n margin-right: 0\n padding: 0.5rem 1rem\n\n .attribution\n font-weight: 600\n text-align: right\n\n &.pull-quote,\n &.highlights\n font-size: 1.25em\n\n &.epigraph,\n &.pull-quote\n border-left-width: 0\n border-radius: 0.5rem\n\n &.highlights\n border-left-width: 0\n background: transparent\n\n// Center align embedded-in-text images\np .reference img\n vertical-align: middle\n","p.rubric\n line-height: 1.25\n font-weight: bold\n font-size: 1.125em\n\n // For Numpy-style documentation that's got rubrics within it.\n // https://github.com/pradyunsg/furo/discussions/505\n dd &\n line-height: inherit\n font-weight: inherit\n\n font-size: var(--font-size--small)\n text-transform: uppercase\n","article .sidebar\n float: right\n clear: right\n width: 30%\n\n margin-left: 1rem\n margin-right: 0\n\n border-radius: 0.2rem\n background-color: var(--color-background-secondary)\n border: var(--color-background-border) 1px solid\n\n > *\n padding-left: 1rem\n padding-right: 1rem\n\n > ul, > ol // lists need additional padding, because bullets.\n padding-left: 2.2rem\n\n .sidebar-title\n margin: 0\n padding: 0.5rem 1rem\n border-bottom: var(--color-background-border) 1px solid\n\n font-weight: 500\n\n// TODO: subtitle\n// TODO: dedicated variables?\n",".table-wrapper\n width: 100%\n overflow-x: auto\n margin-top: 1rem\n margin-bottom: 0.5rem\n padding: 0.2rem 0.2rem 0.75rem\n\ntable.docutils\n border-radius: 0.2rem\n border-spacing: 0\n border-collapse: collapse\n\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), 0 0 0.0625rem rgba(0, 0, 0, 0.1)\n\n th\n background: var(--color-table-header-background)\n\n td,\n th\n // Space things out properly\n padding: 0 0.25rem\n\n // Get the borders looking just-right.\n border-left: 1px solid var(--color-table-border)\n border-right: 1px solid var(--color-table-border)\n border-bottom: 1px solid var(--color-table-border)\n\n p\n margin: 0.25rem\n\n &:first-child\n border-left: none\n &:last-child\n border-right: none\n\n // MyST-parser tables set these classes for control of column alignment\n &.text-left\n text-align: left\n &.text-right\n text-align: right\n &.text-center\n text-align: center\n",":target\n scroll-margin-top: 0.5rem\n\n@media (max-width: $full-width - $sidebar-width)\n :target\n scroll-margin-top: calc(0.5rem + var(--header-height))\n\n // When a heading is selected\n section > span:target\n scroll-margin-top: calc(0.8rem + var(--header-height))\n\n// Permalinks\n.headerlink\n font-weight: 100\n user-select: none\n\nh1,\nh2,\nh3,\nh4,\nh5,\nh6,\ndl dt,\np.caption,\nfigcaption p,\ntable > caption,\n.code-block-caption\n > .headerlink\n margin-left: 0.5rem\n visibility: hidden\n &:hover > .headerlink\n visibility: visible\n\n // Don't change to link-like, if someone adds the contents directive.\n > .toc-backref\n color: inherit\n text-decoration-line: none\n\n// Figure and table captions are special.\nfigure:hover > figcaption > p > .headerlink,\ntable:hover > caption > .headerlink\n visibility: visible\n\n:target >, // Regular section[id] style anchors\nspan:target ~ // Non-regular span[id] style \"extra\" anchors\n h1,\n h2,\n h3,\n h4,\n h5,\n h6\n &:nth-of-type(1)\n background-color: var(--color-highlight-on-target)\n // .headerlink\n // visibility: visible\n code.literal\n background-color: transparent\n\ntable:target > caption,\nfigure:target\n background-color: var(--color-highlight-on-target)\n\n// Inline page contents\n.this-will-duplicate-information-and-it-is-still-useful-here li :target\n background-color: var(--color-highlight-on-target)\n\n// Code block permalinks\n.literal-block-wrapper:target .code-block-caption\n background-color: var(--color-highlight-on-target)\n\n// When a definition list item is selected\n//\n// There isn't really an alternative to !important here, due to the\n// high-specificity of API documentation's selector.\ndt:target\n background-color: var(--color-highlight-on-target) !important\n\n// When a footnote reference is selected\n.footnote > dt:target + dd,\n.footnote-reference:target\n background-color: var(--color-highlight-on-target)\n",".guilabel\n background-color: var(--color-guilabel-background)\n border: 1px solid var(--color-guilabel-border)\n color: var(--color-guilabel-text)\n\n padding: 0 0.3em\n border-radius: 0.5em\n font-size: 0.9em\n","// This file contains the styles used for stylizing the footer that's shown\n// below the content.\n\nfooter\n font-size: var(--font-size--small)\n display: flex\n flex-direction: column\n\n margin-top: 2rem\n\n// Bottom of page information\n.bottom-of-page\n display: flex\n align-items: center\n justify-content: space-between\n\n margin-top: 1rem\n padding-top: 1rem\n padding-bottom: 1rem\n\n color: var(--color-foreground-secondary)\n border-top: 1px solid var(--color-background-border)\n\n line-height: 1.5\n\n @media (max-width: $content-width)\n text-align: center\n flex-direction: column-reverse\n gap: 0.25rem\n\n .left-details\n font-size: var(--font-size--small)\n\n .right-details\n display: flex\n flex-direction: column\n gap: 0.25rem\n text-align: right\n\n .icons\n display: flex\n justify-content: flex-end\n gap: 0.25rem\n font-size: 1rem\n\n a\n text-decoration: none\n\n svg,\n img\n font-size: 1.125rem\n height: 1em\n width: 1em\n\n// Next/Prev page information\n.related-pages\n a\n display: flex\n align-items: center\n\n text-decoration: none\n &:hover .page-info .title\n text-decoration: underline\n color: var(--color-link)\n text-decoration-color: var(--color-link-underline)\n\n svg.furo-related-icon,\n svg.furo-related-icon > use\n flex-shrink: 0\n\n color: var(--color-foreground-border)\n\n width: 0.75rem\n height: 0.75rem\n margin: 0 0.5rem\n\n &.next-page\n max-width: 50%\n\n float: right\n clear: right\n text-align: right\n\n &.prev-page\n max-width: 50%\n\n float: left\n clear: left\n\n svg\n transform: rotate(180deg)\n\n.page-info\n display: flex\n flex-direction: column\n overflow-wrap: anywhere\n\n .next-page &\n align-items: flex-end\n\n .context\n display: flex\n align-items: center\n\n padding-bottom: 0.1rem\n\n color: var(--color-foreground-muted)\n font-size: var(--font-size--small)\n text-decoration: none\n","//\n// Search Page Listing\n//\nul.search\n padding-left: 0\n list-style: none\n\n li\n padding: 1rem 0\n border-bottom: 1px solid var(--color-background-border)\n\n//\n// Highlighted by links in search page\n//\n[role=main] .highlighted\n background-color: var(--color-highlighted-background)\n color: var(--color-highlighted-text)\n","// This file contains the styles for the contents of the left sidebar, which\n// contains the navigation tree, logo, search etc.\n\n////////////////////////////////////////////////////////////////////////////////\n// Brand on top of the scrollable tree.\n////////////////////////////////////////////////////////////////////////////////\n.sidebar-brand\n display: flex\n flex-direction: column\n flex-shrink: 0\n\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n text-decoration: none\n\n.sidebar-brand-text\n color: var(--color-sidebar-brand-text)\n overflow-wrap: break-word\n margin: var(--sidebar-item-spacing-vertical) 0\n font-size: 1.5rem\n\n.sidebar-logo-container\n margin: var(--sidebar-item-spacing-vertical) 0\n\n.sidebar-logo\n margin: 0 auto\n display: block\n max-width: 100%\n\n////////////////////////////////////////////////////////////////////////////////\n// Search\n////////////////////////////////////////////////////////////////////////////////\n.sidebar-search-container\n display: flex\n align-items: center\n margin-top: var(--sidebar-search-space-above)\n\n position: relative\n\n background: var(--color-sidebar-search-background)\n &:hover,\n &:focus-within\n background: var(--color-sidebar-search-background--focus)\n\n &::before\n content: \"\"\n position: absolute\n left: var(--sidebar-item-spacing-horizontal)\n width: var(--sidebar-search-icon-size)\n height: var(--sidebar-search-icon-size)\n\n background-color: var(--color-sidebar-search-icon)\n mask-image: var(--icon-search)\n\n.sidebar-search\n box-sizing: border-box\n\n border: none\n border-top: 1px solid var(--color-sidebar-search-border)\n border-bottom: 1px solid var(--color-sidebar-search-border)\n\n padding-top: var(--sidebar-search-input-spacing-vertical)\n padding-bottom: var(--sidebar-search-input-spacing-vertical)\n padding-right: var(--sidebar-search-input-spacing-horizontal)\n padding-left: calc(var(--sidebar-item-spacing-horizontal) + var(--sidebar-search-input-spacing-horizontal) + var(--sidebar-search-icon-size))\n\n width: 100%\n\n color: var(--color-sidebar-search-foreground)\n background: transparent\n z-index: 10\n\n &:focus\n outline: none\n\n &::placeholder\n font-size: var(--sidebar-search-input-font-size)\n\n//\n// Hide Search Matches link\n//\n#searchbox .highlight-link\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal) 0\n margin: 0\n text-align: center\n\n a\n color: var(--color-sidebar-search-icon)\n font-size: var(--font-size--small--2)\n\n////////////////////////////////////////////////////////////////////////////////\n// Structure/Skeleton of the navigation tree (left)\n////////////////////////////////////////////////////////////////////////////////\n.sidebar-tree\n font-size: var(--sidebar-item-font-size)\n margin-top: var(--sidebar-tree-space-above)\n margin-bottom: var(--sidebar-item-spacing-vertical)\n\n ul\n padding: 0\n margin-top: 0\n margin-bottom: 0\n\n display: flex\n flex-direction: column\n\n list-style: none\n\n li\n position: relative\n margin: 0\n\n > ul\n margin-left: var(--sidebar-item-spacing-horizontal)\n\n .icon\n color: var(--color-sidebar-link-text)\n\n .reference\n box-sizing: border-box\n color: var(--color-sidebar-link-text)\n\n // Fill the parent.\n display: inline-block\n line-height: var(--sidebar-item-line-height)\n text-decoration: none\n\n // Don't allow long words to cause wrapping.\n overflow-wrap: anywhere\n\n height: 100%\n width: 100%\n\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n\n &:hover\n background: var(--color-sidebar-item-background--hover)\n\n // Add a nice little \"external-link\" arrow here.\n &.external::after\n content: url('data:image/svg+xml,')\n margin: 0 0.25rem\n vertical-align: middle\n color: var(--color-sidebar-link-text)\n\n // Make the current page reference bold.\n .current-page > .reference\n font-weight: bold\n\n label\n position: absolute\n top: 0\n right: 0\n height: var(--sidebar-item-height)\n width: var(--sidebar-expander-width)\n\n cursor: pointer\n user-select: none\n\n display: flex\n justify-content: center\n align-items: center\n\n .caption, :not(.caption) > .caption-text\n font-size: var(--sidebar-caption-font-size)\n color: var(--color-sidebar-caption-text)\n\n font-weight: bold\n text-transform: uppercase\n\n margin: var(--sidebar-caption-space-above) 0 0 0\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n\n // If it has children, add a bit more padding to wrap the content to avoid\n // overlapping with the