diff --git a/.copier-answers.yml b/.copier-answers.yml deleted file mode 100644 index d2a2b345..00000000 --- a/.copier-answers.yml +++ /dev/null @@ -1,19 +0,0 @@ -# Changes here will be overwritten by Copier. -_commit: 1.6.1 -_src_path: gh:mkdocstrings/handler-template -author_email: dev@pawamoy.fr -author_fullname: Timothée Mazzucotelli -author_username: pawamoy -copyright_date: '2021' -copyright_holder: Timothée Mazzucotelli -copyright_holder_email: dev@pawamoy.fr -copyright_license: ISC -language: Python -project_description: A Python handler for mkdocstrings. -project_name: mkdocstrings-python -python_package_distribution_name: mkdocstrings-python -python_package_import_name: python -repository_name: python -repository_namespace: mkdocstrings -repository_provider: github.com - diff --git a/.envrc b/.envrc deleted file mode 100644 index f9d77ee3..00000000 --- a/.envrc +++ /dev/null @@ -1 +0,0 @@ -PATH_add scripts diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index 812789e6..00000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -1,2 +0,0 @@ -github: pawamoy -polar: pawamoy diff --git a/.github/ISSUE_TEMPLATE/1-bug.md b/.github/ISSUE_TEMPLATE/1-bug.md deleted file mode 100644 index a0e35e01..00000000 --- a/.github/ISSUE_TEMPLATE/1-bug.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -name: Bug report -about: Create a bug report to help us improve. -title: "bug: " -labels: unconfirmed -assignees: [pawamoy] ---- - -### Description of the bug - - -### To Reproduce - - -``` -WRITE MRE / INSTRUCTIONS HERE -``` - -### Full traceback - - -
Full traceback - -```python -PASTE TRACEBACK HERE -``` - -
- -### Expected behavior - - -### Environment information - - -```bash -python -m mkdocstrings_handlers.python._internal.debug # | xclip -selection clipboard -``` - -PASTE MARKDOWN OUTPUT HERE - -### Additional context - diff --git a/.github/ISSUE_TEMPLATE/2-feature.md b/.github/ISSUE_TEMPLATE/2-feature.md deleted file mode 100644 index 2df98fbc..00000000 --- a/.github/ISSUE_TEMPLATE/2-feature.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project. -title: "feature: " -labels: feature -assignees: pawamoy ---- - -### Is your feature request related to a problem? Please describe. - - -### Describe the solution you'd like - - -### Describe alternatives you've considered - - -### Additional context - diff --git a/.github/ISSUE_TEMPLATE/3-docs.md b/.github/ISSUE_TEMPLATE/3-docs.md deleted file mode 100644 index 92ac8ec5..00000000 --- a/.github/ISSUE_TEMPLATE/3-docs.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: Documentation update -about: Point at unclear, missing or outdated documentation. -title: "docs: " -labels: docs -assignees: pawamoy ---- - -### Is something unclear, missing or outdated in our documentation? - - -### Relevant code snippets - - -### Link to the relevant documentation section - diff --git a/.github/ISSUE_TEMPLATE/4-change.md b/.github/ISSUE_TEMPLATE/4-change.md deleted file mode 100644 index dc9a8f17..00000000 --- a/.github/ISSUE_TEMPLATE/4-change.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -name: Change request -about: Suggest any other kind of change for this project. -title: "change: " -assignees: pawamoy ---- - -### Is your change request related to a problem? Please describe. - - -### Describe the solution you'd like - - -### Describe alternatives you've considered - - -### Additional context - diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index 9c9765bc..00000000 --- a/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1,5 +0,0 @@ -blank_issues_enabled: false -contact_links: -- name: I have a question / I need help - url: https://github.com/mkdocstrings/python/discussions/new?category=q-a - about: Ask and answer questions in the Discussions tab. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index 6f0f2faf..00000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,15 +0,0 @@ -### For reviewers - - -- [ ] I did not use AI -- [ ] I used AI and thoroughly reviewed every code/docs change - -### Description of the change - - -### Relevant resources - - -- -- -- diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml deleted file mode 100644 index cde0a41b..00000000 --- a/.github/workflows/ci.yml +++ /dev/null @@ -1,150 +0,0 @@ -name: ci - -on: - push: - branches: - - main - - test-me-* - pull_request: - branches: - - main - -concurrency: - group: ${{ github.workflow }}-${{ github.ref }} - cancel-in-progress: ${{ github.event_name == 'pull_request' }} - -defaults: - run: - shell: bash - -env: - LANG: en_US.utf-8 - LC_ALL: en_US.utf-8 - PYTHONIOENCODING: UTF-8 - PYTHONWARNDEFAULTENCODING: "1" - PYTHON_VERSIONS: "" - -jobs: - - quality: - strategy: - matrix: - os: - - ubuntu-latest - - macos-latest - - windows-latest - python-version: - - "3.10" - - "3.14" - include: - - os: ubuntu-latest - python-version: "3.11" - - os: ubuntu-latest - python-version: "3.12" - - os: ubuntu-latest - python-version: "3.13" - - runs-on: ${{ matrix.os }} - - steps: - - name: Checkout - uses: actions/checkout@v4 - with: - fetch-depth: 0 - fetch-tags: true - - - name: Setup Python - uses: actions/setup-python@v6 - with: - python-version: ${{ matrix.python-version }} - - - name: Setup uv - uses: astral-sh/setup-uv@v5 - with: - enable-cache: true - cache-dependency-glob: pyproject.toml - - - name: Install dependencies - run: make setup - - - name: Check if the documentation builds correctly - run: make check-docs - - - name: Check the code quality - run: make check-quality - - - name: Check if the code is correctly typed - run: make check-types - - - name: Check for breaking changes in the API - run: make check-api - - - name: Store objects inventory for tests - uses: actions/upload-artifact@v4 - if: ${{ matrix.os == 'ubuntu-latest' && matrix.python-version == '3.13' }} - with: - name: objects.inv - path: site/objects.inv - - tests: - - needs: - - quality - strategy: - max-parallel: 4 - matrix: - os: - - ubuntu-latest - - macos-latest - - windows-latest - python-version: - - "3.10" - - "3.11" - - "3.12" - - "3.13" - - "3.14" - - "3.15" - resolution: - - highest - - lowest-direct - exclude: - - os: macos-latest - resolution: lowest-direct - - os: windows-latest - resolution: lowest-direct - runs-on: ${{ matrix.os }} - continue-on-error: true - - steps: - - name: Checkout - uses: actions/checkout@v4 - with: - fetch-depth: 0 - fetch-tags: true - - - name: Setup Python - uses: actions/setup-python@v6 - with: - python-version: ${{ matrix.python-version }} - allow-prereleases: true - - - name: Setup uv - uses: astral-sh/setup-uv@v5 - with: - enable-cache: true - cache-dependency-glob: pyproject.toml - cache-suffix: ${{ matrix.resolution }} - - - name: Install dependencies - env: - UV_RESOLUTION: ${{ matrix.resolution }} - run: make setup - - - name: Download objects inventory - uses: actions/download-artifact@v4 - with: - name: objects.inv - path: site/ - - - name: Run the test suite - run: make test diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index 1c7cda36..00000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,29 +0,0 @@ -name: release - -on: push -permissions: - contents: write - -jobs: - release: - runs-on: ubuntu-latest - if: startsWith(github.ref, 'refs/tags/') - steps: - - name: Checkout - uses: actions/checkout@v4 - with: - fetch-depth: 0 - fetch-tags: true - - name: Setup Python - uses: actions/setup-python@v6 - with: - python-version: "3.13" - - name: Setup uv - uses: astral-sh/setup-uv@v5 - - name: Prepare release notes - run: uv tool run git-changelog --release-notes > release-notes.md - - name: Create release - uses: softprops/action-gh-release@v2 - with: - body_path: release-notes.md - diff --git a/.github/workflows/sponsors.yml b/.github/workflows/sponsors.yml deleted file mode 100644 index 8dd9150f..00000000 --- a/.github/workflows/sponsors.yml +++ /dev/null @@ -1,26 +0,0 @@ -name: Update sponsors - -on: - schedule: - - cron: '0 0 * * *' - workflow_dispatch: - -permissions: - contents: write - pull-requests: write - -jobs: - update-readme: - runs-on: ubuntu-latest - steps: - - name: Checkout repository - uses: actions/checkout@v4 - - name: Update README and create PR - uses: pawamoy/readme-insert@main - with: - markup-url: https://pawamoy.github.io/sponsors.txt - start-marker: '' - end-marker: '' - commit-message: 'chore: Update sponsors section in README' - pr-title: 'chore: Update sponsors section in README' - pr-body: 'This PR updates the sponsors section in the README file.' diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 9fea0472..00000000 --- a/.gitignore +++ /dev/null @@ -1,25 +0,0 @@ -# editors -.idea/ -.vscode/ - -# python -*.egg-info/ -*.py[cod] -.venv/ -.venvs/ -/build/ -/dist/ - -# tools -.coverage* -/.pdm-build/ -/htmlcov/ -/site/ -uv.lock - -# cache -.cache/ -.pytest_cache/ -.mypy_cache/ -.ruff_cache/ -__pycache__/ diff --git a/src/mkdocstrings_handlers/python/_internal/__init__.py b/.nojekyll similarity index 100% rename from src/mkdocstrings_handlers/python/_internal/__init__.py rename to .nojekyll diff --git a/404.html b/404.html new file mode 100644 index 00000000..e09294e1 --- /dev/null +++ b/404.html @@ -0,0 +1 @@ + mkdocstrings-python

404 - Not found

\ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 5120a58a..00000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,1074 +0,0 @@ -# Changelog -All notable changes to this project will be documented in this file. - -The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) -and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). - - -## [2.0.3](https://github.com/mkdocstrings/python/releases/tag/2.0.3) - 2026-02-20 - -[Compare with 2.0.2](https://github.com/mkdocstrings/python/compare/2.0.2...2.0.3) - -### Build - -- Depend on griffelib instead of griffe ([770a5f6](https://github.com/mkdocstrings/python/commit/770a5f69d801f24f0b36d1e671a540196e06f710) by Timothée Mazzucotelli). - -## [2.0.2](https://github.com/mkdocstrings/python/releases/tag/2.0.2) - 2026-02-09 - -[Compare with 2.0.1](https://github.com/mkdocstrings/python/compare/2.0.1...2.0.2) - -### Bug Fixes - -- Fix aliases for parameters ([0ae77a3](https://github.com/mkdocstrings/python/commit/0ae77a3454d47e873be38637ea30d043004ee981) by Timothée Mazzucotelli). [Issue-mkdocstrings-813](https://github.com/mkdocstrings/mkdocstrings/issues/813) - -## [2.0.1](https://github.com/mkdocstrings/python/releases/tag/2.0.1) - 2025-12-03 - -[Compare with 2.0.0](https://github.com/mkdocstrings/python/compare/2.0.0...2.0.1) - -### Bug Fixes - -- Don't ignore filters when category grouping is disabled ([63aa1b0](https://github.com/mkdocstrings/python/commit/63aa1b0af0d14912ebf83a4e3c2cd0c7f2a19dae) by Timothée Mazzucotelli). [Issue-324](https://github.com/mkdocstrings/python/issues/324) - -### Code Refactoring - -- Localize more contents in templates ([854b6a6](https://github.com/mkdocstrings/python/commit/854b6a601bd334fe544285aa9eae11482388a583) by Zhikang Yan). [PR-321](https://github.com/mkdocstrings/python/pull/321) -- Improve ja/zh translations ([b83107c](https://github.com/mkdocstrings/python/commit/b83107c8e86d9650fe4544e569f6da16a46b8472) by Zhikang Yan). [PR-322](https://github.com/mkdocstrings/python/pull/322) - -## [2.0.0](https://github.com/mkdocstrings/python/releases/tag/2.0.0) - 2025-11-27 - -[Compare with 1.19.0](https://github.com/mkdocstrings/python/compare/1.19.0...2.0.0) - -### Code Refactoring - -- Remove deprecated code for v2 ([c10afdb](https://github.com/mkdocstrings/python/commit/c10afdb98d590a23c8840c7c0cdd6c358094dc2c) by Timothée Mazzucotelli). - -## [1.19.0](https://github.com/mkdocstrings/python/releases/tag/1.19.0) - 2025-11-10 - -[Compare with 1.18.2](https://github.com/mkdocstrings/python/compare/1.18.2...1.19.0) - -### Features - -- Release scoped and relative cross-references ([872afc5](https://github.com/mkdocstrings/python/commit/872afc584f33f50a133472afdc9355734a5e51ec) by Timothée Mazzucotelli). -- Release `__all__` ordering feature ([84aaebc](https://github.com/mkdocstrings/python/commit/84aaebcb4991c0245bf7ca8d7024c9d04942b0c1) by Timothée Mazzucotelli). -- Release public filter feature ([3be14cc](https://github.com/mkdocstrings/python/commit/3be14cc07bc9429d7ce01c748d825e2db1559212) by Timothée Mazzucotelli). -- Release backlinks feature ([ae7cc2d](https://github.com/mkdocstrings/python/commit/ae7cc2d7d8ea5711d8ce06620edd534a3e2b47aa) by Timothée Mazzucotelli). -- Release expression modernization feature ([dbadd1e](https://github.com/mkdocstrings/python/commit/dbadd1e898bb2e67515077d152890bdbbf0b3eb1) by Timothée Mazzucotelli). -- Release visually-lighter admonitions for source code blocks ([fdaeb48](https://github.com/mkdocstrings/python/commit/fdaeb48a0f2208bafd14f2f7ead42bca37bea665) by Timothée Mazzucotelli). -- Release inheritance diagram features ([669b42e](https://github.com/mkdocstrings/python/commit/669b42ebd7c154c81764fa98c052cf857f7aa406) by Timothée Mazzucotelli). - -### Code Refactoring - -- Update code base for Python 3.10 ([b696ed2](https://github.com/mkdocstrings/python/commit/b696ed2224756472a3617fa3cc18b69d0418ed71) by Timothée Mazzucotelli). - -## [1.18.2](https://github.com/mkdocstrings/python/releases/tag/1.18.2) - 2025-08-28 - -[Compare with 1.18.1](https://github.com/mkdocstrings/python/compare/1.18.1...1.18.2) - -### Bug Fixes - -- Normalize spaces to underscores when passing object to rendering context using its kind as key ([6f79be0](https://github.com/mkdocstrings/python/commit/6f79be0ea83522021e16e5d401209e58576ef93a) by Timothée Mazzucotelli). [Issue-mkdocstrings-791](https://github.com/mkdocstrings/mkdocstrings/issues/791) - -## [1.18.1](https://github.com/mkdocstrings/python/releases/tag/1.18.1) - 2025-08-28 - -[Compare with 1.18.0](https://github.com/mkdocstrings/python/compare/1.18.0...1.18.1) - -### Bug Fixes - -- Don't show implementation signature of `__init__` method when `overloads_only` is true and it is merged into the class ([9ef620f](https://github.com/mkdocstrings/python/commit/9ef620f2b1ae80b3711a2e84ab12d7d2c4a2dbdd) by Timothée Mazzucotelli). [Issue-308](https://github.com/mkdocstrings/python/issues/308) - -## [1.18.0](https://github.com/mkdocstrings/python/releases/tag/1.18.0) - 2025-08-26 - -[Compare with 1.17.0](https://github.com/mkdocstrings/python/compare/1.17.0...1.18.0) - -### Features - -- Support PEP 695 generics ([dc8c3ad](https://github.com/mkdocstrings/python/commit/dc8c3adb23b37add6601de9e74085f76e5fc9ee5) by Victor Westerhuis). [PR-221](https://github.com/mkdocstrings/python/pull/221), Co-authored-by: Timothée Mazzucotelli - -### Bug Fixes - -- Increase maximum recursion limit in case of deeply nested ASTs (rare occurrence) ([6004ccf](https://github.com/mkdocstrings/python/commit/6004ccf3576c7a20e21c880bb2235b7b426ba382) by Timothée Mazzucotelli). [Issue-griffe-402](https://github.com/mkdocstrings/griffe/issues/402) - -## [1.17.0](https://github.com/mkdocstrings/python/releases/tag/1.17.0) - 2025-08-14 - -[Compare with 1.16.12](https://github.com/mkdocstrings/python/compare/1.16.12...1.17.0) - -### Features - -- Support new Griffe parsing options `warn_missing_types` and `warnings` ([0e3bdb8](https://github.com/mkdocstrings/python/commit/0e3bdb857b5ede3e15aa7a9b8b87b33f68889c9e) by Timothée Mazzucotelli). [Issue-mkdocstrings-437](https://github.com/mkdocstrings/mkdocstrings/issues/437) -- Add `skip_local_inventory` option to prevent objects from being registered in the local objects inventory ([e82c24f](https://github.com/mkdocstrings/python/commit/e82c24f17513fba4cff22e90f0a82c00a01a077d) by Bartosz Sławecki). [Issue-296](https://github.com/mkdocstrings/python/issues/296), [Issue-mkdocstrings-671](https://github.com/mkdocstrings/mkdocstrings/issues/671), [PR-297](https://github.com/mkdocstrings/python/pull/297) -- Support hiding attribute values ([6cf34b9](https://github.com/mkdocstrings/python/commit/6cf34b9882e20d9147a6481e672ae09989a27796) by Bartosz Sławecki). Issue-292: #292, PR-293: #293 -- Support hiding implementation signature (showing overload only) ([d3b35e1](https://github.com/mkdocstrings/python/commit/d3b35e17384901e7280b8b6926f10fb033480358) by Bartosz Sławecki). [Issue-213](https://github.com/mkdocstrings/python/issues/213), [PR-286](https://github.com/mkdocstrings/python/pull/286) - -### Code Refactoring - -- Deprecate `locale` option in favor of mkdocstrings' ([17f71ba](https://github.com/mkdocstrings/python/commit/17f71babf11081869478b21b2bde1a33fc97be41) by Timothée Mazzucotelli). [PR-288](https://github.com/mkdocstrings/python/pull/288) - -## [1.16.12](https://github.com/mkdocstrings/python/releases/tag/1.16.12) - 2025-06-03 - -[Compare with 1.16.11](https://github.com/mkdocstrings/python/compare/1.16.11...1.16.12) - -### Bug Fixes - -- Only replace CSS class in first *highlighting* span ([d57740f](https://github.com/mkdocstrings/python/commit/d57740f874f056fb3ba1c6013ad04227df0f0af8) by Timothée Mazzucotelli). [Issue-281](https://github.com/mkdocstrings/python/issues/281) - -## [1.16.11](https://github.com/mkdocstrings/python/releases/tag/1.16.11) - 2025-05-24 - -[Compare with 1.16.10](https://github.com/mkdocstrings/python/compare/1.16.10...1.16.11) - -### Bug Fixes - -- Fix highlighting for signature with known special names like `__init__` ([7f95686](https://github.com/mkdocstrings/python/commit/7f956868f93a766346455fedb296c26787894d5c) by Timothée Mazzucotelli). [Issue-mkdocstrings-757](https://github.com/mkdocstrings/mkdocstrings/issues/757) -- Use default font-size for parameter headings ([0a35b20](https://github.com/mkdocstrings/python/commit/0a35b20a6050a28ba8492d93e5f9940a69462ce3) by Timothée Mazzucotelli). [Issue-mkdocstrings-697](https://github.com/mkdocstrings/mkdocstrings/issues/697) -- Prevent uppercasing H5 titles (by Material for MkDocs) ([ba66969](https://github.com/mkdocstrings/python/commit/ba669697daad5067ea5db3fdf8a2d5ba2f966b25) by Timothée Mazzucotelli). [Issue-mkdocstrings-697](https://github.com/mkdocstrings/mkdocstrings/issues/697), [Issue-276](https://github.com/mkdocstrings/python/issues/276) -- Use configured heading even when signature is not separated ([096960a](https://github.com/mkdocstrings/python/commit/096960abd79831d6fd45e2a7962dfd2bd49e4edd) by Timothée Mazzucotelli). [Issue-mkdocstrings-767](https://github.com/mkdocstrings/mkdocstrings/issues/767), [PR-278](https://github.com/mkdocstrings/python/pull/278) -- Render attribute names without full path in ToC ([d4e618a](https://github.com/mkdocstrings/python/commit/d4e618ab794747b84dced848b1be824639fea2b8) by David Lee). [Issue-271](https://github.com/mkdocstrings/python/issues/271), [PR-272](https://github.com/mkdocstrings/python/pull/272) - -## [1.16.10](https://github.com/mkdocstrings/python/releases/tag/1.16.10) - 2025-04-03 - -[Compare with 1.16.9](https://github.com/mkdocstrings/python/compare/1.16.9...1.16.10) - -### Bug Fixes - -- Fix inventory `base_url` being ignored ([8870eb9](https://github.com/mkdocstrings/python/commit/8870eb9af837666f59f96149c67c849e02f7ee25) by Stefan Mejlgaard). [Issue-268](https://github.com/mkdocstrings/python/issues/268), [PR-269](https://github.com/mkdocstrings/python/pull/269) - -## [1.16.9](https://github.com/mkdocstrings/python/releases/tag/1.16.9) - 2025-04-03 - -[Compare with 1.16.8](https://github.com/mkdocstrings/python/compare/1.16.8...1.16.9) - -### Bug Fixes - -- Use `toc_label` option in a few missing places ([337b46b](https://github.com/mkdocstrings/python/commit/337b46be912ff69e70b398bb252c8217c917db0a) by Timothée Mazzucotelli). [Issue-267](https://github.com/mkdocstrings/python/discussions/267) - -## [1.16.8](https://github.com/mkdocstrings/python/releases/tag/1.16.8) - 2025-03-24 - -[Compare with 1.16.7](https://github.com/mkdocstrings/python/compare/1.16.7...1.16.8) - -### Bug Fixes - -- Prevent infinite recursion by detecting parent-member cycles ([f3917e9](https://github.com/mkdocstrings/python/commit/f3917e9dd50ca7f94d0dd22b6e4e11885b4617e7) by Timothée Mazzucotelli). [Issue-griffe-368](https://github.com/mkdocstrings/griffe/issues/368) - -### Code Refactoring - -- Prepare feature for ordering by `__all__` value ([bfb5b30](https://github.com/mkdocstrings/python/commit/bfb5b303f4ea2187c15bccc688f7eba25e7edfcc) by Timothée Mazzucotelli). [Issue-219](https://github.com/mkdocstrings/python/issues/219) -- Sort objects without line numbers last instead of first ([681afb1](https://github.com/mkdocstrings/python/commit/681afb146225d98350a8eb2178aab07aec95fe6b) by Timothée Mazzucotelli). - -## [1.16.7](https://github.com/mkdocstrings/python/releases/tag/1.16.7) - 2025-03-20 - -[Compare with 1.16.6](https://github.com/mkdocstrings/python/compare/1.16.6...1.16.7) - -### Code Refactoring - -- Prepare `public` filtering method feature ([fde2019](https://github.com/mkdocstrings/python/commit/fde20191cab20f39d9e5e729a95cdfa3390b8f1f) by Timothée Mazzucotelli). [Issue-78](https://github.com/mkdocstrings/python/issues/78) - -## [1.16.6](https://github.com/mkdocstrings/python/releases/tag/1.16.6) - 2025-03-18 - -[Compare with 1.16.5](https://github.com/mkdocstrings/python/compare/1.16.5...1.16.6) - -### Deprecations - -Importing from submodules is now deprecated: the public API is fully exposed under the top-level `mkdocstrings_handler.python` module. - -### Bug Fixes - -- Add back default compiled filters (regression) ([2d83900](https://github.com/mkdocstrings/python/commit/2d83900c9e258399c90ecbac350ad03ff5d8f311) by Timothée Mazzucotelli). [Issue-264](https://github.com/mkdocstrings/python/issues/264) - -### Code Refactoring - -- Start logging warnings instead of info messages about deprecated use of templates ([7606f33](https://github.com/mkdocstrings/python/commit/7606f33559ced6962ecf9a1bc9aa76f24d87f515) by Timothée Mazzucotelli). -- Move modules into internal folder, expose API in top-level module ([93a68d0](https://github.com/mkdocstrings/python/commit/93a68d0d7afce38c78a8264189cfa812d737666c) by Timothée Mazzucotelli). - -## [1.16.5](https://github.com/mkdocstrings/python/releases/tag/1.16.5) - 2025-03-10 - -[Compare with 1.16.4](https://github.com/mkdocstrings/python/compare/1.16.4...1.16.5) - -### Code Refactoring - -- Prepare backlinks support ([56bf627](https://github.com/mkdocstrings/python/commit/56bf627b9483a12228b769ae4690b84733061ea5) by Timothée Mazzucotelli). [Issue-153](https://github.com/mkdocstrings/python/issues/153), [PR-252](https://github.com/mkdocstrings/python/pull/252) - -## [1.16.4](https://github.com/mkdocstrings/python/releases/tag/1.16.4) - 2025-03-10 - -[Compare with 1.16.3](https://github.com/mkdocstrings/python/compare/1.16.3...1.16.4) - -### Bug Fixes - -- Fix de-duplication of summary sections ([dc46ac9](https://github.com/mkdocstrings/python/commit/dc46ac9b4cfc642decd153dceb62e9f45c5c750e) by Timothée Mazzucotelli). - -## [1.16.3](https://github.com/mkdocstrings/python/releases/tag/1.16.3) - 2025-03-08 - -[Compare with 1.16.2](https://github.com/mkdocstrings/python/compare/1.16.2...1.16.3) - -### Build - -- Depend on mkdocstrings 0.28.3 ([9fa4f16](https://github.com/mkdocstrings/python/commit/9fa4f1636af240bb695661b7172f052cb11e0ec9) by Timothée Mazzucotelli). - -### Bug Fixes - -- De-duplicate summary sections ([a657d07](https://github.com/mkdocstrings/python/commit/a657d07499eb82d22337c169aa86b1cdd85543fa) by Timothée Mazzucotelli). [Issue-134](https://github.com/mkdocstrings/python/issues/134) - -### Code Refactoring - -- Import from top-level `mkdocstrings` module ([da2ba13](https://github.com/mkdocstrings/python/commit/da2ba13b1367ce107416d08f382fb9f2384c015c) by Timothée Mazzucotelli). - -## [1.16.2](https://github.com/mkdocstrings/python/releases/tag/1.16.2) - 2025-02-24 - -[Compare with 1.16.1](https://github.com/mkdocstrings/python/compare/1.16.1...1.16.2) - -### Build - -- Depend on mkdocs-autorefs >= 1.4 and mkdocstrings >= 0.28.2 ([ea1ab49](https://github.com/mkdocstrings/python/commit/ea1ab498be836c94eb695ace05c41357b12f2c95) by Timothée Mazzucotelli). - -## [1.16.1](https://github.com/mkdocstrings/python/releases/tag/1.16.1) - 2025-02-18 - -[Compare with 1.16.0](https://github.com/mkdocstrings/python/compare/1.16.0...1.16.1) - -### Bug Fixes - -- Give precedence to user-provided paths when they are already listed in `sys.path` ([0f497d1](https://github.com/mkdocstrings/python/commit/0f497d185ba1860c61555803bfc4b311a410bd39) by Timothée Mazzucotelli). [Issue-248](https://github.com/mkdocstrings/python/discussions/248) - -## [1.16.0](https://github.com/mkdocstrings/python/releases/tag/1.16.0) - 2025-02-17 - -[Compare with 1.15.1](https://github.com/mkdocstrings/python/compare/1.15.1...1.16.0) - -### Features - -- Add option to show/hide overloads ([4a5ee10](https://github.com/mkdocstrings/python/commit/4a5ee10c65de28b7921a56ef2c222d2f3417edaa) by Pete Stenger). [PR-250](https://github.com/mkdocstrings/python/pull/250) - -## [1.15.1](https://github.com/mkdocstrings/python/releases/tag/1.15.1) - 2025-02-17 - -[Compare with 1.15.0](https://github.com/mkdocstrings/python/compare/1.15.0...1.15.1) - -### Bug Fixes - -- Unwrap `Annotated` regardless of `signature_crossrefs` ([d809f1a](https://github.com/mkdocstrings/python/commit/d809f1a9e6a6f4eaf6fe4a18c2ec0e69e5716a12) by Timothée Mazzucotelli). [Issue-249](https://github.com/mkdocstrings/python/issues/249) - -## [1.15.0](https://github.com/mkdocstrings/python/releases/tag/1.15.0) - 2025-02-11 - -[Compare with 1.14.6](https://github.com/mkdocstrings/python/compare/1.14.6...1.15.0) - -### Features - -- Support cross-referencing constructor parameters in instance attribute values ([f07bf58](https://github.com/mkdocstrings/python/commit/f07bf58a7358dea106032c7da27098e7617eefa0) by Timothée Mazzucotelli). - -## [1.14.6](https://github.com/mkdocstrings/python/releases/tag/1.14.6) - 2025-02-07 - -[Compare with 1.14.5](https://github.com/mkdocstrings/python/compare/1.14.5...1.14.6) - -### Bug Fixes - -- Catch alias resolution errors when getting aliases for an identifier ([0aaa260](https://github.com/mkdocstrings/python/commit/0aaa260139afe2e3ab85d62224c90a389df64978) by Timothée Mazzucotelli). [Issue-358](https://github.com/mkdocstrings/griffe/discussions/358) - -### Code Refactoring - -- Improve translations for Simplified Chinese and Japanese ([753a0df](https://github.com/mkdocstrings/python/commit/753a0df8f91f1cf42fb7e56b7fdd312b2bd652ab) by Zhikang Yan). [PR-244](https://github.com/mkdocstrings/python/pull/244) - -## [1.14.5](https://github.com/mkdocstrings/python/releases/tag/1.14.5) - 2025-02-05 - -[Compare with 1.14.4](https://github.com/mkdocstrings/python/compare/1.14.4...1.14.5) - -### Bug Fixes - -- Remove type from property docstring summary in summary sections ([15f2cd4](https://github.com/mkdocstrings/python/commit/15f2cd48b79a1f062086a47ea0c6bc52d89786d8) by Uchechukwu Orji). [PR-242](https://github.com/mkdocstrings/python/pull/242) - -## [1.14.4](https://github.com/mkdocstrings/python/releases/tag/1.14.4) - 2025-02-04 - -[Compare with 1.14.3](https://github.com/mkdocstrings/python/compare/1.14.3...1.14.4) - -### Bug Fixes - -- Deactivate Pydantic validation on Python 3.9 is `eval-type-backport` is not available (for modern typing syntax support) ([0de0e5e](https://github.com/mkdocstrings/python/commit/0de0e5e57f8f22e039b0d19aad6341ce7ab3da9f) by Timothée Mazzucotelli). [Issue-241](https://github.com/mkdocstrings/python/issues/241) - -## [1.14.3](https://github.com/mkdocstrings/python/releases/tag/1.14.3) - 2025-02-04 - -[Compare with 1.14.2](https://github.com/mkdocstrings/python/compare/1.14.2...1.14.3) - -### Bug Fixes - -- Let dataclass implement `__init__` method, set extra fields in `get_options` ([477b9e4](https://github.com/mkdocstrings/python/commit/477b9e447ef9717c6edcb14bd4c53f9cacc555b8) by Timothée Mazzucotelli). - -## [1.14.2](https://github.com/mkdocstrings/python/releases/tag/1.14.2) - 2025-02-03 - -[Compare with 1.14.1](https://github.com/mkdocstrings/python/compare/1.14.1...1.14.2) - -### Bug Fixes - -- Deactivate Pydantic logic if v1 is installed instead of v2 ([c5ecd70](https://github.com/mkdocstrings/python/commit/c5ecd702b04417fa3d862806d608ea627b2e8ed9) by Timothée Mazzucotelli). [Issue-240](https://github.com/mkdocstrings/python/issues/240) - -## [1.14.1](https://github.com/mkdocstrings/python/releases/tag/1.14.1) - 2025-02-03 - -[Compare with 1.14.0](https://github.com/mkdocstrings/python/compare/1.14.0...1.14.1) - -### Bug Fixes - -- Fix type errors with options during collection and docstring parsing ([15ca6d8](https://github.com/mkdocstrings/python/commit/15ca6d8cbe8187ae2938b3cc3a6134d10c94a3aa) by Timothée Mazzucotelli). - -## [1.14.0](https://github.com/mkdocstrings/python/releases/tag/1.14.0) - 2025-02-03 - -[Compare with 1.13.0](https://github.com/mkdocstrings/python/compare/1.13.0...1.14.0) - -### Features - -- Add `heading` and `toc_label` options ([7cabacf](https://github.com/mkdocstrings/python/commit/7cabacf13735dbc5066793baf5820d61cd342dc8) by Yann Van Crombrugge). [Issue-mkdocstrings-725](https://github.com/mkdocstrings/mkdocstrings/issues/725), [PR-236](https://github.com/mkdocstrings/python/pull/236) -- Add `force_inspection` option to force dynamic analysis ([83823be](https://github.com/mkdocstrings/python/commit/83823be2146d6a2ecedc5fe9c0cfd84098d780ca) by Uchechukwu Orji). [Issue-94](https://github.com/mkdocstrings/python/issues/94), [PR-231](https://github.com/mkdocstrings/python/pull/231) - -### Code Refactoring - -- Use dataclasses for configuration/options and automate schema generation ([5ebeda6](https://github.com/mkdocstrings/python/commit/5ebeda6fce1b1bc7cb3f5e27a5a90ac394a3de0c) by Timothée Mazzucotelli). - -## [1.13.0](https://github.com/mkdocstrings/python/releases/tag/1.13.0) - 2024-12-26 - -[Compare with 1.12.2](https://github.com/mkdocstrings/python/compare/1.12.2...1.13.0) - -### Features - -- Allow using Ruff to format signatures and attribute values ([d67215c](https://github.com/mkdocstrings/python/commit/d67215c976938ef1e169f16dd0b6166067ebd7bc) by dm). [PR-216](https://github.com/mkdocstrings/python/pull/216) - -### Bug Fixes - -- Respect `show_signature_annotations` option for attribute signatures in headings ([e93d166](https://github.com/mkdocstrings/python/commit/e93d166a14d0944d30ff2f28f21f2262ac396bff) by Timothée Mazzucotelli). [Issue-griffe-pydantic#9](https://github.com/mkdocstrings/griffe-pydantic/issues/9) -- Handle `__init__` overloads when merging into class ([af6fab3](https://github.com/mkdocstrings/python/commit/af6fab31142204872ace716392dcb314b2cb5d0f) by Timothée Mazzucotelli). [Issue-212](https://github.com/mkdocstrings/python/issues/212) -- Actually check if a module is public when rendering auto-generated summary table for modules ([3bf55b2](https://github.com/mkdocstrings/python/commit/3bf55b22ce9a841242c55b2efcedbd8f3a99ccc9) by Timothée Mazzucotelli). [Issue-203](https://github.com/mkdocstrings/python/issues/203) -- Never render line numbers for signatures and attribute values ([a669f1c](https://github.com/mkdocstrings/python/commit/a669f1caefbd54305cc4610bdd57a529aa1208cf) by Timothée Mazzucotelli). [Issue-192](https://github.com/mkdocstrings/python/issues/192) -- Respect highlight's `linenums` config for `pycon` examples in docstrings ([53eb82a](https://github.com/mkdocstrings/python/commit/53eb82a21bbcaa959306e909bf0d4ac468f87580) by Timothée Mazzucotelli). [Related-to-#192](https://github.com/mkdocstrings/python/issues/192) -- Fix normalization of extension paths on the annoying operating system and Python 3.13 ([101a6dc](https://github.com/mkdocstrings/python/commit/101a6dc428da59a512da617a0a2453f2b6ef4387) by Timothée Mazzucotelli). -- Don't merge parent `__init__` docstring into class docstring if such inherited method wasn't selected through the `inherited_members` configuration option ([6c5b5c3](https://github.com/mkdocstrings/python/commit/6c5b5c341940af9425b3de0672ac400794b3f6e5) by Timothée Mazzucotelli). [Issue-189](https://github.com/mkdocstrings/python/issues/189) - -### Code Refactoring - -- Render `*` and `**` outside of cross-references in signatures ([c4506f0](https://github.com/mkdocstrings/python/commit/c4506f080e0c75cd32d6512c80f5016e82fc12bc) by Timothée Mazzucotelli). [Needed-for-PR-216](https://github.com/mkdocstrings/python/pull/216) - -## [1.12.2](https://github.com/mkdocstrings/python/releases/tag/1.12.2) - 2024-10-19 - -[Compare with 1.12.1](https://github.com/mkdocstrings/python/compare/1.12.1...1.12.2) - -### Bug Fixes - -- Always render cross-references outside of signatures ([73f11dc](https://github.com/mkdocstrings/python/commit/73f11dcc584a672af7e17738cba08a50f119176a) by Timothée Mazzucotelli). [Issue-mkdocstrings#700](https://github.com/mkdocstrings/mkdocstrings/issues/700) - -## [1.12.1](https://github.com/mkdocstrings/python/releases/tag/1.12.1) - 2024-10-14 - -[Compare with 1.12.0](https://github.com/mkdocstrings/python/compare/1.12.0...1.12.1) - -### Bug Fixes - -- Don't escape parameter default values ([9dee4d4](https://github.com/mkdocstrings/python/commit/9dee4d4f8e1258e99c19dc7b2b18d3e9090de79b) by Timothée Mazzucotelli). [Issue-191](https://github.com/mkdocstrings/python/issues/191) - -## [1.12.0](https://github.com/mkdocstrings/python/releases/tag/1.12.0) - 2024-10-12 - -[Compare with 1.11.1](https://github.com/mkdocstrings/python/compare/1.11.1...1.12.0) - -### Build - -- Drop support for Python 3.8 ([6615c91](https://github.com/mkdocstrings/python/commit/6615c91cdc035bc0c2fdd12f3952ff84f5e1c04e) by Timothée Mazzucotelli). - -### Features - -- Auto-summary of members ([7f9757d](https://github.com/mkdocstrings/python/commit/7f9757d1584555edebc56f1aefe6cc8242e6c8bb) by Timothée Mazzucotelli). -- Render function overloads ([0f2c25c](https://github.com/mkdocstrings/python/commit/0f2c25c9ed7f6c5c93ff13df214f02edfd3a4cb1) by Timothée Mazzucotelli). -- Parameter headings, more automatic cross-references ([0176b83](https://github.com/mkdocstrings/python/commit/0176b83f21ae02d345489c93cca3baf51f8bc58c) by Timothée Mazzucotelli). - -### Code Refactoring - -- Declare default CSS symbol colors under :host as well ([3b9dba2](https://github.com/mkdocstrings/python/commit/3b9dba2709a8668e379c6ce1536cb1714971b3f4) by James McDonnell). [PR-186](https://github.com/mkdocstrings/python/pull/186) - -## [1.11.1](https://github.com/mkdocstrings/python/releases/tag/1.11.1) - 2024-09-03 - -[Compare with 1.11.0](https://github.com/mkdocstrings/python/compare/1.11.0...1.11.1) - -### Code Refactoring - -- Prepare `relative_crossrefs` and `scoped_crossrefs` insiders features ([dd8b014](https://github.com/mkdocstrings/python/commit/dd8b014a8ab3decc31d4b08bc22fe68577e1a02c) by Timothée Mazzucotelli). - -## [1.11.0](https://github.com/mkdocstrings/python/releases/tag/1.11.0) - 2024-09-03 - -[Compare with 1.10.9](https://github.com/mkdocstrings/python/compare/1.10.9...1.11.0) - -### Features - -- Hook into autorefs to provide context around cross-ref errors ([bb4be5b](https://github.com/mkdocstrings/python/commit/bb4be5be1b85be50f46c7889231a2d4a3bd05165) by Timothée Mazzucotelli). - -## [1.10.9](https://github.com/mkdocstrings/python/releases/tag/1.10.9) - 2024-08-30 - -[Compare with 1.10.8](https://github.com/mkdocstrings/python/compare/1.10.8...1.10.9) - -### Build - -- Explicitly depend on mkdocs-autorefs to be able to specify lower bound ([2299ab5](https://github.com/mkdocstrings/python/commit/2299ab55641585d65babe0e116a6465b4736dcd9) by Timothée Mazzucotelli). - -### Code Refactoring - -- Use new autorefs syntax ([68cb72f](https://github.com/mkdocstrings/python/commit/68cb72f62253f54146ece621345b36c90d712913) by Timothée Mazzucotelli). - -## [1.10.8](https://github.com/mkdocstrings/python/releases/tag/1.10.8) - 2024-08-14 - -[Compare with 1.10.7](https://github.com/mkdocstrings/python/compare/1.10.7...1.10.8) - -### Build - -- Depend on Griffe 0.49 ([a87dcad](https://github.com/mkdocstrings/python/commit/a87dcad36065dc3171512e166ec632ee3e5b0a64) by Timothée Mazzucotelli). - -## [1.10.7](https://github.com/mkdocstrings/python/releases/tag/1.10.7) - 2024-07-25 - -[Compare with 1.10.6](https://github.com/mkdocstrings/python/compare/1.10.6...1.10.7) - -### Packaging - -- Include tests and all relevant files for downstream packaging in source distribution - -## [1.10.6](https://github.com/mkdocstrings/python/releases/tag/1.10.6) - 2024-07-25 - -[Compare with 1.10.5](https://github.com/mkdocstrings/python/compare/1.10.5...1.10.6) - -### Bug Fixes - -- Fix condition to display members (check all members, not just non-inherited ones) ([3d838a9](https://github.com/mkdocstrings/python/commit/3d838a96f77fa128cd6f2afa5ed0cb151ab225fd) by Timothée Mazzucotelli). - -### Code Refactoring - -- Update code for Griffe 0.48 (removing deprecation warnings) ([eff10cc](https://github.com/mkdocstrings/python/commit/eff10ccf0fa1b2e73df912048a15c2d6406a2c8b) by Timothée Mazzucotelli). [Issue-173](https://github.com/mkdocstrings/python/issues/173) - -## [1.10.5](https://github.com/mkdocstrings/python/releases/tag/1.10.5) - 2024-06-19 - -[Compare with 1.10.4](https://github.com/mkdocstrings/python/compare/1.10.4...1.10.5) - -### Bug Fixes - -- Mix both previous checks for displaying objects: not imported or public ([587963b](https://github.com/mkdocstrings/python/commit/587963ba53f765c9d7eefbc2fb80bdbb11164850) by Timothée Mazzucotelli). [Issue-294](https://github.com/mkdocstrings/griffe/issues/294) - -## [1.10.4](https://github.com/mkdocstrings/python/releases/tag/1.10.4) - 2024-06-18 - -[Compare with 1.10.3](https://github.com/mkdocstrings/python/compare/1.10.3...1.10.4) - -### Code Refactoring - -- Only filter out imported objects instead of non-public ones after applying filters ([e2f4b35](https://github.com/mkdocstrings/python/commit/e2f4b35d29eca6f68afbd2e728ef7542a2abc992) by Timothée Mazzucotelli). [Issue-mkdocstrings/griffe-294](https://github.com/mkdocstrings/griffe/issues/294) -- Update code for Griffe 0.46 to avoid deprecation warnings ([321b407](https://github.com/mkdocstrings/python/commit/321b407eb95195c44f3cf34d780784e0d6751998) by Timothée Mazzucotelli). -- Change `load_external_modules` default value to `None` to support new default mode in Griffe ([ae5896c](https://github.com/mkdocstrings/python/commit/ae5896c1604e9089162d0d63ec97a510a6bcef89) by Timothée Mazzucotelli). - -## [1.10.3](https://github.com/mkdocstrings/python/releases/tag/1.10.3) - 2024-05-22 - -[Compare with 1.10.2](https://github.com/mkdocstrings/python/compare/1.10.2...1.10.3) - -### Bug Fixes - -- Don't crash when rendering the source of an object whose lineno is none ([64df00b](https://github.com/mkdocstrings/python/commit/64df00b9b757e9642d65cf425d32f5a2e0d75f38) by Timothée Mazzucotelli). [Issue-163](https://github.com/mkdocstrings/python/issues/163) - -## [1.10.2](https://github.com/mkdocstrings/python/releases/tag/1.10.2) - 2024-05-16 - -[Compare with 1.10.1](https://github.com/mkdocstrings/python/compare/1.10.1...1.10.2) - -### Bug Fixes - -- Actually make use of custom .html.jinja templates ([5668abb](https://github.com/mkdocstrings/python/commit/5668abba15b13b86fe67f70f6b4004b7b1feeb4f) by Timothée Mazzucotelli). - -## [1.10.1](https://github.com/mkdocstrings/python/releases/tag/1.10.1) - 2024-05-14 - -[Compare with 1.10.0](https://github.com/mkdocstrings/python/compare/1.10.0...1.10.1) - -### Build - -- Depend on mkdocstrings 0.25 which adds support for parameter `once` when logging messages ([2bc156b](https://github.com/mkdocstrings/python/commit/2bc156bd6f231ae13066651f4490d1e9c2ce3ca2) by Timothée Mazzucotelli). - -### Code Refactoring - -- Set handler's name ([a71ab12](https://github.com/mkdocstrings/python/commit/a71ab12c8e52efe76e5c0a5e54065926a47cc0d2) by Timothée Mazzucotelli). -- Update `*.html` top-level templates to extend the `*.html.jinja` base templates ([a8c540e](https://github.com/mkdocstrings/python/commit/a8c540e95693e8500da884c32ad159b3bbaaa7ba) by Timothée Mazzucotelli). [Issue-151](https://github.com/mkdocstrings/python/issues/151) -- Update `*.html` base templates to extend their `*.html.jinja` counterpart, while overriding the `logs` block to issue a logging message (info) stating that extending `*.html` templates is deprecated ([e6f1b9c](https://github.com/mkdocstrings/python/commit/e6f1b9caf13754eca9dbb2f112727bef50876ed7) by Timothée Mazzucotelli). [Issue-151](https://github.com/mkdocstrings/python/issues/151) -- Add `*.html.jinja` top-level (overridable) templates, extending their base counterpart ([7c14924](https://github.com/mkdocstrings/python/commit/7c14924c406d7b5f4f1c22d03019d4c566018d2d) by Timothée Mazzucotelli). [Issue-151](https://github.com/mkdocstrings/python/issues/151) -- Add `*.html.jinja` base templates, which are copies of `*.html` templates, with an additional `logs` block, and using the updated `get_template` filter ([eced9a5](https://github.com/mkdocstrings/python/commit/eced9a54fc8a559b686cb1b1180a0d2e04ba452d) by Timothée Mazzucotelli). [Issue-151](https://github.com/mkdocstrings/python/issues/151) -- Update `get_template` filter to support both `*.html` and `*.html.jinja` templates, logging a message (info) when `*.html` templates are overridden by users ([3546fd7](https://github.com/mkdocstrings/python/commit/3546fd70b2d4e45f77b166b2e67c333acc8af0d2) by Timothée Mazzucotelli). [Issue-151](https://github.com/mkdocstrings/python/issues/151) -- Log a warning when base templates are overridden ([26e3d66](https://github.com/mkdocstrings/python/commit/26e3d66f5334a5aaff75bda030afe6dfa1cc94d7) by Timothée Mazzucotelli). [Issue-151](https://github.com/mkdocstrings/python/issues/151) - -## [1.10.0](https://github.com/mkdocstrings/python/releases/tag/1.10.0) - 2024-04-19 - -[Compare with 1.9.2](https://github.com/mkdocstrings/python/compare/1.9.2...1.10.0) - -### Features - -- Add CSS classes `doc-section-title` and `doc-section-item` in docstring sections ([d6e1d68](https://github.com/mkdocstrings/python/commit/d6e1d68c099e61c3bd6d93e583708335d84158f5) by Timothée Mazzucotelli). [Issue-17](https://github.com/mkdocstrings/python/issues/17) - -### Bug Fixes - -- Render enumeration instance name instead of just "value", allowing proper cross-reference ([11d81d8](https://github.com/mkdocstrings/python/commit/11d81d8e056b7c074eb3a1c47606867156a338fa) by Timothée Mazzucotelli). [Issue-124](https://github.com/mkdocstrings/python/issues/124) - -## [1.9.2](https://github.com/mkdocstrings/python/releases/tag/1.9.2) - 2024-04-02 - -[Compare with 1.9.1](https://github.com/mkdocstrings/python/compare/1.9.1...1.9.2) - -### Dependencies - -- Remove cap on Python-Markdown 3.6 now that ToC labels are fixed by mkdocstrings ([0c1e2c1](https://github.com/mkdocstrings/python/commit/0c1e2c15b2497d99974cbb9bd68f25056bb8451b) by Timothée Mazzucotelli). - -## [1.9.1](https://github.com/mkdocstrings/python/releases/tag/1.9.1) - 2024-04-02 - -[Compare with 1.9.0](https://github.com/mkdocstrings/python/compare/1.9.0...1.9.1) - -### Bug Fixes - -- Don't try loading packages from relative paths ([bd73497](https://github.com/mkdocstrings/python/commit/bd7349714059afb1295e743dbc82380fa797a032) by Timothée Mazzucotelli). [Issue-145](https://github.com/mkdocstrings/python/issues/145) - -### Code Refactoring - -- Allow first name in a separate signature to be highlighted as a function name ([f798a1e](https://github.com/mkdocstrings/python/commit/f798a1e19dbac548420dcbe1172e9a49232b615b) by Timothée Mazzucotelli). -- Maintain original Pygments color for cross-refs in signatures ([7c8b885](https://github.com/mkdocstrings/python/commit/7c8b885fa2b704e719016acb35791723ea3a496a) by Timothée Mazzucotelli). - -## [1.9.0](https://github.com/mkdocstrings/python/releases/tag/1.9.0) - 2024-03-13 - -[Compare with 1.8.0](https://github.com/mkdocstrings/python/compare/1.8.0...1.9.0) - -### Dependencies - -- Add upper bound on Python-Markdown 3.6 to temporarily prevent breaking changes ([cd93ee3](https://github.com/mkdocstrings/python/commit/cd93ee31418a2752667d43bb5a05d22284522c24) by Timothée Mazzucotelli). - -### Features - -- Add `show_labels` option to show/hide labels ([eaf9b82](https://github.com/mkdocstrings/python/commit/eaf9b8240069f7369f401fe048892043c8b173d3) by Viicos). [Issue #120](https://github.com/mkdocstrings/python/issues/120), [PR #130](https://github.com/mkdocstrings/python/pull/130) -- Add option to search for stubs packages ([0c6aa32](https://github.com/mkdocstrings/python/commit/0c6aa323c9e57b8348765a5daa11c79d0c5edb07) by Romain). [PR #128](https://github.com/mkdocstrings/python/pull/128), PR griffe#221: : https://github.com/mkdocstrings/griffe/pull/221 - -### Code Refactoring - -- Mark all Jinja blocks as scoped ([548bdad](https://github.com/mkdocstrings/python/commit/548bdaddd66ffc99b3b9a5a62228a2ff4ff0dd00) by Timothée Mazzucotelli). - -## [1.8.0](https://github.com/mkdocstrings/python/releases/tag/1.8.0) - 2024-01-08 - -[Compare with 1.7.5](https://github.com/mkdocstrings/python/compare/1.7.5...1.8.0) - -### Features - -- Release Insiders features of the $500/month funding goal ([bd30106](https://github.com/mkdocstrings/python/commit/bd301061fe9c647f9b91c2c9b4baa784c304eca7) by Timothée Mazzucotelli). - The features and projects related to *mkdocstrings-python* are: - - - [Cross-references for type annotations in signatures](https://mkdocstrings.github.io/python/usage/configuration/signatures/#signature_crossrefs) - - [Symbol types in headings and table of contents](https://mkdocstrings.github.io/python/usage/configuration/headings/#show_symbol_type_toc) - - [`griffe-inherited-docstrings`](https://mkdocstrings.github.io/griffe-inherited-docstrings/), a Griffe extension for inheriting docstrings - - [`griffe2md`](https://mkdocstrings.github.io/griffe2md/), a tool to output API docs to Markdown using Griffe - -## [1.7.5](https://github.com/mkdocstrings/python/releases/tag/1.7.5) - 2023-11-21 - -[Compare with 1.7.4](https://github.com/mkdocstrings/python/compare/1.7.4...1.7.5) - -### Bug Fixes - -- Add missing translations (fallback theme) for ReadTheDocs ([2fb6513](https://github.com/mkdocstrings/python/commit/2fb651304d0a80fa9d6a8c77c16b3004bda22972) by Timothée Mazzucotelli). [Issue #115](https://github.com/mkdocstrings/python/issues/115) - -## [1.7.4](https://github.com/mkdocstrings/python/releases/tag/1.7.4) - 2023-11-12 - -[Compare with 1.7.3](https://github.com/mkdocstrings/python/compare/1.7.3...1.7.4) - -### Bug Fixes - -- Make extension paths relative to config file ([5035e92](https://github.com/mkdocstrings/python/commit/5035e9269fe11664fd25e438ac8f746721b3de0a) by Waylan Limberg). [PR #112](https://github.com/mkdocstrings/python/pull/112), Co-authored-by: Timothée Mazzucotelli - -### Code Refactoring - -- Prepare for Griffe 0.37 ([b5bb8a9](https://github.com/mkdocstrings/python/commit/b5bb8a982e7a2ec97c73335e453d0033bf4987b6) by Timothée Mazzucotelli). - -## [1.7.3](https://github.com/mkdocstrings/python/releases/tag/1.7.3) - 2023-10-09 - -[Compare with 1.7.2](https://github.com/mkdocstrings/python/compare/1.7.2...1.7.3) - -### Bug Fixes - -- Don't deepcopy the local config ([1300d2c](https://github.com/mkdocstrings/python/commit/1300d2c77dd49f5dea459ad844d72edcc856c4cd) by Timothée Mazzucotelli). - -## [1.7.2](https://github.com/mkdocstrings/python/releases/tag/1.7.2) - 2023-10-05 - -[Compare with 1.7.1](https://github.com/mkdocstrings/python/compare/1.7.1...1.7.2) - -### Bug Fixes - -- Prevent alias resolution error when source-ordering members ([67df10c](https://github.com/mkdocstrings/python/commit/67df10cbb86225e1e3efc251325cbff883a1ef3c) by Timothée Mazzucotelli). [Issue griffe#213](https://github.com/mkdocstrings/griffe/issues/213) - -### Code Refactoring - -- Use package relative filepath if filepath is not relative ([aa5a3f7](https://github.com/mkdocstrings/python/commit/aa5a3f7b0928498ba9da10ed1211d1e55b7f6c4b) by Timothée Mazzucotelli). [Discussion mkdocstrings#622](https://github.com/mkdocstrings/mkdocstrings/discussions/622) - -## [1.7.1](https://github.com/mkdocstrings/python/releases/tag/1.7.1) - 2023-09-28 - -[Compare with 1.7.0](https://github.com/mkdocstrings/python/compare/1.7.0...1.7.1) - -### Bug Fixes - -- Stop propagation of annotation to next parameter in signature template ([3a760ac](https://github.com/mkdocstrings/python/commit/3a760acacfabaef5abc658ee579e1c205e674994) by Timothée Mazzucotelli). [Issue #110](https://github.com/mkdocstrings/python/issues/110) - -### Code Refactoring - -- Look into inherited members for `__init__` methods when merging docstrings ([b97d51f](https://github.com/mkdocstrings/python/commit/b97d51f67c2ee3d1edfe6975274ead50fcb3fa8f) by Timothée Mazzucotelli). [Issue #106](https://github.com/mkdocstrings/python/issues/106) - -## [1.7.0](https://github.com/mkdocstrings/python/releases/tag/1.7.0) - 2023-09-14 - -[Compare with 1.6.3](https://github.com/mkdocstrings/python/compare/1.6.3...1.7.0) - -### Features - -- Add option to unwrap `Annotated` types ([53db04b](https://github.com/mkdocstrings/python/commit/53db04b6256db960aebc2a9f91129b82ca222e41) by Timothée Mazzucotelli). - -## [1.6.3](https://github.com/mkdocstrings/python/releases/tag/1.6.3) - 2023-09-11 - -[Compare with 1.6.2](https://github.com/mkdocstrings/python/compare/1.6.2...1.6.3) - -### Bug Fixes - -- Make `load_external_modules` a global-only option ([266f41f](https://github.com/mkdocstrings/python/commit/266f41f2033e034060001bc2bed376b4f3a8d7b8) by Timothée Mazzucotelli). [Issue #87](https://github.com/mkdocstrings/python/issues/87) -- Never fail when trying to format code with Black ([df24bbc](https://github.com/mkdocstrings/python/commit/df24bbc640886e1da2d00a3b58c1aa7736cb1eeb) by Timothée Mazzucotelli). - -### Code Refactoring - -- Wrap docstring section elements (list style) in code tags to prevent spell checker errors ([1ae8dd8](https://github.com/mkdocstrings/python/commit/1ae8dd89cddd67c09d7d30c59b9013516cea2924) by Timothée Mazzucotelli). - -## [1.6.2](https://github.com/mkdocstrings/python/releases/tag/1.6.2) - 2023-09-05 - -[Compare with 1.6.1](https://github.com/mkdocstrings/python/compare/1.6.1...1.6.2) - -### Bug Fixes - -- Don't render cross-ref spans when they're not enabled ([eed51ee](https://github.com/mkdocstrings/python/commit/eed51ee14bd973a08395f95377f9bd4cd38febfc) by Timothée Mazzucotelli). - -## [1.6.1](https://github.com/mkdocstrings/python/releases/tag/1.6.1) - 2023-09-04 - -[Compare with 1.6.0](https://github.com/mkdocstrings/python/compare/1.6.0...1.6.1) - -### Bug Fixes - -- Fix spacing for rendered named items in Yields, Receives and Returns sections (list style) ([e12688e](https://github.com/mkdocstrings/python/commit/e12688ecb7d868047f794300eb2638d052563e68) by Timothée Mazzucotelli). -- Fix rendering Receives sections as lists ([9ff7e68](https://github.com/mkdocstrings/python/commit/9ff7e68b58e2ab0829c73e4e62254325a4f766ac) by Timothée Mazzucotelli). - -## [1.6.0](https://github.com/mkdocstrings/python/releases/tag/1.6.0) - 2023-08-27 - -[Compare with 1.5.2](https://github.com/mkdocstrings/python/compare/1.5.2...1.6.0) - -### Features - -- Add `doc-signature` CSS class to separate signature code blocks ([b6c648f](https://github.com/mkdocstrings/python/commit/b6c648f554f2e0dce609afc2a2c1a3b27a4fbeba) by Timothée Mazzucotelli). - -### Code Refactoring - -- Add a `format_attribute` filter, preparing for cross-refs in attribute signatures ([8f0ade2](https://github.com/mkdocstrings/python/commit/8f0ade249638ee2f2d446f083c70b6c30799875a) by Timothée Mazzucotelli). - -## [1.5.2](https://github.com/mkdocstrings/python/releases/tag/1.5.2) - 2023-08-25 - -[Compare with 1.5.1](https://github.com/mkdocstrings/python/compare/1.5.1...1.5.2) - -### Bug Fixes - -- Regression in children template: fix condition for when members are specified ([beeebff](https://github.com/mkdocstrings/python/commit/beeebffa36288d1f71d122f78ecd9064b41a75d0) by Timothée Mazzucotelli). [Issue #100](https://github.com/mkdocstrings/python/issues/100) -- Prevent whitespace removal before highlight filter ([c6f36c0](https://github.com/mkdocstrings/python/commit/c6f36c0c9e5141800f8c5c988c9b67720fccccb8) by Timothée Mazzucotelli). - -### Code Refactoring - -- Never show full object path in ToC entry ([9aa758b](https://github.com/mkdocstrings/python/commit/9aa758bcc42dfcf7c416d87b8f7cd407b7fdf148) by Timothée Mazzucotelli). -- Sync templates with insiders, remove useless lines ([38b317f](https://github.com/mkdocstrings/python/commit/38b317f4fc74b583a4788721a5559c51a5a47d86) by Timothée Mazzucotelli). - -## [1.5.1](https://github.com/mkdocstrings/python/releases/tag/1.5.1) - 2023-08-24 - -[Compare with 1.5.0](https://github.com/mkdocstrings/python/compare/1.5.0...1.5.1) - -### Code Refactoring - -- Never show full path in separate signature since it would appear in the heading already ([9e02049](https://github.com/mkdocstrings/python/commit/9e0204930cf4dc973ba8eb41c471fc0132e1631f) by Timothée Mazzucotelli). -- Improve guessing whether an object is public ([35eb811](https://github.com/mkdocstrings/python/commit/35eb81162582d794f170cd7e8c68f10ecfd8ff9d) by Timothée Mazzucotelli). -- Always sort modules alphabetically as source order wouldn't make sense ([70c81ce](https://github.com/mkdocstrings/python/commit/70c81cebb62366cbfc6124bc84d1563db176afb6) by Timothée Mazzucotelli). -- Return anchors as a tuple, not a set, to preserve order ([736a2b5](https://github.com/mkdocstrings/python/commit/736a2b5e729d25bb184db8d42f2ad01025a5bc58) by Timothée Mazzucotelli). [Related-to #mkdocstrings/crystal#6](https://github.com/mkdocstrings/crystal/pull/6) - -## [1.5.0](https://github.com/mkdocstrings/python/releases/tag/1.5.0) - 2023-08-20 - -[Compare with 1.4.0](https://github.com/mkdocstrings/python/compare/1.4.0...1.5.0) - -### Features - -- Add support for new Griffe docstring sections: modules, classes, and functions (methods) ([d5337af](https://github.com/mkdocstrings/python/commit/d5337afdf68fc492b34f749aa69d1da33b49f9c2) by Timothée Mazzucotelli). - -## [1.4.0](https://github.com/mkdocstrings/python/releases/tag/1.4.0) - 2023-08-18 - -[Compare with 1.3.0](https://github.com/mkdocstrings/python/compare/1.3.0...1.4.0) - -### Features - -- Support new Griffe expressions (in v0.33) ([9b8e1b1](https://github.com/mkdocstrings/python/commit/9b8e1b1604b978cf2d89b7abf826cf4407f92394) by Timothée Mazzucotelli). - -### Code Refactoring - -- Deprecate `crossref` and `multi_crossref` filters ([4fe3d20](https://github.com/mkdocstrings/python/commit/4fe3d2051047061780e20683da6513a7c8d91829) by Timothée Mazzucotelli). - -## [1.3.0](https://github.com/mkdocstrings/python/releases/tag/1.3.0) - 2023-08-06 - -[Compare with 1.2.1](https://github.com/mkdocstrings/python/compare/1.2.1...1.3.0) - -### Dependencies - -- Set upper bound on Griffe (0.33) ([ad8c2a3](https://github.com/mkdocstrings/python/commit/ad8c2a3ac8daf0b0c06579b6ba667e05feffa247) by Timothée Mazzucotelli). See https://github.com/mkdocstrings/griffe/discussions/195. - -### Features - -- Show parameter default values within the "list" section style too ([55f08f3](https://github.com/mkdocstrings/python/commit/55f08f3e2cece815dd79d35c82515ba8003ec64c) by Antoine Dechaume). [PR #92](https://github.com/mkdocstrings/python/pull/92), Co-authored-by: Timothée Mazzucotelli - -## [1.2.1](https://github.com/mkdocstrings/python/releases/tag/1.2.1) - 2023-07-20 - -[Compare with 1.2.0](https://github.com/mkdocstrings/python/compare/1.2.0...1.2.1) - -### Bug Fixes - -- Fix members ordering when members are specified with a boolean ([c69f9c3](https://github.com/mkdocstrings/python/commit/c69f9c3b3ddde915619eded6620f7ddada977b00) by Timothée Mazzucotelli). [Issue #89](https://github.com/mkdocstrings/python/issues/89) - -## [1.2.0](https://github.com/mkdocstrings/python/releases/tag/1.2.0) - 2023-07-14 - -[Compare with 1.1.2](https://github.com/mkdocstrings/python/compare/1.1.2...1.2.0) - -### Features - -- Add Jinja blocks to module, class, function and attribute templates ([299fe48](https://github.com/mkdocstrings/python/commit/299fe483cc03ba76df29b843f88467f89db6dc72) by Timothée Mazzucotelli). -- Setup infrastructure for I18N, add translations for simplified chinese and japanese ([b053b29](https://github.com/mkdocstrings/python/commit/b053b2900ef5c0069b68ad19bda9aaa98141a525) by Nyuan Zhang). [PR #77](https://github.com/mkdocstrings/python/pull/77) -- Support inheritance ([ae42356](https://github.com/mkdocstrings/python/commit/ae4235689155a4b4f0c1e74b0014a466c6b1181f) by Timothée Mazzucotelli). [Issue mkdocstrings#157](https://github.com/mkdocstrings/mkdocstrings/issues/157), [Discussion mkdocstrings#536](https://github.com/mkdocstrings/mkdocstrings/discussions/536) - -### Bug Fixes - -- Don't show `None` as return annotation of class signatures ([3d8724e](https://github.com/mkdocstrings/python/commit/3d8724ed1f4d040d7a3d9d02784cf0d1f80445b2) by Timothée Mazzucotelli). [Issue #85](https://github.com/mkdocstrings/python/issues/85) -- Show labels in deterministic order ([02619a8](https://github.com/mkdocstrings/python/commit/02619a85ee4aab25f3241d983bdfff0534dd3f81) by Oleh Prypin). - -## [1.1.2](https://github.com/mkdocstrings/python/releases/tag/1.1.2) - 2023-06-04 - -[Compare with 1.1.1](https://github.com/mkdocstrings/python/compare/1.1.1...1.1.2) - -### Code Refactoring - -- Keep headings style consistent (CSS) ([92032e5](https://github.com/mkdocstrings/python/commit/92032e561861c3fc4e3fb0c6882bb076d0e6614d) by Timothée Mazzucotelli). - -## [1.1.1](https://github.com/mkdocstrings/python/releases/tag/1.1.1) - 2023-06-04 - -[Compare with 1.1.0](https://github.com/mkdocstrings/python/compare/1.1.0...1.1.1) - -### Bug Fixes - -- Fix mkdocs and readthedocs themes support ([14f18b2](https://github.com/mkdocstrings/python/commit/14f18b219f67f9b6d154d4a52051d8d7d7c49348) by Timothée Mazzucotelli). - -### Code Refactoring - -- Improve display of paragraphs in docstring sections ([439f5e6](https://github.com/mkdocstrings/python/commit/439f5e6984fe94c28324ca57fbd1a52ef8f55b62) by Timothée Mazzucotelli). - -## [1.1.0](https://github.com/mkdocstrings/python/releases/tag/1.1.0) - 2023-05-25 - -[Compare with 1.0.0](https://github.com/mkdocstrings/python/compare/1.0.0...1.1.0) - -### Features - -- Support custom templates through objects' extra data ([8ff2b06](https://github.com/mkdocstrings/python/commit/8ff2b06295e848b9c84867802eb845adf061dc10) by Timothée Mazzucotelli). [PR #70](https://github.com/mkdocstrings/python/pull/70) - -## [1.0.0](https://github.com/mkdocstrings/python/releases/tag/1.0.0) - 2023-05-11 - -[Compare with 0.10.1](https://github.com/mkdocstrings/python/compare/0.10.1...1.0.0) - -### Breaking changes - -- The signature of the [`format_signature` filter][mkdocstrings_handlers.python.do_format_signature] has changed. - If you override templates in your project to customize the output, - make sure to update the following templates so that they use - the new filter signature: - - - `class.html` - - `expression.html` - - `function.html` - - `signature.html` - - You can see how to use the filter in this commit's changes: - [f686f4e4](https://github.com/mkdocstrings/python/commit/f686f4e4599cea64686d4ef4863b507dd096a513). - -**We take this as an opportunity to go out of beta and bump the version to 1.0.0. -This will allow users to rely on semantic versioning.** - -### Bug Fixes - -- Bring compatibility with insiders signature crossrefs feature ([f686f4e](https://github.com/mkdocstrings/python/commit/f686f4e4599cea64686d4ef4863b507dd096a513) by Timothée Mazzucotelli). - -## [0.10.1](https://github.com/mkdocstrings/python/releases/tag/0.10.1) - 2023-05-07 - -[Compare with 0.10.0](https://github.com/mkdocstrings/python/compare/0.10.0...0.10.1) - -### Bug Fixes - -- Format signatures with full-path names ([685512d](https://github.com/mkdocstrings/python/commit/685512decf1a14c53fa6ca82048e65619aa6a463) by Timothée Mazzucotelli). - -## [0.10.0](https://github.com/mkdocstrings/python/releases/tag/0.10.0) - 2023-05-07 - -[Compare with 0.9.0](https://github.com/mkdocstrings/python/compare/0.9.0...0.10.0) - -### Features - -- Add option to disallow inspection ([40f2f26](https://github.com/mkdocstrings/python/commit/40f2f268876358941cf8221d01d219a0deb9de38) by Nyuan Zhang). [Issue #68](https://github.com/mkdocstrings/python/issues/68), [PR #69](https://github.com/mkdocstrings/python/pull/69) - -### Bug Fixes - -- Make admonitions open by default ([79cd153](https://github.com/mkdocstrings/python/commit/79cd153cfceec860f6ce08d30817c21031983238) by Timothée Mazzucotelli). [Issue #22](https://github.com/mkdocstrings/python/issues/22) - -### Code Refactoring - -- Match documented behavior for filtering (all members, list, none) ([c7f70c3](https://github.com/mkdocstrings/python/commit/c7f70c353c3dd2b82e1f34c70cd433e0bab4f6e6) by Timothée Mazzucotelli). -- Switch to an info level log for when black's not installed ([f593bb0](https://github.com/mkdocstrings/python/commit/f593bb06c63860be14d2025c4bd795e0c8976ce0) by Faster Speeding). -- Return anchors as a set ([e2b820c](https://github.com/mkdocstrings/python/commit/e2b820c5af3787518656d5f7f799ecb6b55aa033) by Timothée Mazzucotelli). - -## [0.9.0](https://github.com/mkdocstrings/python/releases/tag/0.9.0) - 2023-04-03 - -[Compare with 0.8.3](https://github.com/mkdocstrings/python/compare/0.8.3...0.9.0) - -### Features - -- Allow resolving alias to external modules ([02052e2](https://github.com/mkdocstrings/python/commit/02052e248b125a113ab788faa9a075adbdc92ca6) by Gilad). [PR #61](https://github.com/mkdocstrings/python/pull/61), [Follow-up of PR #60](https://github.com/mkdocstrings/python/pull/60) -- Allow pre-loading modules ([36002cb](https://github.com/mkdocstrings/python/commit/36002cb9c89fba35d23afb07a866dd8c6877f742) by Gilad). [Issue mkdocstrings/mkdocstrings#503](https://github.com/mkdocstrings/mkdocstrings/issues/503), [PR #60](https://github.com/mkdocstrings/python/pull/60) -- Add show options for docstrings ([a6c55fb](https://github.com/mkdocstrings/python/commit/a6c55fb52f362dd49b1a7e334a631f6ea3b1b963) by Jeremy Goh). [Issue mkdocstrings/mkdocstrings#466](https://github.com/mkdocstrings/mkdocstrings/issues/466), [PR #56](https://github.com/mkdocstrings/python/pull/56) -- Allow custom list of domains for inventories ([f5ea6fd](https://github.com/mkdocstrings/python/commit/f5ea6fd81f7a531e8a97bb0e48267188d72936c1) by Sorin Sbarnea). [Issue mkdocstrings/mkdocstrings#510](https://github.com/mkdocstrings/mkdocstrings/issues/510), [PR #49](https://github.com/mkdocstrings/python/pull/49) - -### Bug Fixes - -- Prevent alias resolution error when searching for anchors ([a190e2c](https://github.com/mkdocstrings/python/commit/a190e2c4a752e74a05ad03702837a0914c198742) by Timothée Mazzucotelli). [Issue #64](https://github.com/mkdocstrings/python/issues/64) - -### Code Refactoring - -- Support Griffe 0.26 ([075735c](https://github.com/mkdocstrings/python/commit/075735ce8d86921fbf092d7ad1d009bbb3a2e0bb) by Timothée Mazzucotelli). -- Log (debug) unresolved aliases ([9164742](https://github.com/mkdocstrings/python/commit/9164742f87362e8241dea11bec0fd96f6b9d9dda) by Timothée Mazzucotelli). - -## [0.8.3](https://github.com/mkdocstrings/python/releases/tag/0.8.3) - 2023-01-04 - -[Compare with 0.8.2](https://github.com/mkdocstrings/python/compare/0.8.2...0.8.3) - -### Code Refactoring -- Change "unresolved aliases" log level to DEBUG ([dccb818](https://github.com/mkdocstrings/python/commit/dccb818f51278cc8799e2187a615d999a3ab86fb) by Timothée Mazzucotelli). - - -## [0.8.2](https://github.com/mkdocstrings/python/releases/tag/0.8.2) - 2022-11-19 - -[Compare with 0.8.1](https://github.com/mkdocstrings/python/compare/0.8.1...0.8.2) - -### Bug Fixes -- Fix base directory used to expand globs ([34cfa4b](https://github.com/mkdocstrings/python/commit/34cfa4b41f264437a338e66f6060ceeee134ba15) by Florian Hofer). [PR #45](https://github.com/mkdocstrings/python/pull/45) - - -## [0.8.1](https://github.com/mkdocstrings/python/releases/tag/0.8.1) - 2022-11-19 - -[Compare with 0.8.0](https://github.com/mkdocstrings/python/compare/0.8.0...0.8.1) - -### Bug Fixes -- Expand globs relative to configuration file path ([0dc45ae](https://github.com/mkdocstrings/python/commit/0dc45aeb7c7f9b2f15118ebf1584baa06d365c9b) by David Vegh). [Issue #42](https://github.com/mkdocstrings/python/issues/42), [PR #43](https://github.com/mkdocstrings/python/pull/43) - - -## [0.8.0](https://github.com/mkdocstrings/python/releases/tag/0.8.0) - 2022-11-13 - -[Compare with 0.7.1](https://github.com/mkdocstrings/python/compare/0.7.1...0.8.0) - -### Features -- Add support for globs in paths configuration ([29edd02](https://github.com/mkdocstrings/python/commit/29edd02e7a4d83f6b7e8555d4d5b03a79882eb07) by Andrew Guenther). [Issue #33](https://github.com/mkdocstrings/python/issues/33), [PR #34](https://github.com/mkdocstrings/python/pull/34) - -### Code Refactoring -- Support Griffe 0.24 ([3b9f701](https://github.com/mkdocstrings/python/commit/3b9f7013a7367f18e4354c37f029f9caf3ad0a4e) by Timothée Mazzucotelli). - - -## [0.7.1](https://github.com/mkdocstrings/python/releases/tag/0.7.1) - 2022-06-12 - -[Compare with 0.7.0](https://github.com/mkdocstrings/python/compare/0.7.0...0.7.1) - -### Bug Fixes -- Fix rendering of `/` in signatures ([3e927e4](https://github.com/mkdocstrings/python/commit/3e927e43192710218fe69f67ff832936c856a678) by Timothée Mazzucotelli). [Issue #25](https://github.com/mkdocstrings/python/issues/25) - - -## [0.7.0](https://github.com/mkdocstrings/python/releases/tag/0.7.0) - 2022-05-28 - -[Compare with 0.6.6](https://github.com/mkdocstrings/python/compare/0.6.6...0.7.0) - -### Packaging / Dependencies -- Depend on mkdocstrings 0.19 ([b6a9a47](https://github.com/mkdocstrings/python/commit/b6a9a4799980c4590a7ce2838e12653f40e43be3) by Timothée Mazzucotelli). - -### Features -- Add config option for annotations paths verbosity ([b6c9893](https://github.com/mkdocstrings/python/commit/b6c989315fb028813a919319ad1818b0b1f597ac) by Timothée Mazzucotelli). -- Use sections titles in SpaCy-styled docstrings ([fe16b54](https://github.com/mkdocstrings/python/commit/fe16b54aea60473575343e3a3c428567b701bd7d) by Timothée Mazzucotelli). -- Wrap objects names in spans to allow custom styling ([0822ff9](https://github.com/mkdocstrings/python/commit/0822ff9d3ffd3fb71fb619a8b557160661eff9c3) by Timothée Mazzucotelli). [Issue mkdocstrings/mkdocstrings#240](https://github.com/mkdocstrings/mkdocstrings/issues/240) -- Add Jinja blocks around docstring section styles ([aaa79ee](https://github.com/mkdocstrings/python/commit/aaa79eea40d49a64a69badbe732bf5211fbf055a) by Timothée Mazzucotelli). -- Add members and filters options ([24a6136](https://github.com/mkdocstrings/python/commit/24a6136ee6c04a6a49ee74b20e65177868a10ea7) by Timothée Mazzucotelli). -- Add paths option ([dd41182](https://github.com/mkdocstrings/python/commit/dd41182c210f0bb2675ead162adaa01dbbb1949f) by Timothée Mazzucotelli). [Issue mkdocstrings/mkdocstrings#311](https://github.com/mkdocstrings/mkdocstrings/issues/311), [PR #20](https://github.com/mkdocstrings/python/issues/20) - -### Bug Fixes -- Fix CSS class on labels ([312a709](https://github.com/mkdocstrings/python/commit/312a7092394aab968032cf08195af7445a85052f) by Timothée Mazzucotelli). -- Fix categories rendering ([6407cf4](https://github.com/mkdocstrings/python/commit/6407cf4f2375c894e0c528e932e9b76774a6455e) by Timothée Mazzucotelli). [Issue #14](https://github.com/mkdocstrings/python/issues/14) - -### Code Refactoring -- Disable `show_submodules` by default ([480d0c3](https://github.com/mkdocstrings/python/commit/480d0c373904713313ec76b6e2570dbc35eb527b) by Timothée Mazzucotelli). -- Merge default configuration options in handler ([347ce76](https://github.com/mkdocstrings/python/commit/347ce76d074c0e3841df2d5162b54d3938d00453) by Timothée Mazzucotelli). -- Reduce number of template debug logs ([8fed314](https://github.com/mkdocstrings/python/commit/8fed314243e3981fc7b527c69cee628e87b10220) by Timothée Mazzucotelli). -- Respect `show_root_full_path` for ToC entries (hidden headings) ([8f4c853](https://github.com/mkdocstrings/python/commit/8f4c85328e8b4a45db77f9fc3e536a5008686f37) by Timothée Mazzucotelli). -- Bring consistency on headings style ([59104c4](https://github.com/mkdocstrings/python/commit/59104c4c51c86c774eed76d8508f9f4d3db5463f) by Timothée Mazzucotelli). -- Stop using deprecated base classes ([d5ea1c5](https://github.com/mkdocstrings/python/commit/d5ea1c5cf7884d8c019145f73685a84218e69840) by Timothée Mazzucotelli). - - -## [0.6.6](https://github.com/mkdocstrings/python/releases/tag/0.6.6) - 2022-03-06 - -[Compare with 0.6.5](https://github.com/mkdocstrings/python/compare/0.6.5...0.6.6) - -### Code Refactoring -- Always hide `self` and `cls` parameters ([7f579d1](https://github.com/mkdocstrings/python/commit/7f579d162e184adcfe25b2215bce4d38677f75b7) by Timothée Mazzucotelli). [Issue #7](https://github.com/mkdocstrings/python/issues/7) -- Use `pycon` for examples code blocks ([6545900](https://github.com/mkdocstrings/python/commit/6545900eecc67c8a6ddd343c497ac22fdd6a26e2) by Timothée Mazzucotelli). - - -## [0.6.5](https://github.com/mkdocstrings/python/releases/tag/0.6.5) - 2022-02-24 - -[Compare with 0.6.4](https://github.com/mkdocstrings/python/compare/0.6.4...0.6.5) - -### Bug Fixes -- Don't escape signatures return annotations ([ac54bfc](https://github.com/mkdocstrings/python/commit/ac54bfc5761337aa606fb1aa6575745062ce26f8) by Timothée Mazzucotelli). [Issue #6](https://github.com/mkdocstrings/python/issues/6) - - -## [0.6.4](https://github.com/mkdocstrings/python/releases/tag/0.6.4) - 2022-02-22 - -[Compare with 0.6.3](https://github.com/mkdocstrings/python/compare/0.6.3...0.6.4) - -### Bug Fixes -- Fix rendering of signature return annotation ([b92ba3b](https://github.com/mkdocstrings/python/commit/b92ba3b370388aa6c956bcc70ba87b7aebb91a4c) by Timothée Mazzucotelli). [Issue #4](https://github.com/mkdocstrings/python/issues/4) - - -## [0.6.3](https://github.com/mkdocstrings/python/releases/tag/0.6.3) - 2022-02-20 - -[Compare with 0.6.2](https://github.com/mkdocstrings/python/compare/0.6.2...0.6.3) - -### Bug Fixes -- Fix examples rendering ([a06a7e3](https://github.com/mkdocstrings/python/commit/a06a7e34c7017374c5bed41f4757ed86ae64cb2e) by Timothée Mazzucotelli). [Issue mkdocstrings/griffe#46](https://github.com/mkdocstrings/griffe/issues/46) - - -## [0.6.2](https://github.com/mkdocstrings/python/releases/tag/0.6.2) - 2022-02-17 - -[Compare with 0.6.1](https://github.com/mkdocstrings/python/compare/0.6.1...0.6.2) - -### Bug Fixes -- Catch alias resolution errors ([b734dd0](https://github.com/mkdocstrings/python/commit/b734dd0dcd72f5b985b3afce01e852c9c74e451a) by Timothée Mazzucotelli). - - -## [0.6.1](https://github.com/mkdocstrings/python/releases/tag/0.6.1) - 2022-02-17 - -[Compare with 0.6.0](https://github.com/mkdocstrings/python/compare/0.6.0...0.6.1) - -### Bug Fixes -- Don't pop from fallback config ([bde32af](https://github.com/mkdocstrings/python/commit/bde32afb5d99539813b1884a4c735de5845f62ae) by Timothée Mazzucotelli). -- Fix rendering init method source when merged into class ([4a20aea](https://github.com/mkdocstrings/python/commit/4a20aeaa60f3efbcb4781a369feef3b4826ff1df) by Timothée Mazzucotelli). - - -## [0.6.0](https://github.com/mkdocstrings/python/releases/tag/0.6.0) - 2022-02-13 - -[Compare with 0.5.4](https://github.com/mkdocstrings/python/compare/0.5.4...0.6.0) - -### Features -- Add option to merge `__init__` methods' docstrings into their classes' docstrings ([1b4d1c0](https://github.com/mkdocstrings/python/commit/1b4d1c0e9254fc51756caed3875fbc8c1da079a6) by Timothée Mazzucotelli). -- Support separate attribute signature ([e962b88](https://github.com/mkdocstrings/python/commit/e962b885f48570762c5bfcefc9b61e5fc1df1c70) by Timothée Mazzucotelli). - -### Bug Fixes -- Restore full cross-refs paths on hover ([ac11970](https://github.com/mkdocstrings/python/commit/ac1197062f2e23e819f144fe74a774d504d0ac49) by Timothée Mazzucotelli). -- Fix rendering of labels ([52919c5](https://github.com/mkdocstrings/python/commit/52919c559378a6006bbe931423c5f03eb5883eaf) by Timothée Mazzucotelli). - -### Code Refactoring -- Don't add trailing parentheses in functions heading when separate signature ([885696e](https://github.com/mkdocstrings/python/commit/885696e05606d07334e0428128ed688d54098da1) by Timothée Mazzucotelli). -- Use more explicit template debug messages ([f2122d7](https://github.com/mkdocstrings/python/commit/f2122d7fa119ed055ffe2b2bac72d2c643daca1c) by Timothée Mazzucotelli). - - -## [0.5.4](https://github.com/mkdocstrings/python/releases/tag/0.5.4) - 2022-02-13 - -[Compare with 0.5.3](https://github.com/mkdocstrings/python/compare/0.5.3...0.5.4) - -### Bug Fixes -- Don't load additional modules during fallback ([69b8e25](https://github.com/mkdocstrings/python/commit/69b8e25cddc9e256c5edb8843592a466023aa124) by Timothée Mazzucotelli). - - -## [0.5.3](https://github.com/mkdocstrings/python/releases/tag/0.5.3) - 2022-02-08 - -[Compare with 0.5.2](https://github.com/mkdocstrings/python/compare/0.5.2...0.5.3) - -### Bug Fixes -- Allow passing `null` as docstring style ([f526816](https://github.com/mkdocstrings/python/commit/f526816ef1d499795c647e6fe184ba91c1d41b1b) by Timothée Mazzucotelli). [Issue #2](https://github.com/mkdocstrings/python/issues/2) - - -## [0.5.2](https://github.com/mkdocstrings/python/releases/tag/0.5.2) - 2022-02-05 - -[Compare with 0.5.1](https://github.com/mkdocstrings/python/compare/0.5.1...0.5.2) - -### Dependencies -- Require at least mkdocstrings 0.18 ([7abdda4](https://github.com/mkdocstrings/python/commit/7abdda416e25128eec06f3b15aae5058fbc7320c) by Timothée Mazzucotelli). - - -## [0.5.1](https://github.com/mkdocstrings/python/releases/tag/0.5.1) - 2022-02-03 - -[Compare with 0.5.0](https://github.com/mkdocstrings/python/compare/0.5.0...0.5.1) - -### Dependencies -- Depend on Griffe >= 0.11.1 ([1303557](https://github.com/mkdocstrings/python/commit/1303557928a27a3d9b063baee9d698458f471357) by Timothée Mazzucotelli). - -### Code Refactoring -- Move handler into its own module ([b787e78](https://github.com/mkdocstrings/python/commit/b787e78e31652438039775850e55ea956c22e8d0) by Timothée Mazzucotelli). - - -## [0.5.0](https://github.com/mkdocstrings/python/releases/tag/0.5.0) - 2022-02-03 - -[Compare with 0.4.1](https://github.com/mkdocstrings/python/compare/0.4.1...0.5.0) - -### Features -- Allow changing docstring style of an object ([39240c1](https://github.com/mkdocstrings/python/commit/39240c1497dced15c03f9046138f2829fc10e139) by Timothée Mazzucotelli). - -### Bug Fixes -- Warn if Black is not installed when formatting signature ([b848277](https://github.com/mkdocstrings/python/commit/b84827789b2bf66a4b76ff63a514ec6ba98cae68) by Timothée Mazzucotelli). -- Fix missing default for `docstring_section_style` option ([774988e](https://github.com/mkdocstrings/python/commit/774988ef06a9bf3446949da63611ad7bc5a712fc) by Timothée Mazzucotelli). - -### Code Refactoring -- Change to new way of stripping paragraphs ([33d4594](https://github.com/mkdocstrings/python/commit/33d45945bf8ffce2435a6b3749795397fa7c3fc8) by Timothée Mazzucotelli). - - -## [0.4.1](https://github.com/mkdocstrings/python/releases/tag/0.4.1) - 2022-02-01 - -[Compare with 0.4.0](https://github.com/mkdocstrings/python/compare/0.4.0...0.4.1) - -### Bug Fixes -- Fix docstring admonitions rendering ([a24ae2e](https://github.com/mkdocstrings/python/commit/a24ae2e95f4c0451a44037120451cf06c973ba65) by Timothée Mazzucotelli). - - -## [0.4.0](https://github.com/mkdocstrings/python/releases/tag/0.4.0) - 2022-02-01 - -[Compare with 0.3.0](https://github.com/mkdocstrings/python/compare/0.3.0...0.4.0) - -### Code Refactoring -- Use the new `mkdocstrings_handlers` namespace ([23c9023](https://github.com/mkdocstrings/python/commit/23c9023780535251778077cd7d957c0067ecb0dc) by Timothée Mazzucotelli). - - -## [0.3.0](https://github.com/mkdocstrings/python/releases/tag/0.3.0) - 2022-01-14 - -[Compare with 0.2.0](https://github.com/mkdocstrings/python/compare/0.2.0...0.3.0) - -### Features -- Support griffe 0.10 ([28061de](https://github.com/mkdocstrings/python/commit/28061de20094c510f27bb375b2e1dc44a699809d) by Timothée Mazzucotelli). - -### Dependencies -- Require griffe 0.10 ([cfbd7bb](https://github.com/mkdocstrings/python/commit/cfbd7bb4761691ef36100962c775ed1d0a247514) by Timothée Mazzucotelli). - -### Code Refactoring -- Use new logger patching utility ([4cdb292](https://github.com/mkdocstrings/python/commit/4cdb2921b3a9292db3ef0663c63f148a4eec3966) by Timothée Mazzucotelli). - - -## [0.2.0](https://github.com/mkdocstrings/python/releases/tag/0.2.0) - 2021-12-28 - -[Compare with 0.1.0](https://github.com/mkdocstrings/python/compare/0.1.0...0.2.0) - -### Dependencies -- Depend on griffe >= 0.7.1 ([34f7ebd](https://github.com/mkdocstrings/python/commit/34f7ebd41f3ebda025ad87e3b52a7226fcb93720) by Timothée Mazzucotelli). -- Upgrade griffe, no upper bound ([8f0aa42](https://github.com/mkdocstrings/python/commit/8f0aa42eed07424a1377708897d92f9894f4abdb) by Timothée Mazzucotelli). - -### Features -- Add `show_signature` rendering option ([0f07c2e](https://github.com/mkdocstrings/python/commit/0f07c2e51a51a56eeb5d32fdf05dbed7243f0bc5) by Will Da Silva). - -### Bug Fixes -- Fix templates for named docstring elements ([47868a1](https://github.com/mkdocstrings/python/commit/47868a143bf2c462abd5ad85bd0ab8dca7bc5f82) by Timothée Mazzucotelli). - - -## [0.1.0](https://github.com/mkdocstrings/python/releases/tag/0.1.0) - 2021-12-19 - -[Compare with first commit](https://github.com/mkdocstrings/python/compare/0032f18c9f902c3e75e0e00114ca8fa6a810c8f5...0.1.0) - -### Features -- Implement handler and add templates ([dbb580a](https://github.com/mkdocstrings/python/commit/dbb580aa79f6b2f8a089c80bdc67d0f7457c2d30) by Timothée Mazzucotelli). - -### Bug Fixes -- Fix separate signature feature ([da6e81c](https://github.com/mkdocstrings/python/commit/da6e81c897899f09e1dae7bb8930ce6782aeb306) by Timothée Mazzucotelli). -- Fix signature template (parameters annotations) ([b34ead0](https://github.com/mkdocstrings/python/commit/b34ead008773880fd8d1d7a2a41768ec27820520) by Timothée Mazzucotelli). -- Only show source when present ([c270d68](https://github.com/mkdocstrings/python/commit/c270d68c9e17204606ae12a2159c04563a18ec2b) by Timothée Mazzucotelli). - -### Code Refactoring -- Return all known anchors ([9bbfe14](https://github.com/mkdocstrings/python/commit/9bbfe1442e2aab28bd6fb2618c943d3f698750ab) by Timothée Mazzucotelli). -- Update for griffe 0.4.0 ([831aabb](https://github.com/mkdocstrings/python/commit/831aabb135db7e75729954adc675af6379f58e24) by Timothée Mazzucotelli). diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index 2d46305a..00000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,84 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. - -We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. - -## Our Standards - -Examples of behavior that contributes to a positive environment for our community include: - -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -* Focusing on what is best not just for us as individuals, but for the overall community - -Examples of unacceptable behavior include: - -* The use of sexualized language or imagery, and sexual attention or advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a professional setting - -## Enforcement Responsibilities - -Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. - -Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. - -## Scope - -This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at dev@pawamoy.fr. All complaints will be reviewed and investigated promptly and fairly. - -All community leaders are obligated to respect the privacy and security of the reporter of any incident. - -## Enforcement Guidelines - -Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: - -### 1. Correction - -**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. - -**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. - -### 2. Warning - -**Community Impact**: A violation through a single incident or series of actions. - -**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. - -### 3. Temporary Ban - -**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. - -**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. - -### 4. Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. - -**Consequence**: A permanent ban from any sort of public interaction within the community. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. - -Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. - -For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations]. - -[homepage]: https://www.contributor-covenant.org -[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html -[Mozilla CoC]: https://github.com/mozilla/diversity -[FAQ]: https://www.contributor-covenant.org/faq -[translations]: https://www.contributor-covenant.org/translations - diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 920ae3a9..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,120 +0,0 @@ -# Contributing - -Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. - -## Environment setup - -Nothing easier! - -Fork and clone the repository, then: - -```bash -cd python -make setup -``` - -> NOTE: If it fails for some reason, you'll need to install [uv](https://github.com/astral-sh/uv) manually. -> -> You can install it with: -> -> ```bash -> curl -LsSf https://astral.sh/uv/install.sh | sh -> ``` -> -> Now you can try running `make setup` again, or simply `uv sync`. - -You now have the dependencies installed. - -Run `make help` to see all the available actions! - -## Tasks - -The entry-point to run commands and tasks is the `make` Python script, located in the `scripts` directory. Try running `make` to show the available commands and tasks. The *commands* do not need the Python dependencies to be installed, -while the *tasks* do. The cross-platform tasks are written in Python, thanks to [duty](https://github.com/pawamoy/duty). - -If you work in VSCode, we provide [an action to configure VSCode](https://pawamoy.github.io/copier-uv/work/#vscode-setup) for the project. - -## Development - -As usual: - -1. create a new branch: `git switch -c feature-or-bugfix-name` -1. edit the code and/or the documentation - -**Before committing:** - -1. run `make format` to auto-format the code -1. run `make check` to check everything (fix any warning) -1. run `make test` to run the tests (fix any issue) -1. if you updated the documentation or the project dependencies: - 1. run `make docs` - 1. go to http://localhost:8000 and check that everything looks good -1. follow our [commit message convention](#commit-message-convention) - -If you are unsure about how to fix or ignore a warning, just let the continuous integration fail, and we will help you during review. - -Don't bother updating the changelog, we will take care of this. - -## Commit message convention - -Commit messages must follow our convention based on the [Angular style](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message) or the [Karma convention](https://karma-runner.github.io/4.0/dev/git-commit-msg.html): - -``` -[(scope)]: Subject - -[Body] -``` - -**Subject and body must be valid Markdown.** Subject must have proper casing (uppercase for first letter if it makes sense), but no dot at the end, and no punctuation in general. - -Scope and body are optional. Type can be: - -- `build`: About packaging, building wheels, etc. -- `chore`: About packaging or repo/files management. -- `ci`: About Continuous Integration. -- `deps`: Dependencies update. -- `docs`: About documentation. -- `feat`: New feature. -- `fix`: Bug fix. -- `perf`: About performance. -- `refactor`: Changes that are not features or bug fixes. -- `style`: A change in code style/format. -- `tests`: About tests. - -If you write a body, please add trailers at the end (for example issues and PR references, or co-authors), without relying on GitHub's flavored Markdown: - -``` -Body. - -Issue #10: https://github.com/namespace/project/issues/10 -Related to PR namespace/other-project#15: https://github.com/namespace/other-project/pull/15 -``` - -These "trailers" must appear at the end of the body, without any blank lines between them. The trailer title can contain any character except colons `:`. We expect a full URI for each trailer, not just GitHub autolinks (for example, full GitHub URLs for commits and issues, not the hash or the #issue-number). - -We do not enforce a line length on commit messages summary and body, but please avoid very long summaries, and very long lines in the body, unless they are part of code blocks that must not be wrapped. - -## Pull requests guidelines - -Link to any related issue in the Pull Request message. - -During the review, we recommend using fixups: - -```bash -# SHA is the SHA of the commit you want to fix -git commit --fixup=SHA -``` - -Once all the changes are approved, you can squash your commits: - -```bash -git rebase -i --autosquash main -``` - -And force-push: - -```bash -git push -f -``` - -If this seems all too complicated, you can push or force-push each new commit, and we will squash them ourselves if needed, before merging. diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 8becbc45..00000000 --- a/LICENSE +++ /dev/null @@ -1,15 +0,0 @@ -ISC License - -Copyright (c) 2021, Timothée Mazzucotelli - -Permission to use, copy, modify, and/or distribute this software for any -purpose with or without fee is hereby granted, provided that the above -copyright notice and this permission notice appear in all copies. - -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/Makefile b/Makefile deleted file mode 100644 index 1b3391da..00000000 --- a/Makefile +++ /dev/null @@ -1,35 +0,0 @@ -# If you have `direnv` loaded in your shell, and allow it in the repository, -# the `make` command will point at the `scripts/make` shell script. -# This Makefile is just here to allow auto-completion in the terminal. - -default: help - @echo - @echo 'Enable direnv in your shell to use the `make` command: `direnv allow`' - @echo 'Or use `python scripts/make ARGS` to run the commands/tasks directly.' - -.DEFAULT_GOAL: default - -actions = \ - allrun \ - changelog \ - check \ - check-api \ - check-docs \ - check-quality \ - check-types \ - clean \ - coverage \ - docs \ - docs-deploy \ - format \ - help \ - multirun \ - release \ - run \ - setup \ - test \ - vscode - -.PHONY: $(actions) -$(actions): - @python scripts/make "$@" diff --git a/README.md b/README.md deleted file mode 100644 index 2d559588..00000000 --- a/README.md +++ /dev/null @@ -1,136 +0,0 @@ -

mkdocstrings-python

- -

A Python handler for mkdocstrings.

- -[![ci](https://github.com/mkdocstrings/python/workflows/ci/badge.svg)](https://github.com/mkdocstrings/python/actions?query=workflow%3Aci) -[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/python/) -[![pypi version](https://img.shields.io/pypi/v/mkdocstrings-python.svg)](https://pypi.org/project/mkdocstrings-python/) -[![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](https://app.gitter.im/#/room/#mkdocstrings_python:gitter.im) - ---- - -

- -The Python handler uses [Griffe](https://mkdocstrings.github.io/griffe) -to collect documentation from Python source code. -The word "griffe" can sometimes be used instead of "signature" in French. -Griffe is able to visit the Abstract Syntax Tree (AST) of the source code to extract useful information. -It is also able to execute the code (by importing it) and introspect objects in memory -when source code is not available. Finally, it can parse docstrings following different styles. - -## Installation - -You can install this handler as a *mkdocstrings* extra: - -```toml title="pyproject.toml" -# PEP 621 dependencies declaration -# adapt to your dependencies manager -[project] -dependencies = [ - "mkdocstrings[python]>=0.18", -] -``` - -You can also explicitly depend on the handler: - -```toml title="pyproject.toml" -# PEP 621 dependencies declaration -# adapt to your dependencies manager -[project] -dependencies = [ - "mkdocstrings-python", -] -``` - -## Preview - - -![mkdocstrings_python_gif](https://user-images.githubusercontent.com/3999221/77157838-7184db80-6aa2-11ea-9f9a-fe77405202de.gif) - -## Features - -- **Data collection from source code**: collection of the object-tree and the docstrings is done thanks to - [Griffe](https://github.com/mkdocstrings/griffe). - -- **Support for type annotations:** Griffe collects your type annotations and *mkdocstrings* uses them - to display parameter types or return types. It is even able to automatically add cross-references - to other objects from your API, from the standard library or third-party libraries! - See [how to load inventories](https://mkdocstrings.github.io/usage/#cross-references-to-other-projects-inventories) to enable it. - -- **Recursive documentation of Python objects:** just use the module dotted-path as an identifier, and you get the full - module docs. You don't need to inject documentation for each class, function, etc. - -- **Support for documented attributes:** attributes (variables) followed by a docstring (triple-quoted string) will - be recognized by Griffe in modules, classes and even in `__init__` methods. - -- **Multiple docstring-styles support:** common support for Google-style, Numpydoc-style, - and Sphinx-style docstrings. See [Griffe's documentation](https://mkdocstrings.github.io/griffe/docstrings/) on docstrings support. - -- **Admonition support in Google docstrings:** blocks like `Note:` or `Warning:` will be transformed - to their [admonition](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) equivalent. - *We do not support nested admonitions in docstrings!* - -- **Every object has a TOC entry:** we render a heading for each object, meaning *MkDocs* picks them into the Table - of Contents, which is nicely displayed by the Material theme. Thanks to *mkdocstrings* cross-reference ability, - you can reference other objects within your docstrings, with the classic Markdown syntax: - `[this object][package.module.object]` or directly with `[package.module.object][]` - -- **Source code display:** *mkdocstrings* can add a collapsible div containing the highlighted source code - of the Python object. - -## Sponsors - - - -
- -
Silver sponsors

-FastAPI
-

- -
Bronze sponsors

-Nixtla
-

-
- ---- - -

-ofek -samuelcolvin -tlambert03 -ssbarnea -femtomc -cmarqu -kolenaIO -ramnes -machow -BenHammersley -trevorWieland -MarcoGorelli -analog-cbarber -OdinManiac -rstudio-sponsorship -schlich -butterlyn -livingbio -NemetschekAllplan -EricJayHartman -15r10nk -activeloopai -roboflow -cmclaughlin -blaisep -RapidataAI -rodolphebarbanneau -theSymbolSyndicate -blakeNaccarato -ChargeStorm -Alphadelta14 -Cusp-AI -

- - -*And 7 more private sponsor(s).* - - diff --git a/assets/_markdown_exec_pyodide.css b/assets/_markdown_exec_pyodide.css new file mode 100644 index 00000000..5e8e12c5 --- /dev/null +++ b/assets/_markdown_exec_pyodide.css @@ -0,0 +1,53 @@ +html[data-theme="light"] { + @import "https://cdn.jsdelivr.net/npm/highlightjs-themes@1.0.0/tomorrow.css" +} + +html[data-theme="dark"] { + @import "https://cdn.jsdelivr.net/npm/highlightjs-themes@1.0.0/tomorrow-night-blue.min.css" +} + + +.ace_gutter { + z-index: 1; +} + +.pyodide-editor { + width: 100%; + font-size: .85em; +} + +.pyodide-editor-bar { + color: var(--md-primary-bg-color); + background-color: var(--md-primary-fg-color); + width: 100%; + font: monospace; + font-size: 0.75em; + padding: 2px 0 2px; +} + +.pyodide-bar-item { + padding: 0 18px 0; + display: inline-block; + width: 50%; +} + +.pyodide pre { + margin: 0; +} + +.pyodide-output { + width: 100%; + margin-bottom: -15px; + min-height: 46px; + max-height: 400px +} + +.pyodide-clickable { + cursor: pointer; + text-align: right; +} + +/* For themes other than Material. */ +.pyodide .twemoji svg { + width: 1rem; +} diff --git a/assets/_markdown_exec_pyodide.js b/assets/_markdown_exec_pyodide.js new file mode 100644 index 00000000..0400bc5a --- /dev/null +++ b/assets/_markdown_exec_pyodide.js @@ -0,0 +1,131 @@ +var _sessions = {}; + +function getSession(name, pyodide) { + if (!(name in _sessions)) { + _sessions[name] = pyodide.globals.get("dict")(); + } + return _sessions[name]; +} + +function writeOutput(element, string) { + element.innerHTML += string + '\n'; +} + +function clearOutput(element) { + element.innerHTML = ''; +} + +async function evaluatePython(pyodide, editor, output, session) { + pyodide.setStdout({ batched: (string) => { writeOutput(output, new Option(string).innerHTML); } }); + let result, code = editor.getValue(); + clearOutput(output); + try { + result = await pyodide.runPythonAsync(code, { globals: getSession(session, pyodide) }); + } catch (error) { + writeOutput(output, new Option(error.toString()).innerHTML); + } + if (result) writeOutput(output, new Option(result).innerHTML); + hljs.highlightElement(output); +} + +async function initPyodide() { + try { + let pyodide = await loadPyodide(); + await pyodide.loadPackage("micropip"); + return pyodide; + } catch(error) { + return null; + } +} + +function getTheme() { + return document.body.getAttribute('data-md-color-scheme'); +} + +function setTheme(editor, currentTheme, light, dark) { + // https://gist.github.com/RyanNutt/cb8d60997d97905f0b2aea6c3b5c8ee0 + if (currentTheme === "default") { + editor.setTheme("ace/theme/" + light); + document.querySelector(`link[title="light"]`).removeAttribute("disabled"); + document.querySelector(`link[title="dark"]`).setAttribute("disabled", "disabled"); + } else if (currentTheme === "slate") { + editor.setTheme("ace/theme/" + dark); + document.querySelector(`link[title="dark"]`).removeAttribute("disabled"); + document.querySelector(`link[title="light"]`).setAttribute("disabled", "disabled"); + } +} + +function updateTheme(editor, light, dark) { + // Create a new MutationObserver instance + const observer = new MutationObserver((mutations) => { + // Loop through the mutations that occurred + mutations.forEach((mutation) => { + // Check if the mutation was a change to the data-md-color-scheme attribute + if (mutation.attributeName === 'data-md-color-scheme') { + // Get the new value of the attribute + const newColorScheme = mutation.target.getAttribute('data-md-color-scheme'); + // Update the editor theme + setTheme(editor, newColorScheme, light, dark); + } + }); + }); + + // Configure the observer to watch for changes to the data-md-color-scheme attribute + observer.observe(document.body, { + attributes: true, + attributeFilter: ['data-md-color-scheme'], + }); +} + +async function setupPyodide( + idPrefix, + install = null, + themeLight = 'tomorrow', + themeDark = 'tomorrow_night', + session = null, + minLines = 5, + maxLines = 30, +) { + const editor = ace.edit(idPrefix + "editor"); + const run = document.getElementById(idPrefix + "run"); + const clear = document.getElementById(idPrefix + "clear"); + const output = document.getElementById(idPrefix + "output"); + + updateTheme(editor, themeLight, themeDark); + + editor.session.setMode("ace/mode/python"); + setTheme(editor, getTheme(), themeLight, themeDark); + + editor.setOption("minLines", minLines); + editor.setOption("maxLines", maxLines); + + // Force editor to resize after setting options + editor.resize(); + + writeOutput(output, "Initializing..."); + let pyodide = await pyodidePromise; + if (install && install.length) { + try { + micropip = pyodide.pyimport("micropip"); + for (const package of install) + await micropip.install(package); + clearOutput(output); + } catch (error) { + clearOutput(output); + writeOutput(output, `Could not install one or more packages: ${install.join(", ")}\n`); + writeOutput(output, new Option(error.toString()).innerHTML); + } + } else { + clearOutput(output); + } + run.onclick = () => evaluatePython(pyodide, editor, output, session); + clear.onclick = () => clearOutput(output); + output.parentElement.parentElement.addEventListener("keydown", (event) => { + if (event.ctrlKey && event.key.toLowerCase() === 'enter') { + event.preventDefault(); + run.click(); + } + }); +} + +var pyodidePromise = initPyodide(); diff --git a/src/mkdocstrings_handlers/python/templates/material/style.css b/assets/_mkdocstrings.css similarity index 99% rename from src/mkdocstrings_handlers/python/templates/material/style.css rename to assets/_mkdocstrings.css index 7bb97041..854048ca 100644 --- a/src/mkdocstrings_handlers/python/templates/material/style.css +++ b/assets/_mkdocstrings.css @@ -1,3 +1,4 @@ + /* Avoid breaking parameter names, etc. in table cells. */ .doc-contents td code { word-break: normal !important; diff --git a/assets/images/favicon.png b/assets/images/favicon.png new file mode 100644 index 00000000..1cf13b9f Binary files /dev/null and b/assets/images/favicon.png differ diff --git a/assets/javascripts/bundle.79ae519e.min.js b/assets/javascripts/bundle.79ae519e.min.js new file mode 100644 index 00000000..3df3e5e6 --- /dev/null +++ b/assets/javascripts/bundle.79ae519e.min.js @@ -0,0 +1,16 @@ +"use strict";(()=>{var Zi=Object.create;var _r=Object.defineProperty;var ea=Object.getOwnPropertyDescriptor;var ta=Object.getOwnPropertyNames,Bt=Object.getOwnPropertySymbols,ra=Object.getPrototypeOf,Ar=Object.prototype.hasOwnProperty,bo=Object.prototype.propertyIsEnumerable;var ho=(e,t,r)=>t in e?_r(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,P=(e,t)=>{for(var r in t||(t={}))Ar.call(t,r)&&ho(e,r,t[r]);if(Bt)for(var r of Bt(t))bo.call(t,r)&&ho(e,r,t[r]);return e};var vo=(e,t)=>{var r={};for(var o in e)Ar.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(e!=null&&Bt)for(var o of Bt(e))t.indexOf(o)<0&&bo.call(e,o)&&(r[o]=e[o]);return r};var Cr=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var oa=(e,t,r,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of ta(t))!Ar.call(e,n)&&n!==r&&_r(e,n,{get:()=>t[n],enumerable:!(o=ea(t,n))||o.enumerable});return e};var $t=(e,t,r)=>(r=e!=null?Zi(ra(e)):{},oa(t||!e||!e.__esModule?_r(r,"default",{value:e,enumerable:!0}):r,e));var go=(e,t,r)=>new Promise((o,n)=>{var i=c=>{try{a(r.next(c))}catch(p){n(p)}},s=c=>{try{a(r.throw(c))}catch(p){n(p)}},a=c=>c.done?o(c.value):Promise.resolve(c.value).then(i,s);a((r=r.apply(e,t)).next())});var xo=Cr((kr,yo)=>{(function(e,t){typeof kr=="object"&&typeof yo!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(kr,(function(){"use strict";function e(r){var o=!0,n=!1,i=null,s={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function a(k){return!!(k&&k!==document&&k.nodeName!=="HTML"&&k.nodeName!=="BODY"&&"classList"in k&&"contains"in k.classList)}function c(k){var ut=k.type,je=k.tagName;return!!(je==="INPUT"&&s[ut]&&!k.readOnly||je==="TEXTAREA"&&!k.readOnly||k.isContentEditable)}function p(k){k.classList.contains("focus-visible")||(k.classList.add("focus-visible"),k.setAttribute("data-focus-visible-added",""))}function l(k){k.hasAttribute("data-focus-visible-added")&&(k.classList.remove("focus-visible"),k.removeAttribute("data-focus-visible-added"))}function f(k){k.metaKey||k.altKey||k.ctrlKey||(a(r.activeElement)&&p(r.activeElement),o=!0)}function u(k){o=!1}function d(k){a(k.target)&&(o||c(k.target))&&p(k.target)}function v(k){a(k.target)&&(k.target.classList.contains("focus-visible")||k.target.hasAttribute("data-focus-visible-added"))&&(n=!0,window.clearTimeout(i),i=window.setTimeout(function(){n=!1},100),l(k.target))}function S(k){document.visibilityState==="hidden"&&(n&&(o=!0),X())}function X(){document.addEventListener("mousemove",ee),document.addEventListener("mousedown",ee),document.addEventListener("mouseup",ee),document.addEventListener("pointermove",ee),document.addEventListener("pointerdown",ee),document.addEventListener("pointerup",ee),document.addEventListener("touchmove",ee),document.addEventListener("touchstart",ee),document.addEventListener("touchend",ee)}function re(){document.removeEventListener("mousemove",ee),document.removeEventListener("mousedown",ee),document.removeEventListener("mouseup",ee),document.removeEventListener("pointermove",ee),document.removeEventListener("pointerdown",ee),document.removeEventListener("pointerup",ee),document.removeEventListener("touchmove",ee),document.removeEventListener("touchstart",ee),document.removeEventListener("touchend",ee)}function ee(k){k.target.nodeName&&k.target.nodeName.toLowerCase()==="html"||(o=!1,re())}document.addEventListener("keydown",f,!0),document.addEventListener("mousedown",u,!0),document.addEventListener("pointerdown",u,!0),document.addEventListener("touchstart",u,!0),document.addEventListener("visibilitychange",S,!0),X(),r.addEventListener("focus",d,!0),r.addEventListener("blur",v,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)}))});var ro=Cr((jy,Rn)=>{"use strict";/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var qa=/["'&<>]/;Rn.exports=Ka;function Ka(e){var t=""+e,r=qa.exec(t);if(!r)return t;var o,n="",i=0,s=0;for(i=r.index;i{/*! + * clipboard.js v2.0.11 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */(function(t,r){typeof Nt=="object"&&typeof io=="object"?io.exports=r():typeof define=="function"&&define.amd?define([],r):typeof Nt=="object"?Nt.ClipboardJS=r():t.ClipboardJS=r()})(Nt,function(){return(function(){var e={686:(function(o,n,i){"use strict";i.d(n,{default:function(){return Xi}});var s=i(279),a=i.n(s),c=i(370),p=i.n(c),l=i(817),f=i.n(l);function u(q){try{return document.execCommand(q)}catch(C){return!1}}var d=function(C){var _=f()(C);return u("cut"),_},v=d;function S(q){var C=document.documentElement.getAttribute("dir")==="rtl",_=document.createElement("textarea");_.style.fontSize="12pt",_.style.border="0",_.style.padding="0",_.style.margin="0",_.style.position="absolute",_.style[C?"right":"left"]="-9999px";var D=window.pageYOffset||document.documentElement.scrollTop;return _.style.top="".concat(D,"px"),_.setAttribute("readonly",""),_.value=q,_}var X=function(C,_){var D=S(C);_.container.appendChild(D);var N=f()(D);return u("copy"),D.remove(),N},re=function(C){var _=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},D="";return typeof C=="string"?D=X(C,_):C instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(C==null?void 0:C.type)?D=X(C.value,_):(D=f()(C),u("copy")),D},ee=re;function k(q){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?k=function(_){return typeof _}:k=function(_){return _&&typeof Symbol=="function"&&_.constructor===Symbol&&_!==Symbol.prototype?"symbol":typeof _},k(q)}var ut=function(){var C=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},_=C.action,D=_===void 0?"copy":_,N=C.container,G=C.target,We=C.text;if(D!=="copy"&&D!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(G!==void 0)if(G&&k(G)==="object"&&G.nodeType===1){if(D==="copy"&&G.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(D==="cut"&&(G.hasAttribute("readonly")||G.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if(We)return ee(We,{container:N});if(G)return D==="cut"?v(G):ee(G,{container:N})},je=ut;function R(q){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?R=function(_){return typeof _}:R=function(_){return _&&typeof Symbol=="function"&&_.constructor===Symbol&&_!==Symbol.prototype?"symbol":typeof _},R(q)}function se(q,C){if(!(q instanceof C))throw new TypeError("Cannot call a class as a function")}function ce(q,C){for(var _=0;_0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof N.action=="function"?N.action:this.defaultAction,this.target=typeof N.target=="function"?N.target:this.defaultTarget,this.text=typeof N.text=="function"?N.text:this.defaultText,this.container=R(N.container)==="object"?N.container:document.body}},{key:"listenClick",value:function(N){var G=this;this.listener=p()(N,"click",function(We){return G.onClick(We)})}},{key:"onClick",value:function(N){var G=N.delegateTarget||N.currentTarget,We=this.action(G)||"copy",Yt=je({action:We,container:this.container,target:this.target(G),text:this.text(G)});this.emit(Yt?"success":"error",{action:We,text:Yt,trigger:G,clearSelection:function(){G&&G.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(N){return Mr("action",N)}},{key:"defaultTarget",value:function(N){var G=Mr("target",N);if(G)return document.querySelector(G)}},{key:"defaultText",value:function(N){return Mr("text",N)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(N){var G=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return ee(N,G)}},{key:"cut",value:function(N){return v(N)}},{key:"isSupported",value:function(){var N=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],G=typeof N=="string"?[N]:N,We=!!document.queryCommandSupported;return G.forEach(function(Yt){We=We&&!!document.queryCommandSupported(Yt)}),We}}]),_})(a()),Xi=Ji}),828:(function(o){var n=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function s(a,c){for(;a&&a.nodeType!==n;){if(typeof a.matches=="function"&&a.matches(c))return a;a=a.parentNode}}o.exports=s}),438:(function(o,n,i){var s=i(828);function a(l,f,u,d,v){var S=p.apply(this,arguments);return l.addEventListener(u,S,v),{destroy:function(){l.removeEventListener(u,S,v)}}}function c(l,f,u,d,v){return typeof l.addEventListener=="function"?a.apply(null,arguments):typeof u=="function"?a.bind(null,document).apply(null,arguments):(typeof l=="string"&&(l=document.querySelectorAll(l)),Array.prototype.map.call(l,function(S){return a(S,f,u,d,v)}))}function p(l,f,u,d){return function(v){v.delegateTarget=s(v.target,f),v.delegateTarget&&d.call(l,v)}}o.exports=c}),879:(function(o,n){n.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},n.nodeList=function(i){var s=Object.prototype.toString.call(i);return i!==void 0&&(s==="[object NodeList]"||s==="[object HTMLCollection]")&&"length"in i&&(i.length===0||n.node(i[0]))},n.string=function(i){return typeof i=="string"||i instanceof String},n.fn=function(i){var s=Object.prototype.toString.call(i);return s==="[object Function]"}}),370:(function(o,n,i){var s=i(879),a=i(438);function c(u,d,v){if(!u&&!d&&!v)throw new Error("Missing required arguments");if(!s.string(d))throw new TypeError("Second argument must be a String");if(!s.fn(v))throw new TypeError("Third argument must be a Function");if(s.node(u))return p(u,d,v);if(s.nodeList(u))return l(u,d,v);if(s.string(u))return f(u,d,v);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function p(u,d,v){return u.addEventListener(d,v),{destroy:function(){u.removeEventListener(d,v)}}}function l(u,d,v){return Array.prototype.forEach.call(u,function(S){S.addEventListener(d,v)}),{destroy:function(){Array.prototype.forEach.call(u,function(S){S.removeEventListener(d,v)})}}}function f(u,d,v){return a(document.body,u,d,v)}o.exports=c}),817:(function(o){function n(i){var s;if(i.nodeName==="SELECT")i.focus(),s=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var a=i.hasAttribute("readonly");a||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),a||i.removeAttribute("readonly"),s=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var c=window.getSelection(),p=document.createRange();p.selectNodeContents(i),c.removeAllRanges(),c.addRange(p),s=c.toString()}return s}o.exports=n}),279:(function(o){function n(){}n.prototype={on:function(i,s,a){var c=this.e||(this.e={});return(c[i]||(c[i]=[])).push({fn:s,ctx:a}),this},once:function(i,s,a){var c=this;function p(){c.off(i,p),s.apply(a,arguments)}return p._=s,this.on(i,p,a)},emit:function(i){var s=[].slice.call(arguments,1),a=((this.e||(this.e={}))[i]||[]).slice(),c=0,p=a.length;for(c;c0&&i[i.length-1])&&(p[0]===6||p[0]===2)){r=0;continue}if(p[0]===3&&(!i||p[1]>i[0]&&p[1]=e.length&&(e=void 0),{value:e&&e[o++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function K(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var o=r.call(e),n,i=[],s;try{for(;(t===void 0||t-- >0)&&!(n=o.next()).done;)i.push(n.value)}catch(a){s={error:a}}finally{try{n&&!n.done&&(r=o.return)&&r.call(o)}finally{if(s)throw s.error}}return i}function B(e,t,r){if(r||arguments.length===2)for(var o=0,n=t.length,i;o1||c(d,S)})},v&&(n[d]=v(n[d])))}function c(d,v){try{p(o[d](v))}catch(S){u(i[0][3],S)}}function p(d){d.value instanceof dt?Promise.resolve(d.value.v).then(l,f):u(i[0][2],d)}function l(d){c("next",d)}function f(d){c("throw",d)}function u(d,v){d(v),i.shift(),i.length&&c(i[0][0],i[0][1])}}function To(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof Oe=="function"?Oe(e):e[Symbol.iterator](),r={},o("next"),o("throw"),o("return"),r[Symbol.asyncIterator]=function(){return this},r);function o(i){r[i]=e[i]&&function(s){return new Promise(function(a,c){s=e[i](s),n(a,c,s.done,s.value)})}}function n(i,s,a,c){Promise.resolve(c).then(function(p){i({value:p,done:a})},s)}}function I(e){return typeof e=="function"}function yt(e){var t=function(o){Error.call(o),o.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var Jt=yt(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: +`+r.map(function(o,n){return n+1+") "+o.toString()}).join(` + `):"",this.name="UnsubscriptionError",this.errors=r}});function Ze(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var qe=(function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,o,n,i;if(!this.closed){this.closed=!0;var s=this._parentage;if(s)if(this._parentage=null,Array.isArray(s))try{for(var a=Oe(s),c=a.next();!c.done;c=a.next()){var p=c.value;p.remove(this)}}catch(S){t={error:S}}finally{try{c&&!c.done&&(r=a.return)&&r.call(a)}finally{if(t)throw t.error}}else s.remove(this);var l=this.initialTeardown;if(I(l))try{l()}catch(S){i=S instanceof Jt?S.errors:[S]}var f=this._finalizers;if(f){this._finalizers=null;try{for(var u=Oe(f),d=u.next();!d.done;d=u.next()){var v=d.value;try{So(v)}catch(S){i=i!=null?i:[],S instanceof Jt?i=B(B([],K(i)),K(S.errors)):i.push(S)}}}catch(S){o={error:S}}finally{try{d&&!d.done&&(n=u.return)&&n.call(u)}finally{if(o)throw o.error}}}if(i)throw new Jt(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)So(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&Ze(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&Ze(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=(function(){var t=new e;return t.closed=!0,t})(),e})();var $r=qe.EMPTY;function Xt(e){return e instanceof qe||e&&"closed"in e&&I(e.remove)&&I(e.add)&&I(e.unsubscribe)}function So(e){I(e)?e():e.unsubscribe()}var De={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var xt={setTimeout:function(e,t){for(var r=[],o=2;o0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var o=this,n=this,i=n.hasError,s=n.isStopped,a=n.observers;return i||s?$r:(this.currentObservers=null,a.push(r),new qe(function(){o.currentObservers=null,Ze(a,r)}))},t.prototype._checkFinalizedStatuses=function(r){var o=this,n=o.hasError,i=o.thrownError,s=o.isStopped;n?r.error(i):s&&r.complete()},t.prototype.asObservable=function(){var r=new F;return r.source=this,r},t.create=function(r,o){return new Ho(r,o)},t})(F);var Ho=(function(e){ie(t,e);function t(r,o){var n=e.call(this)||this;return n.destination=r,n.source=o,n}return t.prototype.next=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.next)===null||n===void 0||n.call(o,r)},t.prototype.error=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.error)===null||n===void 0||n.call(o,r)},t.prototype.complete=function(){var r,o;(o=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||o===void 0||o.call(r)},t.prototype._subscribe=function(r){var o,n;return(n=(o=this.source)===null||o===void 0?void 0:o.subscribe(r))!==null&&n!==void 0?n:$r},t})(T);var jr=(function(e){ie(t,e);function t(r){var o=e.call(this)||this;return o._value=r,o}return Object.defineProperty(t.prototype,"value",{get:function(){return this.getValue()},enumerable:!1,configurable:!0}),t.prototype._subscribe=function(r){var o=e.prototype._subscribe.call(this,r);return!o.closed&&r.next(this._value),o},t.prototype.getValue=function(){var r=this,o=r.hasError,n=r.thrownError,i=r._value;if(o)throw n;return this._throwIfClosed(),i},t.prototype.next=function(r){e.prototype.next.call(this,this._value=r)},t})(T);var Rt={now:function(){return(Rt.delegate||Date).now()},delegate:void 0};var It=(function(e){ie(t,e);function t(r,o,n){r===void 0&&(r=1/0),o===void 0&&(o=1/0),n===void 0&&(n=Rt);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=o,i._timestampProvider=n,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=o===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,o),i}return t.prototype.next=function(r){var o=this,n=o.isStopped,i=o._buffer,s=o._infiniteTimeWindow,a=o._timestampProvider,c=o._windowTime;n||(i.push(r),!s&&i.push(a.now()+c)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var o=this._innerSubscribe(r),n=this,i=n._infiniteTimeWindow,s=n._buffer,a=s.slice(),c=0;c0?e.prototype.schedule.call(this,r,o):(this.delay=o,this.state=r,this.scheduler.flush(this),this)},t.prototype.execute=function(r,o){return o>0||this.closed?e.prototype.execute.call(this,r,o):this._execute(r,o)},t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!=null&&n>0||n==null&&this.delay>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.flush(this),0)},t})(St);var Ro=(function(e){ie(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t})(Ot);var Dr=new Ro(Po);var Io=(function(e){ie(t,e);function t(r,o){var n=e.call(this,r,o)||this;return n.scheduler=r,n.work=o,n}return t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!==null&&n>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.actions.push(this),r._scheduled||(r._scheduled=Tt.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,o,n){var i;if(n===void 0&&(n=0),n!=null?n>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,o,n);var s=r.actions;o!=null&&o===r._scheduled&&((i=s[s.length-1])===null||i===void 0?void 0:i.id)!==o&&(Tt.cancelAnimationFrame(o),r._scheduled=void 0)},t})(St);var Fo=(function(e){ie(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var o;r?o=r.id:(o=this._scheduled,this._scheduled=void 0);var n=this.actions,i;r=r||n.shift();do if(i=r.execute(r.state,r.delay))break;while((r=n[0])&&r.id===o&&n.shift());if(this._active=!1,i){for(;(r=n[0])&&r.id===o&&n.shift();)r.unsubscribe();throw i}},t})(Ot);var ye=new Fo(Io);var y=new F(function(e){return e.complete()});function tr(e){return e&&I(e.schedule)}function Vr(e){return e[e.length-1]}function pt(e){return I(Vr(e))?e.pop():void 0}function Fe(e){return tr(Vr(e))?e.pop():void 0}function rr(e,t){return typeof Vr(e)=="number"?e.pop():t}var Lt=(function(e){return e&&typeof e.length=="number"&&typeof e!="function"});function or(e){return I(e==null?void 0:e.then)}function nr(e){return I(e[wt])}function ir(e){return Symbol.asyncIterator&&I(e==null?void 0:e[Symbol.asyncIterator])}function ar(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function fa(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var sr=fa();function cr(e){return I(e==null?void 0:e[sr])}function pr(e){return wo(this,arguments,function(){var r,o,n,i;return Gt(this,function(s){switch(s.label){case 0:r=e.getReader(),s.label=1;case 1:s.trys.push([1,,9,10]),s.label=2;case 2:return[4,dt(r.read())];case 3:return o=s.sent(),n=o.value,i=o.done,i?[4,dt(void 0)]:[3,5];case 4:return[2,s.sent()];case 5:return[4,dt(n)];case 6:return[4,s.sent()];case 7:return s.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function lr(e){return I(e==null?void 0:e.getReader)}function U(e){if(e instanceof F)return e;if(e!=null){if(nr(e))return ua(e);if(Lt(e))return da(e);if(or(e))return ha(e);if(ir(e))return jo(e);if(cr(e))return ba(e);if(lr(e))return va(e)}throw ar(e)}function ua(e){return new F(function(t){var r=e[wt]();if(I(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function da(e){return new F(function(t){for(var r=0;r=2;return function(o){return o.pipe(e?g(function(n,i){return e(n,i,o)}):be,Ee(1),r?Qe(t):tn(function(){return new fr}))}}function Yr(e){return e<=0?function(){return y}:E(function(t,r){var o=[];t.subscribe(w(r,function(n){o.push(n),e=2,!0))}function le(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new T}:t,o=e.resetOnError,n=o===void 0?!0:o,i=e.resetOnComplete,s=i===void 0?!0:i,a=e.resetOnRefCountZero,c=a===void 0?!0:a;return function(p){var l,f,u,d=0,v=!1,S=!1,X=function(){f==null||f.unsubscribe(),f=void 0},re=function(){X(),l=u=void 0,v=S=!1},ee=function(){var k=l;re(),k==null||k.unsubscribe()};return E(function(k,ut){d++,!S&&!v&&X();var je=u=u!=null?u:r();ut.add(function(){d--,d===0&&!S&&!v&&(f=Br(ee,c))}),je.subscribe(ut),!l&&d>0&&(l=new bt({next:function(R){return je.next(R)},error:function(R){S=!0,X(),f=Br(re,n,R),je.error(R)},complete:function(){v=!0,X(),f=Br(re,s),je.complete()}}),U(k).subscribe(l))})(p)}}function Br(e,t){for(var r=[],o=2;oe.next(document)),e}function M(e,t=document){return Array.from(t.querySelectorAll(e))}function j(e,t=document){let r=ue(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function ue(e,t=document){return t.querySelector(e)||void 0}function Ne(){var e,t,r,o;return(o=(r=(t=(e=document.activeElement)==null?void 0:e.shadowRoot)==null?void 0:t.activeElement)!=null?r:document.activeElement)!=null?o:void 0}var Ra=L(h(document.body,"focusin"),h(document.body,"focusout")).pipe(Ae(1),Q(void 0),m(()=>Ne()||document.body),Z(1));function Ye(e){return Ra.pipe(m(t=>e.contains(t)),Y())}function it(e,t){return H(()=>L(h(e,"mouseenter").pipe(m(()=>!0)),h(e,"mouseleave").pipe(m(()=>!1))).pipe(t?jt(r=>He(+!r*t)):be,Q(e.matches(":hover"))))}function sn(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)sn(e,r)}function x(e,t,...r){let o=document.createElement(e);if(t)for(let n of Object.keys(t))typeof t[n]!="undefined"&&(typeof t[n]!="boolean"?o.setAttribute(n,t[n]):o.setAttribute(n,""));for(let n of r)sn(o,n);return o}function br(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function _t(e){let t=x("script",{src:e});return H(()=>(document.head.appendChild(t),L(h(t,"load"),h(t,"error").pipe(b(()=>Nr(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(m(()=>{}),A(()=>document.head.removeChild(t)),Ee(1))))}var cn=new T,Ia=H(()=>typeof ResizeObserver=="undefined"?_t("https://unpkg.com/resize-observer-polyfill"):$(void 0)).pipe(m(()=>new ResizeObserver(e=>e.forEach(t=>cn.next(t)))),b(e=>L(tt,$(e)).pipe(A(()=>e.disconnect()))),Z(1));function de(e){return{width:e.offsetWidth,height:e.offsetHeight}}function Le(e){let t=e;for(;t.clientWidth===0&&t.parentElement;)t=t.parentElement;return Ia.pipe(O(r=>r.observe(t)),b(r=>cn.pipe(g(o=>o.target===t),A(()=>r.unobserve(t)))),m(()=>de(e)),Q(de(e)))}function At(e){return{width:e.scrollWidth,height:e.scrollHeight}}function vr(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}function pn(e){let t=[],r=e.parentElement;for(;r;)(e.clientWidth>r.clientWidth||e.clientHeight>r.clientHeight)&&t.push(r),r=(e=r).parentElement;return t.length===0&&t.push(document.documentElement),t}function Be(e){return{x:e.offsetLeft,y:e.offsetTop}}function ln(e){let t=e.getBoundingClientRect();return{x:t.x+window.scrollX,y:t.y+window.scrollY}}function mn(e){return L(h(window,"load"),h(window,"resize")).pipe($e(0,ye),m(()=>Be(e)),Q(Be(e)))}function gr(e){return{x:e.scrollLeft,y:e.scrollTop}}function Ge(e){return L(h(e,"scroll"),h(window,"scroll"),h(window,"resize")).pipe($e(0,ye),m(()=>gr(e)),Q(gr(e)))}var fn=new T,Fa=H(()=>$(new IntersectionObserver(e=>{for(let t of e)fn.next(t)},{threshold:0}))).pipe(b(e=>L(tt,$(e)).pipe(A(()=>e.disconnect()))),Z(1));function mt(e){return Fa.pipe(O(t=>t.observe(e)),b(t=>fn.pipe(g(({target:r})=>r===e),A(()=>t.unobserve(e)),m(({isIntersecting:r})=>r))))}function un(e,t=16){return Ge(e).pipe(m(({y:r})=>{let o=de(e),n=At(e);return r>=n.height-o.height-t}),Y())}var yr={drawer:j("[data-md-toggle=drawer]"),search:j("[data-md-toggle=search]")};function dn(e){return yr[e].checked}function at(e,t){yr[e].checked!==t&&yr[e].click()}function Je(e){let t=yr[e];return h(t,"change").pipe(m(()=>t.checked),Q(t.checked))}function ja(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function Ua(){return L(h(window,"compositionstart").pipe(m(()=>!0)),h(window,"compositionend").pipe(m(()=>!1))).pipe(Q(!1))}function hn(){let e=h(window,"keydown").pipe(g(t=>!(t.metaKey||t.ctrlKey)),m(t=>({mode:dn("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),g(({mode:t,type:r})=>{if(t==="global"){let o=Ne();if(typeof o!="undefined")return!ja(o,r)}return!0}),le());return Ua().pipe(b(t=>t?y:e))}function we(){return new URL(location.href)}function st(e,t=!1){if(V("navigation.instant")&&!t){let r=x("a",{href:e.href});document.body.appendChild(r),r.click(),r.remove()}else location.href=e.href}function bn(){return new T}function vn(){return location.hash.slice(1)}function gn(e){let t=x("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function Zr(e){return L(h(window,"hashchange"),e).pipe(m(vn),Q(vn()),g(t=>t.length>0),Z(1))}function yn(e){return Zr(e).pipe(m(t=>ue(`[id="${t}"]`)),g(t=>typeof t!="undefined"))}function Wt(e){let t=matchMedia(e);return ur(r=>t.addListener(()=>r(t.matches))).pipe(Q(t.matches))}function xn(){let e=matchMedia("print");return L(h(window,"beforeprint").pipe(m(()=>!0)),h(window,"afterprint").pipe(m(()=>!1))).pipe(Q(e.matches))}function eo(e,t){return e.pipe(b(r=>r?t():y))}function to(e,t){return new F(r=>{let o=new XMLHttpRequest;return o.open("GET",`${e}`),o.responseType="blob",o.addEventListener("load",()=>{o.status>=200&&o.status<300?(r.next(o.response),r.complete()):r.error(new Error(o.statusText))}),o.addEventListener("error",()=>{r.error(new Error("Network error"))}),o.addEventListener("abort",()=>{r.complete()}),typeof(t==null?void 0:t.progress$)!="undefined"&&(o.addEventListener("progress",n=>{var i;if(n.lengthComputable)t.progress$.next(n.loaded/n.total*100);else{let s=(i=o.getResponseHeader("Content-Length"))!=null?i:0;t.progress$.next(n.loaded/+s*100)}}),t.progress$.next(5)),o.send(),()=>o.abort()})}function ze(e,t){return to(e,t).pipe(b(r=>r.text()),m(r=>JSON.parse(r)),Z(1))}function xr(e,t){let r=new DOMParser;return to(e,t).pipe(b(o=>o.text()),m(o=>r.parseFromString(o,"text/html")),Z(1))}function En(e,t){let r=new DOMParser;return to(e,t).pipe(b(o=>o.text()),m(o=>r.parseFromString(o,"text/xml")),Z(1))}function wn(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function Tn(){return L(h(window,"scroll",{passive:!0}),h(window,"resize",{passive:!0})).pipe(m(wn),Q(wn()))}function Sn(){return{width:innerWidth,height:innerHeight}}function On(){return h(window,"resize",{passive:!0}).pipe(m(Sn),Q(Sn()))}function Ln(){return z([Tn(),On()]).pipe(m(([e,t])=>({offset:e,size:t})),Z(1))}function Er(e,{viewport$:t,header$:r}){let o=t.pipe(ne("size")),n=z([o,r]).pipe(m(()=>Be(e)));return z([r,t,n]).pipe(m(([{height:i},{offset:s,size:a},{x:c,y:p}])=>({offset:{x:s.x-c,y:s.y-p+i},size:a})))}function Wa(e){return h(e,"message",t=>t.data)}function Da(e){let t=new T;return t.subscribe(r=>e.postMessage(r)),t}function Mn(e,t=new Worker(e)){let r=Wa(t),o=Da(t),n=new T;n.subscribe(o);let i=o.pipe(oe(),ae(!0));return n.pipe(oe(),Ve(r.pipe(W(i))),le())}var Va=j("#__config"),Ct=JSON.parse(Va.textContent);Ct.base=`${new URL(Ct.base,we())}`;function Te(){return Ct}function V(e){return Ct.features.includes(e)}function Me(e,t){return typeof t!="undefined"?Ct.translations[e].replace("#",t.toString()):Ct.translations[e]}function Ce(e,t=document){return j(`[data-md-component=${e}]`,t)}function me(e,t=document){return M(`[data-md-component=${e}]`,t)}function Na(e){let t=j(".md-typeset > :first-child",e);return h(t,"click",{once:!0}).pipe(m(()=>j(".md-typeset",e)),m(r=>({hash:__md_hash(r.innerHTML)})))}function _n(e){if(!V("announce.dismiss")||!e.childElementCount)return y;if(!e.hidden){let t=j(".md-typeset",e);__md_hash(t.innerHTML)===__md_get("__announce")&&(e.hidden=!0)}return H(()=>{let t=new T;return t.subscribe(({hash:r})=>{e.hidden=!0,__md_set("__announce",r)}),Na(e).pipe(O(r=>t.next(r)),A(()=>t.complete()),m(r=>P({ref:e},r)))})}function za(e,{target$:t}){return t.pipe(m(r=>({hidden:r!==e})))}function An(e,t){let r=new T;return r.subscribe(({hidden:o})=>{e.hidden=o}),za(e,t).pipe(O(o=>r.next(o)),A(()=>r.complete()),m(o=>P({ref:e},o)))}function Dt(e,t){return t==="inline"?x("div",{class:"md-tooltip md-tooltip--inline",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"})):x("div",{class:"md-tooltip",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"}))}function wr(...e){return x("div",{class:"md-tooltip2",role:"dialog"},x("div",{class:"md-tooltip2__inner md-typeset"},e))}function Cn(...e){return x("div",{class:"md-tooltip2",role:"tooltip"},x("div",{class:"md-tooltip2__inner md-typeset"},e))}function kn(e,t){if(t=t?`${t}_annotation_${e}`:void 0,t){let r=t?`#${t}`:void 0;return x("aside",{class:"md-annotation",tabIndex:0},Dt(t),x("a",{href:r,class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}else return x("aside",{class:"md-annotation",tabIndex:0},Dt(t),x("span",{class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}function Hn(e){return x("button",{class:"md-code__button",title:Me("clipboard.copy"),"data-clipboard-target":`#${e} > code`,"data-md-type":"copy"})}function $n(){return x("button",{class:"md-code__button",title:"Toggle line selection","data-md-type":"select"})}function Pn(){return x("nav",{class:"md-code__nav"})}var In=$t(ro());function oo(e,t){let r=t&2,o=t&1,n=Object.keys(e.terms).filter(c=>!e.terms[c]).reduce((c,p)=>[...c,x("del",null,(0,In.default)(p))," "],[]).slice(0,-1),i=Te(),s=new URL(e.location,i.base);V("search.highlight")&&s.searchParams.set("h",Object.entries(e.terms).filter(([,c])=>c).reduce((c,[p])=>`${c} ${p}`.trim(),""));let{tags:a}=Te();return x("a",{href:`${s}`,class:"md-search-result__link",tabIndex:-1},x("article",{class:"md-search-result__article md-typeset","data-md-score":e.score.toFixed(2)},r>0&&x("div",{class:"md-search-result__icon md-icon"}),r>0&&x("h1",null,e.title),r<=0&&x("h2",null,e.title),o>0&&e.text.length>0&&e.text,e.tags&&x("nav",{class:"md-tags"},e.tags.map(c=>{let p=a?c in a?`md-tag-icon md-tag--${a[c]}`:"md-tag-icon":"";return x("span",{class:`md-tag ${p}`},c)})),o>0&&n.length>0&&x("p",{class:"md-search-result__terms"},Me("search.result.term.missing"),": ",...n)))}function Fn(e){let t=e[0].score,r=[...e],o=Te(),n=r.findIndex(l=>!`${new URL(l.location,o.base)}`.includes("#")),[i]=r.splice(n,1),s=r.findIndex(l=>l.scoreoo(l,1)),...c.length?[x("details",{class:"md-search-result__more"},x("summary",{tabIndex:-1},x("div",null,c.length>0&&c.length===1?Me("search.result.more.one"):Me("search.result.more.other",c.length))),...c.map(l=>oo(l,1)))]:[]];return x("li",{class:"md-search-result__item"},p)}function jn(e){return x("ul",{class:"md-source__facts"},Object.entries(e).map(([t,r])=>x("li",{class:`md-source__fact md-source__fact--${t}`},typeof r=="number"?br(r):r)))}function no(e){let t=`tabbed-control tabbed-control--${e}`;return x("div",{class:t,hidden:!0},x("button",{class:"tabbed-button",tabIndex:-1,"aria-hidden":"true"}))}function Un(e){return x("div",{class:"md-typeset__scrollwrap"},x("div",{class:"md-typeset__table"},e))}function Qa(e){var o;let t=Te(),r=new URL(`../${e.version}/`,t.base);return x("li",{class:"md-version__item"},x("a",{href:`${r}`,class:"md-version__link"},e.title,((o=t.version)==null?void 0:o.alias)&&e.aliases.length>0&&x("span",{class:"md-version__alias"},e.aliases[0])))}function Wn(e,t){var o;let r=Te();return e=e.filter(n=>{var i;return!((i=n.properties)!=null&&i.hidden)}),x("div",{class:"md-version"},x("button",{class:"md-version__current","aria-label":Me("select.version")},t.title,((o=r.version)==null?void 0:o.alias)&&t.aliases.length>0&&x("span",{class:"md-version__alias"},t.aliases[0])),x("ul",{class:"md-version__list"},e.map(Qa)))}var Ya=0;function Ba(e,t=250){let r=z([Ye(e),it(e,t)]).pipe(m(([n,i])=>n||i),Y()),o=H(()=>pn(e)).pipe(J(Ge),gt(1),Pe(r),m(()=>ln(e)));return r.pipe(Re(n=>n),b(()=>z([r,o])),m(([n,i])=>({active:n,offset:i})),le())}function Vt(e,t,r=250){let{content$:o,viewport$:n}=t,i=`__tooltip2_${Ya++}`;return H(()=>{let s=new T,a=new jr(!1);s.pipe(oe(),ae(!1)).subscribe(a);let c=a.pipe(jt(l=>He(+!l*250,Dr)),Y(),b(l=>l?o:y),O(l=>l.id=i),le());z([s.pipe(m(({active:l})=>l)),c.pipe(b(l=>it(l,250)),Q(!1))]).pipe(m(l=>l.some(f=>f))).subscribe(a);let p=a.pipe(g(l=>l),te(c,n),m(([l,f,{size:u}])=>{let d=e.getBoundingClientRect(),v=d.width/2;if(f.role==="tooltip")return{x:v,y:8+d.height};if(d.y>=u.height/2){let{height:S}=de(f);return{x:v,y:-16-S}}else return{x:v,y:16+d.height}}));return z([c,s,p]).subscribe(([l,{offset:f},u])=>{l.style.setProperty("--md-tooltip-host-x",`${f.x}px`),l.style.setProperty("--md-tooltip-host-y",`${f.y}px`),l.style.setProperty("--md-tooltip-x",`${u.x}px`),l.style.setProperty("--md-tooltip-y",`${u.y}px`),l.classList.toggle("md-tooltip2--top",u.y<0),l.classList.toggle("md-tooltip2--bottom",u.y>=0)}),a.pipe(g(l=>l),te(c,(l,f)=>f),g(l=>l.role==="tooltip")).subscribe(l=>{let f=de(j(":scope > *",l));l.style.setProperty("--md-tooltip-width",`${f.width}px`),l.style.setProperty("--md-tooltip-tail","0px")}),a.pipe(Y(),xe(ye),te(c)).subscribe(([l,f])=>{f.classList.toggle("md-tooltip2--active",l)}),z([a.pipe(g(l=>l)),c]).subscribe(([l,f])=>{f.role==="dialog"?(e.setAttribute("aria-controls",i),e.setAttribute("aria-haspopup","dialog")):e.setAttribute("aria-describedby",i)}),a.pipe(g(l=>!l)).subscribe(()=>{e.removeAttribute("aria-controls"),e.removeAttribute("aria-describedby"),e.removeAttribute("aria-haspopup")}),Ba(e,r).pipe(O(l=>s.next(l)),A(()=>s.complete()),m(l=>P({ref:e},l)))})}function Xe(e,{viewport$:t},r=document.body){return Vt(e,{content$:new F(o=>{let n=e.title,i=Cn(n);return o.next(i),e.removeAttribute("title"),r.append(i),()=>{i.remove(),e.setAttribute("title",n)}}),viewport$:t},0)}function Ga(e,t){let r=H(()=>z([mn(e),Ge(t)])).pipe(m(([{x:o,y:n},i])=>{let{width:s,height:a}=de(e);return{x:o-i.x+s/2,y:n-i.y+a/2}}));return Ye(e).pipe(b(o=>r.pipe(m(n=>({active:o,offset:n})),Ee(+!o||1/0))))}function Dn(e,t,{target$:r}){let[o,n]=Array.from(e.children);return H(()=>{let i=new T,s=i.pipe(oe(),ae(!0));return i.subscribe({next({offset:a}){e.style.setProperty("--md-tooltip-x",`${a.x}px`),e.style.setProperty("--md-tooltip-y",`${a.y}px`)},complete(){e.style.removeProperty("--md-tooltip-x"),e.style.removeProperty("--md-tooltip-y")}}),mt(e).pipe(W(s)).subscribe(a=>{e.toggleAttribute("data-md-visible",a)}),L(i.pipe(g(({active:a})=>a)),i.pipe(Ae(250),g(({active:a})=>!a))).subscribe({next({active:a}){a?e.prepend(o):o.remove()},complete(){e.prepend(o)}}),i.pipe($e(16,ye)).subscribe(({active:a})=>{o.classList.toggle("md-tooltip--active",a)}),i.pipe(gt(125,ye),g(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:a})=>a)).subscribe({next(a){a?e.style.setProperty("--md-tooltip-0",`${-a}px`):e.style.removeProperty("--md-tooltip-0")},complete(){e.style.removeProperty("--md-tooltip-0")}}),h(n,"click").pipe(W(s),g(a=>!(a.metaKey||a.ctrlKey))).subscribe(a=>{a.stopPropagation(),a.preventDefault()}),h(n,"mousedown").pipe(W(s),te(i)).subscribe(([a,{active:c}])=>{var p;if(a.button!==0||a.metaKey||a.ctrlKey)a.preventDefault();else if(c){a.preventDefault();let l=e.parentElement.closest(".md-annotation");l instanceof HTMLElement?l.focus():(p=Ne())==null||p.blur()}}),r.pipe(W(s),g(a=>a===o),nt(125)).subscribe(()=>e.focus()),Ga(e,t).pipe(O(a=>i.next(a)),A(()=>i.complete()),m(a=>P({ref:e},a)))})}function Ja(e){let t=Te();if(e.tagName!=="CODE")return[e];let r=[".c",".c1",".cm"];if(t.annotate&&typeof t.annotate=="object"){let o=e.closest("[class|=language]");if(o)for(let n of Array.from(o.classList)){if(!n.startsWith("language-"))continue;let[,i]=n.split("-");i in t.annotate&&r.push(...t.annotate[i])}}return M(r.join(", "),e)}function Xa(e){let t=[];for(let r of Ja(e)){let o=[],n=document.createNodeIterator(r,NodeFilter.SHOW_TEXT);for(let i=n.nextNode();i;i=n.nextNode())o.push(i);for(let i of o){let s;for(;s=/(\(\d+\))(!)?/.exec(i.textContent);){let[,a,c]=s;if(typeof c=="undefined"){let p=i.splitText(s.index);i=p.splitText(a.length),t.push(p)}else{i.textContent=a,t.push(i);break}}}}return t}function Vn(e,t){t.append(...Array.from(e.childNodes))}function Tr(e,t,{target$:r,print$:o}){let n=t.closest("[id]"),i=n==null?void 0:n.id,s=new Map;for(let a of Xa(t)){let[,c]=a.textContent.match(/\((\d+)\)/);ue(`:scope > li:nth-child(${c})`,e)&&(s.set(c,kn(c,i)),a.replaceWith(s.get(c)))}return s.size===0?y:H(()=>{let a=new T,c=a.pipe(oe(),ae(!0)),p=[];for(let[l,f]of s)p.push([j(".md-typeset",f),j(`:scope > li:nth-child(${l})`,e)]);return o.pipe(W(c)).subscribe(l=>{e.hidden=!l,e.classList.toggle("md-annotation-list",l);for(let[f,u]of p)l?Vn(f,u):Vn(u,f)}),L(...[...s].map(([,l])=>Dn(l,t,{target$:r}))).pipe(A(()=>a.complete()),le())})}function Nn(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return Nn(t)}}function zn(e,t){return H(()=>{let r=Nn(e);return typeof r!="undefined"?Tr(r,e,t):y})}var Kn=$t(ao());var Za=0,qn=L(h(window,"keydown").pipe(m(()=>!0)),L(h(window,"keyup"),h(window,"contextmenu")).pipe(m(()=>!1))).pipe(Q(!1),Z(1));function Qn(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return Qn(t)}}function es(e){return Le(e).pipe(m(({width:t})=>({scrollable:At(e).width>t})),ne("scrollable"))}function Yn(e,t){let{matches:r}=matchMedia("(hover)"),o=H(()=>{let n=new T,i=n.pipe(Yr(1));n.subscribe(({scrollable:d})=>{d&&r?e.setAttribute("tabindex","0"):e.removeAttribute("tabindex")});let s=[],a=e.closest("pre"),c=a.closest("[id]"),p=c?c.id:Za++;a.id=`__code_${p}`;let l=[],f=e.closest(".highlight");if(f instanceof HTMLElement){let d=Qn(f);if(typeof d!="undefined"&&(f.classList.contains("annotate")||V("content.code.annotate"))){let v=Tr(d,e,t);l.push(Le(f).pipe(W(i),m(({width:S,height:X})=>S&&X),Y(),b(S=>S?v:y)))}}let u=M(":scope > span[id]",e);if(u.length&&(e.classList.add("md-code__content"),e.closest(".select")||V("content.code.select")&&!e.closest(".no-select"))){let d=+u[0].id.split("-").pop(),v=$n();s.push(v),V("content.tooltips")&&l.push(Xe(v,{viewport$}));let S=h(v,"click").pipe(Ut(R=>!R,!1),O(()=>v.blur()),le());S.subscribe(R=>{v.classList.toggle("md-code__button--active",R)});let X=fe(u).pipe(J(R=>it(R).pipe(m(se=>[R,se]))));S.pipe(b(R=>R?X:y)).subscribe(([R,se])=>{let ce=ue(".hll.select",R);if(ce&&!se)ce.replaceWith(...Array.from(ce.childNodes));else if(!ce&&se){let he=document.createElement("span");he.className="hll select",he.append(...Array.from(R.childNodes).slice(1)),R.append(he)}});let re=fe(u).pipe(J(R=>h(R,"mousedown").pipe(O(se=>se.preventDefault()),m(()=>R)))),ee=S.pipe(b(R=>R?re:y),te(qn),m(([R,se])=>{var he;let ce=u.indexOf(R)+d;if(se===!1)return[ce,ce];{let Se=M(".hll",e).map(Ue=>u.indexOf(Ue.parentElement)+d);return(he=window.getSelection())==null||he.removeAllRanges(),[Math.min(ce,...Se),Math.max(ce,...Se)]}})),k=Zr(y).pipe(g(R=>R.startsWith(`__codelineno-${p}-`)));k.subscribe(R=>{let[,,se]=R.split("-"),ce=se.split(":").map(Se=>+Se-d+1);ce.length===1&&ce.push(ce[0]);for(let Se of M(".hll:not(.select)",e))Se.replaceWith(...Array.from(Se.childNodes));let he=u.slice(ce[0]-1,ce[1]);for(let Se of he){let Ue=document.createElement("span");Ue.className="hll",Ue.append(...Array.from(Se.childNodes).slice(1)),Se.append(Ue)}}),k.pipe(Ee(1),xe(pe)).subscribe(R=>{if(R.includes(":")){let se=document.getElementById(R.split(":")[0]);se&&setTimeout(()=>{let ce=se,he=-64;for(;ce!==document.body;)he+=ce.offsetTop,ce=ce.offsetParent;window.scrollTo({top:he})},1)}});let je=fe(M('a[href^="#__codelineno"]',f)).pipe(J(R=>h(R,"click").pipe(O(se=>se.preventDefault()),m(()=>R)))).pipe(W(i),te(qn),m(([R,se])=>{let he=+j(`[id="${R.hash.slice(1)}"]`).parentElement.id.split("-").pop();if(se===!1)return[he,he];{let Se=M(".hll",e).map(Ue=>+Ue.parentElement.id.split("-").pop());return[Math.min(he,...Se),Math.max(he,...Se)]}}));L(ee,je).subscribe(R=>{let se=`#__codelineno-${p}-`;R[0]===R[1]?se+=R[0]:se+=`${R[0]}:${R[1]}`,history.replaceState({},"",se),window.dispatchEvent(new HashChangeEvent("hashchange",{newURL:window.location.origin+window.location.pathname+se,oldURL:window.location.href}))})}if(Kn.default.isSupported()&&(e.closest(".copy")||V("content.code.copy")&&!e.closest(".no-copy"))){let d=Hn(a.id);s.push(d),V("content.tooltips")&&l.push(Xe(d,{viewport$}))}if(s.length){let d=Pn();d.append(...s),a.insertBefore(d,e)}return es(e).pipe(O(d=>n.next(d)),A(()=>n.complete()),m(d=>P({ref:e},d)),Ve(L(...l).pipe(W(i))))});return V("content.lazy")?mt(e).pipe(g(n=>n),Ee(1),b(()=>o)):o}function ts(e,{target$:t,print$:r}){let o=!0;return L(t.pipe(m(n=>n.closest("details:not([open])")),g(n=>e===n),m(()=>({action:"open",reveal:!0}))),r.pipe(g(n=>n||!o),O(()=>o=e.open),m(n=>({action:n?"open":"close"}))))}function Bn(e,t){return H(()=>{let r=new T;return r.subscribe(({action:o,reveal:n})=>{e.toggleAttribute("open",o==="open"),n&&e.scrollIntoView()}),ts(e,t).pipe(O(o=>r.next(o)),A(()=>r.complete()),m(o=>P({ref:e},o)))})}var Gn=0;function rs(e){let t=document.createElement("h3");t.innerHTML=e.innerHTML;let r=[t],o=e.nextElementSibling;for(;o&&!(o instanceof HTMLHeadingElement);)r.push(o),o=o.nextElementSibling;return r}function os(e,t){for(let r of M("[href], [src]",e))for(let o of["href","src"]){let n=r.getAttribute(o);if(n&&!/^(?:[a-z]+:)?\/\//i.test(n)){r[o]=new URL(r.getAttribute(o),t).toString();break}}for(let r of M("[name^=__], [for]",e))for(let o of["id","for","name"]){let n=r.getAttribute(o);n&&r.setAttribute(o,`${n}$preview_${Gn}`)}return Gn++,$(e)}function Jn(e,t){let{sitemap$:r}=t;if(!(e instanceof HTMLAnchorElement))return y;if(!(V("navigation.instant.preview")||e.hasAttribute("data-preview")))return y;e.removeAttribute("title");let o=z([Ye(e),it(e)]).pipe(m(([i,s])=>i||s),Y(),g(i=>i));return rt([r,o]).pipe(b(([i])=>{let s=new URL(e.href);return s.search=s.hash="",i.has(`${s}`)?$(s):y}),b(i=>xr(i).pipe(b(s=>os(s,i)))),b(i=>{let s=e.hash?`article [id="${e.hash.slice(1)}"]`:"article h1",a=ue(s,i);return typeof a=="undefined"?y:$(rs(a))})).pipe(b(i=>{let s=new F(a=>{let c=wr(...i);return a.next(c),document.body.append(c),()=>c.remove()});return Vt(e,P({content$:s},t))}))}var Xn=".node circle,.node ellipse,.node path,.node polygon,.node rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}marker{fill:var(--md-mermaid-edge-color)!important}.edgeLabel .label rect{fill:#0000}.flowchartTitleText{fill:var(--md-mermaid-label-fg-color)}.label{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.label foreignObject{line-height:normal;overflow:visible}.label div .edgeLabel{color:var(--md-mermaid-label-fg-color)}.edgeLabel,.edgeLabel p,.label div .edgeLabel{background-color:var(--md-mermaid-label-bg-color)}.edgeLabel,.edgeLabel p{fill:var(--md-mermaid-label-bg-color);color:var(--md-mermaid-edge-color)}.edgePath .path,.flowchart-link{stroke:var(--md-mermaid-edge-color)}.edgePath .arrowheadPath{fill:var(--md-mermaid-edge-color);stroke:none}.cluster rect{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}.cluster span{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}g #flowchart-circleEnd,g #flowchart-circleStart,g #flowchart-crossEnd,g #flowchart-crossStart,g #flowchart-pointEnd,g #flowchart-pointStart{stroke:none}.classDiagramTitleText{fill:var(--md-mermaid-label-fg-color)}g.classGroup line,g.classGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.classGroup text{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.classLabel .box{fill:var(--md-mermaid-label-bg-color);background-color:var(--md-mermaid-label-bg-color);opacity:1}.classLabel .label{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node .divider{stroke:var(--md-mermaid-node-fg-color)}.relation{stroke:var(--md-mermaid-edge-color)}.cardinality{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.cardinality text{fill:inherit!important}defs marker.marker.composition.class path,defs marker.marker.dependency.class path,defs marker.marker.extension.class path{fill:var(--md-mermaid-edge-color)!important;stroke:var(--md-mermaid-edge-color)!important}defs marker.marker.aggregation.class path{fill:var(--md-mermaid-label-bg-color)!important;stroke:var(--md-mermaid-edge-color)!important}.statediagramTitleText{fill:var(--md-mermaid-label-fg-color)}g.stateGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.stateGroup .state-title{fill:var(--md-mermaid-label-fg-color)!important;font-family:var(--md-mermaid-font-family)}g.stateGroup .composit{fill:var(--md-mermaid-label-bg-color)}.nodeLabel,.nodeLabel p{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}a .nodeLabel{text-decoration:underline}.node circle.state-end,.node circle.state-start,.start-state{fill:var(--md-mermaid-edge-color);stroke:none}.end-state-inner,.end-state-outer{fill:var(--md-mermaid-edge-color)}.end-state-inner,.node circle.state-end{stroke:var(--md-mermaid-label-bg-color)}.transition{stroke:var(--md-mermaid-edge-color)}[id^=state-fork] rect,[id^=state-join] rect{fill:var(--md-mermaid-edge-color)!important;stroke:none!important}.statediagram-cluster.statediagram-cluster .inner{fill:var(--md-default-bg-color)}.statediagram-cluster rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.statediagram-state rect.divider{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}defs #statediagram-barbEnd{stroke:var(--md-mermaid-edge-color)}[id^=entity] path,[id^=entity] rect{fill:var(--md-default-bg-color)}.relationshipLine{stroke:var(--md-mermaid-edge-color)}defs .marker.oneOrMore.er *,defs .marker.onlyOne.er *,defs .marker.zeroOrMore.er *,defs .marker.zeroOrOne.er *{stroke:var(--md-mermaid-edge-color)!important}text:not([class]):last-child{fill:var(--md-mermaid-label-fg-color)}.actor{fill:var(--md-mermaid-sequence-actor-bg-color);stroke:var(--md-mermaid-sequence-actor-border-color)}text.actor>tspan{fill:var(--md-mermaid-sequence-actor-fg-color);font-family:var(--md-mermaid-font-family)}line{stroke:var(--md-mermaid-sequence-actor-line-color)}.actor-man circle,.actor-man line{fill:var(--md-mermaid-sequence-actorman-bg-color);stroke:var(--md-mermaid-sequence-actorman-line-color)}.messageLine0,.messageLine1{stroke:var(--md-mermaid-sequence-message-line-color)}.note{fill:var(--md-mermaid-sequence-note-bg-color);stroke:var(--md-mermaid-sequence-note-border-color)}.loopText,.loopText>tspan,.messageText,.noteText>tspan{stroke:none;font-family:var(--md-mermaid-font-family)!important}.messageText{fill:var(--md-mermaid-sequence-message-fg-color)}.loopText,.loopText>tspan{fill:var(--md-mermaid-sequence-loop-fg-color)}.noteText>tspan{fill:var(--md-mermaid-sequence-note-fg-color)}#arrowhead path{fill:var(--md-mermaid-sequence-message-line-color);stroke:none}.loopLine{fill:var(--md-mermaid-sequence-loop-bg-color);stroke:var(--md-mermaid-sequence-loop-border-color)}.labelBox{fill:var(--md-mermaid-sequence-label-bg-color);stroke:none}.labelText,.labelText>span{fill:var(--md-mermaid-sequence-label-fg-color);font-family:var(--md-mermaid-font-family)}.sequenceNumber{fill:var(--md-mermaid-sequence-number-fg-color)}rect.rect{fill:var(--md-mermaid-sequence-box-bg-color);stroke:none}rect.rect+text.text{fill:var(--md-mermaid-sequence-box-fg-color)}defs #sequencenumber{fill:var(--md-mermaid-sequence-number-bg-color)!important}";var so,is=0;function as(){return typeof mermaid=="undefined"||mermaid instanceof Element?_t("https://unpkg.com/mermaid@11/dist/mermaid.min.js"):$(void 0)}function Zn(e){return e.classList.remove("mermaid"),so||(so=as().pipe(O(()=>mermaid.initialize({startOnLoad:!1,themeCSS:Xn,sequence:{actorFontSize:"16px",messageFontSize:"16px",noteFontSize:"16px"}})),m(()=>{}),Z(1))),so.subscribe(()=>go(null,null,function*(){e.classList.add("mermaid");let t=`__mermaid_${is++}`,r=x("div",{class:"mermaid"}),o=e.textContent,{svg:n,fn:i}=yield mermaid.render(t,o),s=r.attachShadow({mode:"closed"});s.innerHTML=n,e.replaceWith(r),i==null||i(s)})),so.pipe(m(()=>({ref:e})))}var ei=x("table");function ti(e){return e.replaceWith(ei),ei.replaceWith(Un(e)),$({ref:e})}function ss(e){let t=e.find(r=>r.checked)||e[0];return L(...e.map(r=>h(r,"change").pipe(m(()=>j(`label[for="${r.id}"]`))))).pipe(Q(j(`label[for="${t.id}"]`)),m(r=>({active:r})))}function ri(e,{viewport$:t,target$:r}){let o=j(".tabbed-labels",e),n=M(":scope > input",e),i=no("prev");e.append(i);let s=no("next");return e.append(s),H(()=>{let a=new T,c=a.pipe(oe(),ae(!0));z([a,Le(e),mt(e)]).pipe(W(c),$e(1,ye)).subscribe({next([{active:p},l]){let f=Be(p),{width:u}=de(p);e.style.setProperty("--md-indicator-x",`${f.x}px`),e.style.setProperty("--md-indicator-width",`${u}px`);let d=gr(o);(f.xd.x+l.width)&&o.scrollTo({left:Math.max(0,f.x-16),behavior:"smooth"})},complete(){e.style.removeProperty("--md-indicator-x"),e.style.removeProperty("--md-indicator-width")}}),z([Ge(o),Le(o)]).pipe(W(c)).subscribe(([p,l])=>{let f=At(o);i.hidden=p.x<16,s.hidden=p.x>f.width-l.width-16}),L(h(i,"click").pipe(m(()=>-1)),h(s,"click").pipe(m(()=>1))).pipe(W(c)).subscribe(p=>{let{width:l}=de(o);o.scrollBy({left:l*p,behavior:"smooth"})}),r.pipe(W(c),g(p=>n.includes(p))).subscribe(p=>p.click()),o.classList.add("tabbed-labels--linked");for(let p of n){let l=j(`label[for="${p.id}"]`);l.replaceChildren(x("a",{href:`#${l.htmlFor}`,tabIndex:-1},...Array.from(l.childNodes))),h(l.firstElementChild,"click").pipe(W(c),g(f=>!(f.metaKey||f.ctrlKey)),O(f=>{f.preventDefault(),f.stopPropagation()})).subscribe(()=>{history.replaceState({},"",`#${l.htmlFor}`),l.click()})}return V("content.tabs.link")&&a.pipe(Ie(1),te(t)).subscribe(([{active:p},{offset:l}])=>{let f=p.innerText.trim();if(p.hasAttribute("data-md-switching"))p.removeAttribute("data-md-switching");else{let u=e.offsetTop-l.y;for(let v of M("[data-tabs]"))for(let S of M(":scope > input",v)){let X=j(`label[for="${S.id}"]`);if(X!==p&&X.innerText.trim()===f){X.setAttribute("data-md-switching",""),S.click();break}}window.scrollTo({top:e.offsetTop-u});let d=__md_get("__tabs")||[];__md_set("__tabs",[...new Set([f,...d])])}}),a.pipe(W(c)).subscribe(()=>{for(let p of M("audio, video",e))p.offsetWidth&&p.autoplay?p.play().catch(()=>{}):p.pause()}),ss(n).pipe(O(p=>a.next(p)),A(()=>a.complete()),m(p=>P({ref:e},p)))}).pipe(et(pe))}function oi(e,t){let{viewport$:r,target$:o,print$:n}=t;return L(...M(".annotate:not(.highlight)",e).map(i=>zn(i,{target$:o,print$:n})),...M("pre:not(.mermaid) > code",e).map(i=>Yn(i,{target$:o,print$:n})),...M("a",e).map(i=>Jn(i,t)),...M("pre.mermaid",e).map(i=>Zn(i)),...M("table:not([class])",e).map(i=>ti(i)),...M("details",e).map(i=>Bn(i,{target$:o,print$:n})),...M("[data-tabs]",e).map(i=>ri(i,{viewport$:r,target$:o})),...M("[title]:not([data-preview])",e).filter(()=>V("content.tooltips")).map(i=>Xe(i,{viewport$:r})),...M(".footnote-ref",e).filter(()=>V("content.footnote.tooltips")).map(i=>Vt(i,{content$:new F(s=>{let a=new URL(i.href).hash.slice(1),c=Array.from(document.getElementById(a).cloneNode(!0).children),p=wr(...c);return s.next(p),document.body.append(p),()=>p.remove()}),viewport$:r})))}function cs(e,{alert$:t}){return t.pipe(b(r=>L($(!0),$(!1).pipe(nt(2e3))).pipe(m(o=>({message:r,active:o})))))}function ni(e,t){let r=j(".md-typeset",e);return H(()=>{let o=new T;return o.subscribe(({message:n,active:i})=>{e.classList.toggle("md-dialog--active",i),r.textContent=n}),cs(e,t).pipe(O(n=>o.next(n)),A(()=>o.complete()),m(n=>P({ref:e},n)))})}var ps=0;function ls(e,t){document.body.append(e);let{width:r}=de(e);e.style.setProperty("--md-tooltip-width",`${r}px`),e.remove();let o=vr(t),n=typeof o!="undefined"?Ge(o):$({x:0,y:0}),i=L(Ye(t),it(t)).pipe(Y());return z([i,n]).pipe(m(([s,a])=>{let{x:c,y:p}=Be(t),l=de(t),f=t.closest("table");return f&&t.parentElement&&(c+=f.offsetLeft+t.parentElement.offsetLeft,p+=f.offsetTop+t.parentElement.offsetTop),{active:s,offset:{x:c-a.x+l.width/2-r/2,y:p-a.y+l.height+8}}}))}function ii(e){let t=e.title;if(!t.length)return y;let r=`__tooltip_${ps++}`,o=Dt(r,"inline"),n=j(".md-typeset",o);return n.innerHTML=t,H(()=>{let i=new T;return i.subscribe({next({offset:s}){o.style.setProperty("--md-tooltip-x",`${s.x}px`),o.style.setProperty("--md-tooltip-y",`${s.y}px`)},complete(){o.style.removeProperty("--md-tooltip-x"),o.style.removeProperty("--md-tooltip-y")}}),L(i.pipe(g(({active:s})=>s)),i.pipe(Ae(250),g(({active:s})=>!s))).subscribe({next({active:s}){s?(e.insertAdjacentElement("afterend",o),e.setAttribute("aria-describedby",r),e.removeAttribute("title")):(o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t))},complete(){o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t)}}),i.pipe($e(16,ye)).subscribe(({active:s})=>{o.classList.toggle("md-tooltip--active",s)}),i.pipe(gt(125,ye),g(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:s})=>s)).subscribe({next(s){s?o.style.setProperty("--md-tooltip-0",`${-s}px`):o.style.removeProperty("--md-tooltip-0")},complete(){o.style.removeProperty("--md-tooltip-0")}}),ls(o,e).pipe(O(s=>i.next(s)),A(()=>i.complete()),m(s=>P({ref:e},s)))}).pipe(et(pe))}function ms({viewport$:e}){if(!V("header.autohide"))return $(!1);let t=e.pipe(m(({offset:{y:n}})=>n),ot(2,1),m(([n,i])=>[nMath.abs(i-n.y)>100),m(([,[n]])=>n),Y()),o=Je("search");return z([e,o]).pipe(m(([{offset:n},i])=>n.y>400&&!i),Y(),b(n=>n?r:$(!1)),Q(!1))}function ai(e,t){return H(()=>z([Le(e),ms(t)])).pipe(m(([{height:r},o])=>({height:r,hidden:o})),Y((r,o)=>r.height===o.height&&r.hidden===o.hidden),Z(1))}function si(e,{header$:t,main$:r}){return H(()=>{let o=new T,n=o.pipe(oe(),ae(!0));o.pipe(ne("active"),Pe(t)).subscribe(([{active:s},{hidden:a}])=>{e.classList.toggle("md-header--shadow",s&&!a),e.hidden=a});let i=fe(M("[title]",e)).pipe(g(()=>V("content.tooltips")),J(s=>ii(s)));return r.subscribe(o),t.pipe(W(n),m(s=>P({ref:e},s)),Ve(i.pipe(W(n))))})}function fs(e,{viewport$:t,header$:r}){return Er(e,{viewport$:t,header$:r}).pipe(m(({offset:{y:o}})=>{let{height:n}=de(e);return{active:n>0&&o>=n}}),ne("active"))}function ci(e,t){return H(()=>{let r=new T;r.subscribe({next({active:n}){e.classList.toggle("md-header__title--active",n)},complete(){e.classList.remove("md-header__title--active")}});let o=ue(".md-content h1");return typeof o=="undefined"?y:fs(o,t).pipe(O(n=>r.next(n)),A(()=>r.complete()),m(n=>P({ref:e},n)))})}function pi(e,{viewport$:t,header$:r}){let o=r.pipe(m(({height:i})=>i),Y()),n=o.pipe(b(()=>Le(e).pipe(m(({height:i})=>({top:e.offsetTop,bottom:e.offsetTop+i})),ne("bottom"))));return z([o,n,t]).pipe(m(([i,{top:s,bottom:a},{offset:{y:c},size:{height:p}}])=>(p=Math.max(0,p-Math.max(0,s-c,i)-Math.max(0,p+c-a)),{offset:s-i,height:p,active:s-i<=c})),Y((i,s)=>i.offset===s.offset&&i.height===s.height&&i.active===s.active))}function us(e){let t=__md_get("__palette")||{index:e.findIndex(o=>matchMedia(o.getAttribute("data-md-color-media")).matches)},r=Math.max(0,Math.min(t.index,e.length-1));return $(...e).pipe(J(o=>h(o,"change").pipe(m(()=>o))),Q(e[r]),m(o=>({index:e.indexOf(o),color:{media:o.getAttribute("data-md-color-media"),scheme:o.getAttribute("data-md-color-scheme"),primary:o.getAttribute("data-md-color-primary"),accent:o.getAttribute("data-md-color-accent")}})),Z(1))}function li(e){let t=M("input",e),r=x("meta",{name:"theme-color"});document.head.appendChild(r);let o=x("meta",{name:"color-scheme"});document.head.appendChild(o);let n=Wt("(prefers-color-scheme: light)");return H(()=>{let i=new T;return i.subscribe(s=>{if(document.body.setAttribute("data-md-color-switching",""),s.color.media==="(prefers-color-scheme)"){let a=matchMedia("(prefers-color-scheme: light)"),c=document.querySelector(a.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");s.color.scheme=c.getAttribute("data-md-color-scheme"),s.color.primary=c.getAttribute("data-md-color-primary"),s.color.accent=c.getAttribute("data-md-color-accent")}for(let[a,c]of Object.entries(s.color))document.body.setAttribute(`data-md-color-${a}`,c);for(let a=0;as.key==="Enter"),te(i,(s,a)=>a)).subscribe(({index:s})=>{s=(s+1)%t.length,t[s].click(),t[s].focus()}),i.pipe(m(()=>{let s=Ce("header"),a=window.getComputedStyle(s);return o.content=a.colorScheme,a.backgroundColor.match(/\d+/g).map(c=>(+c).toString(16).padStart(2,"0")).join("")})).subscribe(s=>r.content=`#${s}`),i.pipe(xe(pe)).subscribe(()=>{document.body.removeAttribute("data-md-color-switching")}),us(t).pipe(W(n.pipe(Ie(1))),vt(),O(s=>i.next(s)),A(()=>i.complete()),m(s=>P({ref:e},s)))})}function mi(e,{progress$:t}){return H(()=>{let r=new T;return r.subscribe(({value:o})=>{e.style.setProperty("--md-progress-value",`${o}`)}),t.pipe(O(o=>r.next({value:o})),A(()=>r.complete()),m(o=>({ref:e,value:o})))})}function fi(e,t){return e.protocol=t.protocol,e.hostname=t.hostname,e}function ds(e,t){let r=new Map;for(let o of M("url",e)){let n=j("loc",o),i=[fi(new URL(n.textContent),t)];r.set(`${i[0]}`,i);for(let s of M("[rel=alternate]",o)){let a=s.getAttribute("href");a!=null&&i.push(fi(new URL(a),t))}}return r}function kt(e){return En(new URL("sitemap.xml",e)).pipe(m(t=>ds(t,new URL(e))),ve(()=>$(new Map)),le())}function ui({document$:e}){let t=new Map;e.pipe(b(()=>M("link[rel=alternate]")),m(r=>new URL(r.href)),g(r=>!t.has(r.toString())),J(r=>kt(r).pipe(m(o=>[r,o]),ve(()=>y)))).subscribe(([r,o])=>{t.set(r.toString().replace(/\/$/,""),o)}),h(document.body,"click").pipe(g(r=>!r.metaKey&&!r.ctrlKey),b(r=>{if(r.target instanceof Element){let o=r.target.closest("a");if(o&&!o.target){let n=[...t].find(([f])=>o.href.startsWith(`${f}/`));if(typeof n=="undefined")return y;let[i,s]=n,a=we();if(a.href.startsWith(i))return y;let c=Te(),p=a.href.replace(c.base,"");p=`${i}/${p}`;let l=s.has(p.split("#")[0])?new URL(p,c.base):new URL(i);return r.preventDefault(),$(l)}}return y})).subscribe(r=>st(r,!0))}var co=$t(ao());function hs(e){e.setAttribute("data-md-copying","");let t=e.closest("[data-copy]"),r=t?t.getAttribute("data-copy"):e.innerText;return e.removeAttribute("data-md-copying"),r.trimEnd()}function di({alert$:e}){co.default.isSupported()&&new F(t=>{new co.default("[data-clipboard-target], [data-clipboard-text]",{text:r=>r.getAttribute("data-clipboard-text")||hs(j(r.getAttribute("data-clipboard-target")))}).on("success",r=>t.next(r))}).pipe(O(t=>{t.trigger.focus()}),m(()=>Me("clipboard.copied"))).subscribe(e)}function hi(e,t){if(!(e.target instanceof Element))return y;let r=e.target.closest("a");if(r===null)return y;if(r.target||e.metaKey||e.ctrlKey)return y;let o=new URL(r.href);return o.search=o.hash="",t.has(`${o}`)?(e.preventDefault(),$(r)):y}function bi(e){let t=new Map;for(let r of M(":scope > *",e.head))t.set(r.outerHTML,r);return t}function vi(e){for(let t of M("[href], [src]",e))for(let r of["href","src"]){let o=t.getAttribute(r);if(o&&!/^(?:[a-z]+:)?\/\//i.test(o)){t[r]=t[r];break}}return $(e)}function bs(e){for(let o of["[data-md-component=announce]","[data-md-component=container]","[data-md-component=header-topic]","[data-md-component=outdated]","[data-md-component=logo]","[data-md-component=skip]",...V("navigation.tabs.sticky")?["[data-md-component=tabs]"]:[]]){let n=ue(o),i=ue(o,e);typeof n!="undefined"&&typeof i!="undefined"&&n.replaceWith(i)}let t=bi(document);for(let[o,n]of bi(e))t.has(o)?t.delete(o):document.head.appendChild(n);for(let o of t.values()){let n=o.getAttribute("name");n!=="theme-color"&&n!=="color-scheme"&&o.remove()}let r=Ce("container");return Ke(M("script",r)).pipe(b(o=>{let n=e.createElement("script");if(o.src){for(let i of o.getAttributeNames())n.setAttribute(i,o.getAttribute(i));return o.replaceWith(n),new F(i=>{n.onload=()=>i.complete()})}else return n.textContent=o.textContent,o.replaceWith(n),y}),oe(),ae(document))}function gi({sitemap$:e,location$:t,viewport$:r,progress$:o}){if(location.protocol==="file:")return y;$(document).subscribe(vi);let n=h(document.body,"click").pipe(Pe(e),b(([a,c])=>hi(a,c)),m(({href:a})=>new URL(a)),le()),i=h(window,"popstate").pipe(m(we),le());n.pipe(te(r)).subscribe(([a,{offset:c}])=>{history.replaceState(c,""),history.pushState(null,"",a)}),L(n,i).subscribe(t);let s=t.pipe(ne("pathname"),b(a=>xr(a,{progress$:o}).pipe(ve(()=>(st(a,!0),y)))),b(vi),b(bs),le());return L(s.pipe(te(t,(a,c)=>c)),s.pipe(b(()=>t),ne("hash")),t.pipe(Y((a,c)=>a.pathname===c.pathname&&a.hash===c.hash),b(()=>n),O(()=>history.back()))).subscribe(a=>{var c,p;history.state!==null||!a.hash?window.scrollTo(0,(p=(c=history.state)==null?void 0:c.y)!=null?p:0):(history.scrollRestoration="auto",gn(a.hash),history.scrollRestoration="manual")}),t.subscribe(()=>{history.scrollRestoration="manual"}),h(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"}),r.pipe(ne("offset"),Ae(100)).subscribe(({offset:a})=>{history.replaceState(a,"")}),V("navigation.instant.prefetch")&&L(h(document.body,"mousemove"),h(document.body,"focusin")).pipe(Pe(e),b(([a,c])=>hi(a,c)),Ae(25),Qr(({href:a})=>a),hr(a=>{let c=document.createElement("link");return c.rel="prefetch",c.href=a.toString(),document.head.appendChild(c),h(c,"load").pipe(m(()=>c),Ee(1))})).subscribe(a=>a.remove()),s}var yi=$t(ro());function xi(e){let t=e.separator.split("|").map(n=>n.replace(/(\(\?[!=<][^)]+\))/g,"").length===0?"\uFFFD":n).join("|"),r=new RegExp(t,"img"),o=(n,i,s)=>`${i}${s}`;return n=>{n=n.replace(/[\s*+\-:~^]+/g," ").replace(/&/g,"&").trim();let i=new RegExp(`(^|${e.separator}|)(${n.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(r,"|")})`,"img");return s=>(0,yi.default)(s).replace(i,o).replace(/<\/mark>(\s+)]*>/img,"$1")}}function zt(e){return e.type===1}function Sr(e){return e.type===3}function Ei(e,t){let r=Mn(e);return L($(location.protocol!=="file:"),Je("search")).pipe(Re(o=>o),b(()=>t)).subscribe(({config:o,docs:n})=>r.next({type:0,data:{config:o,docs:n,options:{suggest:V("search.suggest")}}})),r}function wi(e){var l;let{selectedVersionSitemap:t,selectedVersionBaseURL:r,currentLocation:o,currentBaseURL:n}=e,i=(l=po(n))==null?void 0:l.pathname;if(i===void 0)return;let s=ys(o.pathname,i);if(s===void 0)return;let a=Es(t.keys());if(!t.has(a))return;let c=po(s,a);if(!c||!t.has(c.href))return;let p=po(s,r);if(p)return p.hash=o.hash,p.search=o.search,p}function po(e,t){try{return new URL(e,t)}catch(r){return}}function ys(e,t){if(e.startsWith(t))return e.slice(t.length)}function xs(e,t){let r=Math.min(e.length,t.length),o;for(o=0;oy)),o=r.pipe(m(n=>{let[,i]=t.base.match(/([^/]+)\/?$/);return n.find(({version:s,aliases:a})=>s===i||a.includes(i))||n[0]}));r.pipe(m(n=>new Map(n.map(i=>[`${new URL(`../${i.version}/`,t.base)}`,i]))),b(n=>h(document.body,"click").pipe(g(i=>!i.metaKey&&!i.ctrlKey),te(o),b(([i,s])=>{if(i.target instanceof Element){let a=i.target.closest("a");if(a&&!a.target&&n.has(a.href)){let c=a.href;return!i.target.closest(".md-version")&&n.get(c)===s?y:(i.preventDefault(),$(new URL(c)))}}return y}),b(i=>kt(i).pipe(m(s=>{var a;return(a=wi({selectedVersionSitemap:s,selectedVersionBaseURL:i,currentLocation:we(),currentBaseURL:t.base}))!=null?a:i})))))).subscribe(n=>st(n,!0)),z([r,o]).subscribe(([n,i])=>{j(".md-header__topic").appendChild(Wn(n,i))}),e.pipe(b(()=>o)).subscribe(n=>{var a;let i=new URL(t.base),s=__md_get("__outdated",sessionStorage,i);if(s===null){s=!0;let c=((a=t.version)==null?void 0:a.default)||"latest";Array.isArray(c)||(c=[c]);e:for(let p of c)for(let l of n.aliases.concat(n.version))if(new RegExp(p,"i").test(l)){s=!1;break e}__md_set("__outdated",s,sessionStorage,i)}if(s)for(let c of me("outdated"))c.hidden=!1})}function ws(e,{worker$:t}){let{searchParams:r}=we();r.has("q")&&(at("search",!0),e.value=r.get("q"),e.focus(),Je("search").pipe(Re(i=>!i)).subscribe(()=>{let i=we();i.searchParams.delete("q"),history.replaceState({},"",`${i}`)}));let o=Ye(e),n=L(t.pipe(Re(zt)),h(e,"keyup"),o).pipe(m(()=>e.value),Y());return z([n,o]).pipe(m(([i,s])=>({value:i,focus:s})),Z(1))}function Si(e,{worker$:t}){let r=new T,o=r.pipe(oe(),ae(!0));z([t.pipe(Re(zt)),r],(i,s)=>s).pipe(ne("value")).subscribe(({value:i})=>t.next({type:2,data:i})),r.pipe(ne("focus")).subscribe(({focus:i})=>{i&&at("search",i)}),h(e.form,"reset").pipe(W(o)).subscribe(()=>e.focus());let n=j("header [for=__search]");return h(n,"click").subscribe(()=>e.focus()),ws(e,{worker$:t}).pipe(O(i=>r.next(i)),A(()=>r.complete()),m(i=>P({ref:e},i)),Z(1))}function Oi(e,{worker$:t,query$:r}){let o=new T,n=un(e.parentElement).pipe(g(Boolean)),i=e.parentElement,s=j(":scope > :first-child",e),a=j(":scope > :last-child",e);Je("search").subscribe(l=>{a.setAttribute("role",l?"list":"presentation"),a.hidden=!l}),o.pipe(te(r),Gr(t.pipe(Re(zt)))).subscribe(([{items:l},{value:f}])=>{switch(l.length){case 0:s.textContent=f.length?Me("search.result.none"):Me("search.result.placeholder");break;case 1:s.textContent=Me("search.result.one");break;default:let u=br(l.length);s.textContent=Me("search.result.other",u)}});let c=o.pipe(O(()=>a.innerHTML=""),b(({items:l})=>L($(...l.slice(0,10)),$(...l.slice(10)).pipe(ot(4),Xr(n),b(([f])=>f)))),m(Fn),le());return c.subscribe(l=>a.appendChild(l)),c.pipe(J(l=>{let f=ue("details",l);return typeof f=="undefined"?y:h(f,"toggle").pipe(W(o),m(()=>f))})).subscribe(l=>{l.open===!1&&l.offsetTop<=i.scrollTop&&i.scrollTo({top:l.offsetTop})}),t.pipe(g(Sr),m(({data:l})=>l)).pipe(O(l=>o.next(l)),A(()=>o.complete()),m(l=>P({ref:e},l)))}function Ts(e,{query$:t}){return t.pipe(m(({value:r})=>{let o=we();return o.hash="",r=r.replace(/\s+/g,"+").replace(/&/g,"%26").replace(/=/g,"%3D"),o.search=`q=${r}`,{url:o}}))}function Li(e,t){let r=new T,o=r.pipe(oe(),ae(!0));return r.subscribe(({url:n})=>{e.setAttribute("data-clipboard-text",e.href),e.href=`${n}`}),h(e,"click").pipe(W(o)).subscribe(n=>n.preventDefault()),Ts(e,t).pipe(O(n=>r.next(n)),A(()=>r.complete()),m(n=>P({ref:e},n)))}function Mi(e,{worker$:t,keyboard$:r}){let o=new T,n=Ce("search-query"),i=L(h(n,"keydown"),h(n,"focus")).pipe(xe(pe),m(()=>n.value),Y());return o.pipe(Pe(i),m(([{suggest:a},c])=>{let p=c.split(/([\s-]+)/);if(a!=null&&a.length&&p[p.length-1]){let l=a[a.length-1];l.startsWith(p[p.length-1])&&(p[p.length-1]=l)}else p.length=0;return p})).subscribe(a=>e.innerHTML=a.join("").replace(/\s/g," ")),r.pipe(g(({mode:a})=>a==="search")).subscribe(a=>{a.type==="ArrowRight"&&e.innerText.length&&n.selectionStart===n.value.length&&(n.value=e.innerText)}),t.pipe(g(Sr),m(({data:a})=>a)).pipe(O(a=>o.next(a)),A(()=>o.complete()),m(()=>({ref:e})))}function _i(e,{index$:t,keyboard$:r}){let o=Te();try{let n=Ei(o.search,t),i=Ce("search-query",e),s=Ce("search-result",e);h(e,"click").pipe(g(({target:c})=>c instanceof Element&&!!c.closest("a"))).subscribe(()=>at("search",!1)),r.pipe(g(({mode:c})=>c==="search")).subscribe(c=>{let p=Ne();switch(c.type){case"Enter":if(p===i){let l=new Map;for(let f of M(":first-child [href]",s)){let u=f.firstElementChild;l.set(f,parseFloat(u.getAttribute("data-md-score")))}if(l.size){let[[f]]=[...l].sort(([,u],[,d])=>d-u);f.click()}c.claim()}break;case"Escape":case"Tab":at("search",!1),i.blur();break;case"ArrowUp":case"ArrowDown":if(typeof p=="undefined")i.focus();else{let l=[i,...M(":not(details) > [href], summary, details[open] [href]",s)],f=Math.max(0,(Math.max(0,l.indexOf(p))+l.length+(c.type==="ArrowUp"?-1:1))%l.length);l[f].focus()}c.claim();break;default:i!==Ne()&&i.focus()}}),r.pipe(g(({mode:c})=>c==="global")).subscribe(c=>{switch(c.type){case"f":case"s":case"/":i.focus(),i.select(),c.claim();break}});let a=Si(i,{worker$:n});return L(a,Oi(s,{worker$:n,query$:a})).pipe(Ve(...me("search-share",e).map(c=>Li(c,{query$:a})),...me("search-suggest",e).map(c=>Mi(c,{worker$:n,keyboard$:r}))))}catch(n){return e.hidden=!0,tt}}function Ai(e,{index$:t,location$:r}){return z([t,r.pipe(Q(we()),g(o=>!!o.searchParams.get("h")))]).pipe(m(([o,n])=>xi(o.config)(n.searchParams.get("h"))),m(o=>{var s;let n=new Map,i=document.createNodeIterator(e,NodeFilter.SHOW_TEXT);for(let a=i.nextNode();a;a=i.nextNode())if((s=a.parentElement)!=null&&s.offsetHeight){let c=a.textContent,p=o(c);p.length>c.length&&n.set(a,p)}for(let[a,c]of n){let{childNodes:p}=x("span",null,c);a.replaceWith(...Array.from(p))}return{ref:e,nodes:n}}))}function Ss(e,{viewport$:t,main$:r}){let o=e.closest(".md-grid"),n=o.offsetTop-o.parentElement.offsetTop;return z([r,t]).pipe(m(([{offset:i,height:s},{offset:{y:a}}])=>(s=s+Math.min(n,Math.max(0,a-i))-n,{height:s,locked:a>=i+n})),Y((i,s)=>i.height===s.height&&i.locked===s.locked))}function lo(e,o){var n=o,{header$:t}=n,r=vo(n,["header$"]);let i=j(".md-sidebar__scrollwrap",e),{y:s}=Be(i);return H(()=>{let a=new T,c=a.pipe(oe(),ae(!0)),p=a.pipe($e(0,ye));return p.pipe(te(t)).subscribe({next([{height:l},{height:f}]){i.style.height=`${l-2*s}px`,e.style.top=`${f}px`},complete(){i.style.height="",e.style.top=""}}),p.pipe(Re()).subscribe(()=>{for(let l of M(".md-nav__link--active[href]",e)){if(!l.clientHeight)continue;let f=l.closest(".md-sidebar__scrollwrap");if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:d}=de(f);f.scrollTo({top:u-d/2})}}}),fe(M("label[tabindex]",e)).pipe(J(l=>h(l,"click").pipe(xe(pe),m(()=>l),W(c)))).subscribe(l=>{let f=j(`[id="${l.htmlFor}"]`);j(`[aria-labelledby="${l.id}"]`).setAttribute("aria-expanded",`${f.checked}`)}),V("content.tooltips")&&fe(M("abbr[title]",e)).pipe(J(l=>Xe(l,{viewport$})),W(c)).subscribe(),Ss(e,r).pipe(O(l=>a.next(l)),A(()=>a.complete()),m(l=>P({ref:e},l)))})}function Ci(e,t){if(typeof t!="undefined"){let r=`https://api.github.com/repos/${e}/${t}`;return rt(ze(`${r}/releases/latest`).pipe(ve(()=>y),m(o=>({version:o.tag_name})),Qe({})),ze(r).pipe(ve(()=>y),m(o=>({stars:o.stargazers_count,forks:o.forks_count})),Qe({}))).pipe(m(([o,n])=>P(P({},o),n)))}else{let r=`https://api.github.com/users/${e}`;return ze(r).pipe(m(o=>({repositories:o.public_repos})),Qe({}))}}function ki(e,t){let r=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return rt(ze(`${r}/releases/permalink/latest`).pipe(ve(()=>y),m(({tag_name:o})=>({version:o})),Qe({})),ze(r).pipe(ve(()=>y),m(({star_count:o,forks_count:n})=>({stars:o,forks:n})),Qe({}))).pipe(m(([o,n])=>P(P({},o),n)))}function Hi(e){let t=e.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i);if(t){let[,r,o]=t;return Ci(r,o)}if(t=e.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i),t){let[,r,o]=t;return ki(r,o)}return y}var Os;function Ls(e){return Os||(Os=H(()=>{let t=__md_get("__source",sessionStorage);if(t)return $(t);if(me("consent").length){let o=__md_get("__consent");if(!(o&&o.github))return y}return Hi(e.href).pipe(O(o=>__md_set("__source",o,sessionStorage)))}).pipe(ve(()=>y),g(t=>Object.keys(t).length>0),m(t=>({facts:t})),Z(1)))}function $i(e){let t=j(":scope > :last-child",e);return H(()=>{let r=new T;return r.subscribe(({facts:o})=>{t.appendChild(jn(o)),t.classList.add("md-source__repository--active")}),Ls(e).pipe(O(o=>r.next(o)),A(()=>r.complete()),m(o=>P({ref:e},o)))})}function Ms(e,{viewport$:t,header$:r}){return Le(document.body).pipe(b(()=>Er(e,{header$:r,viewport$:t})),m(({offset:{y:o}})=>({hidden:o>=10})),ne("hidden"))}function Pi(e,t){return H(()=>{let r=new T;return r.subscribe({next({hidden:o}){e.hidden=o},complete(){e.hidden=!1}}),(V("navigation.tabs.sticky")?$({hidden:!1}):Ms(e,t)).pipe(O(o=>r.next(o)),A(()=>r.complete()),m(o=>P({ref:e},o)))})}function _s(e,{viewport$:t,header$:r}){let o=new Map,n=M(".md-nav__link",e);for(let a of n){let c=decodeURIComponent(a.hash.substring(1)),p=ue(`[id="${c}"]`);typeof p!="undefined"&&o.set(a,p)}let i=r.pipe(ne("height"),m(({height:a})=>{let c=Ce("main"),p=j(":scope > :first-child",c);return a+.8*(p.offsetTop-c.offsetTop)}),le());return Le(document.body).pipe(ne("height"),b(a=>H(()=>{let c=[];return $([...o].reduce((p,[l,f])=>{for(;c.length&&o.get(c[c.length-1]).tagName>=f.tagName;)c.pop();let u=f.offsetTop;for(;!u&&f.parentElement;)f=f.parentElement,u=f.offsetTop;let d=f.offsetParent;for(;d;d=d.offsetParent)u+=d.offsetTop;return p.set([...c=[...c,l]].reverse(),u)},new Map))}).pipe(m(c=>new Map([...c].sort(([,p],[,l])=>p-l))),Pe(i),b(([c,p])=>t.pipe(Ut(([l,f],{offset:{y:u},size:d})=>{let v=u+d.height>=Math.floor(a.height);for(;f.length;){let[,S]=f[0];if(S-p=u&&!v)f=[l.pop(),...f];else break}return[l,f]},[[],[...c]]),Y((l,f)=>l[0]===f[0]&&l[1]===f[1])))))).pipe(m(([a,c])=>({prev:a.map(([p])=>p),next:c.map(([p])=>p)})),Q({prev:[],next:[]}),ot(2,1),m(([a,c])=>a.prev.length{let i=new T,s=i.pipe(oe(),ae(!0));if(i.subscribe(({prev:a,next:c})=>{for(let[p]of c)p.classList.remove("md-nav__link--passed"),p.classList.remove("md-nav__link--active");for(let[p,[l]]of a.entries())l.classList.add("md-nav__link--passed"),l.classList.toggle("md-nav__link--active",p===a.length-1)}),V("toc.follow")){let a=L(t.pipe(Ae(1),m(()=>{})),t.pipe(Ae(250),m(()=>"smooth")));i.pipe(g(({prev:c})=>c.length>0),Pe(o.pipe(xe(pe))),te(a)).subscribe(([[{prev:c}],p])=>{let[l]=c[c.length-1];if(l.offsetHeight){let f=vr(l);if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:d}=de(f);f.scrollTo({top:u-d/2,behavior:p})}}})}return V("navigation.tracking")&&t.pipe(W(s),ne("offset"),Ae(250),Ie(1),W(n.pipe(Ie(1))),vt({delay:250}),te(i)).subscribe(([,{prev:a}])=>{let c=we(),p=a[a.length-1];if(p&&p.length){let[l]=p,{hash:f}=new URL(l.href);c.hash!==f&&(c.hash=f,history.replaceState({},"",`${c}`))}else c.hash="",history.replaceState({},"",`${c}`)}),_s(e,{viewport$:t,header$:r}).pipe(O(a=>i.next(a)),A(()=>i.complete()),m(a=>P({ref:e},a)))})}function As(e,{viewport$:t,main$:r,target$:o}){let n=t.pipe(m(({offset:{y:s}})=>s),ot(2,1),m(([s,a])=>s>a&&a>0),Y()),i=r.pipe(m(({active:s})=>s));return z([i,n]).pipe(m(([s,a])=>!(s&&a)),Y(),W(o.pipe(Ie(1))),ae(!0),vt({delay:250}),m(s=>({hidden:s})))}function Ii(e,{viewport$:t,header$:r,main$:o,target$:n}){let i=new T,s=i.pipe(oe(),ae(!0));return i.subscribe({next({hidden:a}){e.hidden=a,a?(e.setAttribute("tabindex","-1"),e.blur()):e.removeAttribute("tabindex")},complete(){e.style.top="",e.hidden=!0,e.removeAttribute("tabindex")}}),r.pipe(W(s),ne("height")).subscribe(({height:a})=>{e.style.top=`${a+16}px`}),h(e,"click").subscribe(a=>{a.preventDefault(),window.scrollTo({top:0})}),As(e,{viewport$:t,main$:o,target$:n}).pipe(O(a=>i.next(a)),A(()=>i.complete()),m(a=>P({ref:e},a)))}function Fi({document$:e,viewport$:t}){e.pipe(b(()=>M(".md-ellipsis")),J(r=>mt(r).pipe(W(e.pipe(Ie(1))),g(o=>o),m(()=>r),Ee(1))),g(r=>r.offsetWidth{let o=r.innerText,n=r.closest("a")||r;return n.title=o,V("content.tooltips")?Xe(n,{viewport$:t}).pipe(W(e.pipe(Ie(1))),A(()=>n.removeAttribute("title"))):y})).subscribe(),V("content.tooltips")&&e.pipe(b(()=>M(".md-status")),J(r=>Xe(r,{viewport$:t}))).subscribe()}function ji({document$:e,tablet$:t}){e.pipe(b(()=>M(".md-toggle--indeterminate")),O(r=>{r.indeterminate=!0,r.checked=!1}),J(r=>h(r,"change").pipe(Jr(()=>r.classList.contains("md-toggle--indeterminate")),m(()=>r))),te(t)).subscribe(([r,o])=>{r.classList.remove("md-toggle--indeterminate"),o&&(r.checked=!1)})}function Cs(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}function Ui({document$:e}){e.pipe(b(()=>M("[data-md-scrollfix]")),O(t=>t.removeAttribute("data-md-scrollfix")),g(Cs),J(t=>h(t,"touchstart").pipe(m(()=>t)))).subscribe(t=>{let r=t.scrollTop;r===0?t.scrollTop=1:r+t.offsetHeight===t.scrollHeight&&(t.scrollTop=r-1)})}function Wi({viewport$:e,tablet$:t}){z([Je("search"),t]).pipe(m(([r,o])=>r&&!o),b(r=>$(r).pipe(nt(r?400:100))),te(e)).subscribe(([r,{offset:{y:o}}])=>{if(r)document.body.setAttribute("data-md-scrolllock",""),document.body.style.top=`-${o}px`;else{let n=-1*parseInt(document.body.style.top,10);document.body.removeAttribute("data-md-scrolllock"),document.body.style.top="",n&&window.scrollTo(0,n)}})}Object.entries||(Object.entries=function(e){let t=[];for(let r of Object.keys(e))t.push([r,e[r]]);return t});Object.values||(Object.values=function(e){let t=[];for(let r of Object.keys(e))t.push(e[r]);return t});typeof Element!="undefined"&&(Element.prototype.scrollTo||(Element.prototype.scrollTo=function(e,t){typeof e=="object"?(this.scrollLeft=e.left,this.scrollTop=e.top):(this.scrollLeft=e,this.scrollTop=t)}),Element.prototype.replaceWith||(Element.prototype.replaceWith=function(...e){let t=this.parentNode;if(t){e.length===0&&t.removeChild(this);for(let r=e.length-1;r>=0;r--){let o=e[r];typeof o=="string"?o=document.createTextNode(o):o.parentNode&&o.parentNode.removeChild(o),r?t.insertBefore(this.previousSibling,o):t.replaceChild(o,this)}}}));function ks(){return location.protocol==="file:"?_t(`${new URL("search/search_index.js",Or.base)}`).pipe(m(()=>__index),Z(1)):ze(new URL("search/search_index.json",Or.base))}document.documentElement.classList.remove("no-js");document.documentElement.classList.add("js");var ct=an(),Kt=bn(),Ht=yn(Kt),mo=hn(),ke=Ln(),Lr=Wt("(min-width: 60em)"),Vi=Wt("(min-width: 76.25em)"),Ni=xn(),Or=Te(),zi=document.forms.namedItem("search")?ks():tt,fo=new T;di({alert$:fo});ui({document$:ct});var uo=new T,qi=kt(Or.base);V("navigation.instant")&&gi({sitemap$:qi,location$:Kt,viewport$:ke,progress$:uo}).subscribe(ct);var Di;((Di=Or.version)==null?void 0:Di.provider)==="mike"&&Ti({document$:ct});L(Kt,Ht).pipe(nt(125)).subscribe(()=>{at("drawer",!1),at("search",!1)});mo.pipe(g(({mode:e})=>e==="global")).subscribe(e=>{switch(e.type){case"p":case",":let t=ue("link[rel=prev]");typeof t!="undefined"&&st(t);break;case"n":case".":let r=ue("link[rel=next]");typeof r!="undefined"&&st(r);break;case"Enter":let o=Ne();o instanceof HTMLLabelElement&&o.click()}});Fi({viewport$:ke,document$:ct});ji({document$:ct,tablet$:Lr});Ui({document$:ct});Wi({viewport$:ke,tablet$:Lr});var ft=ai(Ce("header"),{viewport$:ke}),qt=ct.pipe(m(()=>Ce("main")),b(e=>pi(e,{viewport$:ke,header$:ft})),Z(1)),Hs=L(...me("consent").map(e=>An(e,{target$:Ht})),...me("dialog").map(e=>ni(e,{alert$:fo})),...me("palette").map(e=>li(e)),...me("progress").map(e=>mi(e,{progress$:uo})),...me("search").map(e=>_i(e,{index$:zi,keyboard$:mo})),...me("source").map(e=>$i(e))),$s=H(()=>L(...me("announce").map(e=>_n(e)),...me("content").map(e=>oi(e,{sitemap$:qi,viewport$:ke,target$:Ht,print$:Ni})),...me("content").map(e=>V("search.highlight")?Ai(e,{index$:zi,location$:Kt}):y),...me("header").map(e=>si(e,{viewport$:ke,header$:ft,main$:qt})),...me("header-title").map(e=>ci(e,{viewport$:ke,header$:ft})),...me("sidebar").map(e=>e.getAttribute("data-md-type")==="navigation"?eo(Vi,()=>lo(e,{viewport$:ke,header$:ft,main$:qt})):eo(Lr,()=>lo(e,{viewport$:ke,header$:ft,main$:qt}))),...me("tabs").map(e=>Pi(e,{viewport$:ke,header$:ft})),...me("toc").map(e=>Ri(e,{viewport$:ke,header$:ft,main$:qt,target$:Ht})),...me("top").map(e=>Ii(e,{viewport$:ke,header$:ft,main$:qt,target$:Ht})))),Ki=ct.pipe(b(()=>$s),Ve(Hs),Z(1));Ki.subscribe();window.document$=ct;window.location$=Kt;window.target$=Ht;window.keyboard$=mo;window.viewport$=ke;window.tablet$=Lr;window.screen$=Vi;window.print$=Ni;window.alert$=fo;window.progress$=uo;window.component$=Ki;})(); +//# sourceMappingURL=bundle.79ae519e.min.js.map + diff --git a/assets/javascripts/bundle.79ae519e.min.js.map b/assets/javascripts/bundle.79ae519e.min.js.map new file mode 100644 index 00000000..5cf02892 --- /dev/null +++ b/assets/javascripts/bundle.79ae519e.min.js.map @@ -0,0 +1,7 @@ +{ + "version": 3, + "sources": ["node_modules/focus-visible/dist/focus-visible.js", "node_modules/escape-html/index.js", "node_modules/clipboard/dist/clipboard.js", "src/templates/assets/javascripts/bundle.ts", "node_modules/tslib/tslib.es6.mjs", "node_modules/rxjs/src/internal/util/isFunction.ts", "node_modules/rxjs/src/internal/util/createErrorClass.ts", "node_modules/rxjs/src/internal/util/UnsubscriptionError.ts", "node_modules/rxjs/src/internal/util/arrRemove.ts", "node_modules/rxjs/src/internal/Subscription.ts", "node_modules/rxjs/src/internal/config.ts", "node_modules/rxjs/src/internal/scheduler/timeoutProvider.ts", "node_modules/rxjs/src/internal/util/reportUnhandledError.ts", "node_modules/rxjs/src/internal/util/noop.ts", "node_modules/rxjs/src/internal/NotificationFactories.ts", "node_modules/rxjs/src/internal/util/errorContext.ts", "node_modules/rxjs/src/internal/Subscriber.ts", "node_modules/rxjs/src/internal/symbol/observable.ts", "node_modules/rxjs/src/internal/util/identity.ts", "node_modules/rxjs/src/internal/util/pipe.ts", "node_modules/rxjs/src/internal/Observable.ts", "node_modules/rxjs/src/internal/util/lift.ts", "node_modules/rxjs/src/internal/operators/OperatorSubscriber.ts", "node_modules/rxjs/src/internal/scheduler/animationFrameProvider.ts", "node_modules/rxjs/src/internal/util/ObjectUnsubscribedError.ts", "node_modules/rxjs/src/internal/Subject.ts", "node_modules/rxjs/src/internal/BehaviorSubject.ts", "node_modules/rxjs/src/internal/scheduler/dateTimestampProvider.ts", "node_modules/rxjs/src/internal/ReplaySubject.ts", "node_modules/rxjs/src/internal/scheduler/Action.ts", "node_modules/rxjs/src/internal/scheduler/intervalProvider.ts", "node_modules/rxjs/src/internal/scheduler/AsyncAction.ts", "node_modules/rxjs/src/internal/Scheduler.ts", "node_modules/rxjs/src/internal/scheduler/AsyncScheduler.ts", "node_modules/rxjs/src/internal/scheduler/async.ts", "node_modules/rxjs/src/internal/scheduler/QueueAction.ts", "node_modules/rxjs/src/internal/scheduler/QueueScheduler.ts", "node_modules/rxjs/src/internal/scheduler/queue.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameAction.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameScheduler.ts", "node_modules/rxjs/src/internal/scheduler/animationFrame.ts", "node_modules/rxjs/src/internal/observable/empty.ts", "node_modules/rxjs/src/internal/util/isScheduler.ts", "node_modules/rxjs/src/internal/util/args.ts", "node_modules/rxjs/src/internal/util/isArrayLike.ts", "node_modules/rxjs/src/internal/util/isPromise.ts", "node_modules/rxjs/src/internal/util/isInteropObservable.ts", "node_modules/rxjs/src/internal/util/isAsyncIterable.ts", "node_modules/rxjs/src/internal/util/throwUnobservableError.ts", "node_modules/rxjs/src/internal/symbol/iterator.ts", "node_modules/rxjs/src/internal/util/isIterable.ts", "node_modules/rxjs/src/internal/util/isReadableStreamLike.ts", "node_modules/rxjs/src/internal/observable/innerFrom.ts", "node_modules/rxjs/src/internal/util/executeSchedule.ts", "node_modules/rxjs/src/internal/operators/observeOn.ts", "node_modules/rxjs/src/internal/operators/subscribeOn.ts", "node_modules/rxjs/src/internal/scheduled/scheduleObservable.ts", "node_modules/rxjs/src/internal/scheduled/schedulePromise.ts", "node_modules/rxjs/src/internal/scheduled/scheduleArray.ts", "node_modules/rxjs/src/internal/scheduled/scheduleIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleAsyncIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleReadableStreamLike.ts", "node_modules/rxjs/src/internal/scheduled/scheduled.ts", "node_modules/rxjs/src/internal/observable/from.ts", "node_modules/rxjs/src/internal/observable/of.ts", "node_modules/rxjs/src/internal/observable/throwError.ts", "node_modules/rxjs/src/internal/util/EmptyError.ts", "node_modules/rxjs/src/internal/util/isDate.ts", "node_modules/rxjs/src/internal/operators/map.ts", "node_modules/rxjs/src/internal/util/mapOneOrManyArgs.ts", "node_modules/rxjs/src/internal/util/argsArgArrayOrObject.ts", "node_modules/rxjs/src/internal/util/createObject.ts", "node_modules/rxjs/src/internal/observable/combineLatest.ts", "node_modules/rxjs/src/internal/operators/mergeInternals.ts", "node_modules/rxjs/src/internal/operators/mergeMap.ts", "node_modules/rxjs/src/internal/operators/mergeAll.ts", "node_modules/rxjs/src/internal/operators/concatAll.ts", "node_modules/rxjs/src/internal/observable/concat.ts", "node_modules/rxjs/src/internal/observable/defer.ts", "node_modules/rxjs/src/internal/observable/fromEvent.ts", "node_modules/rxjs/src/internal/observable/fromEventPattern.ts", "node_modules/rxjs/src/internal/observable/timer.ts", "node_modules/rxjs/src/internal/observable/merge.ts", "node_modules/rxjs/src/internal/observable/never.ts", "node_modules/rxjs/src/internal/util/argsOrArgArray.ts", "node_modules/rxjs/src/internal/operators/filter.ts", "node_modules/rxjs/src/internal/observable/zip.ts", "node_modules/rxjs/src/internal/operators/audit.ts", "node_modules/rxjs/src/internal/operators/auditTime.ts", "node_modules/rxjs/src/internal/operators/bufferCount.ts", "node_modules/rxjs/src/internal/operators/catchError.ts", "node_modules/rxjs/src/internal/operators/scanInternals.ts", "node_modules/rxjs/src/internal/operators/combineLatest.ts", "node_modules/rxjs/src/internal/operators/combineLatestWith.ts", "node_modules/rxjs/src/internal/operators/debounce.ts", "node_modules/rxjs/src/internal/operators/debounceTime.ts", "node_modules/rxjs/src/internal/operators/defaultIfEmpty.ts", "node_modules/rxjs/src/internal/operators/take.ts", "node_modules/rxjs/src/internal/operators/ignoreElements.ts", "node_modules/rxjs/src/internal/operators/mapTo.ts", "node_modules/rxjs/src/internal/operators/delayWhen.ts", "node_modules/rxjs/src/internal/operators/delay.ts", "node_modules/rxjs/src/internal/operators/distinct.ts", "node_modules/rxjs/src/internal/operators/distinctUntilChanged.ts", "node_modules/rxjs/src/internal/operators/distinctUntilKeyChanged.ts", "node_modules/rxjs/src/internal/operators/throwIfEmpty.ts", "node_modules/rxjs/src/internal/operators/endWith.ts", "node_modules/rxjs/src/internal/operators/exhaustMap.ts", "node_modules/rxjs/src/internal/operators/finalize.ts", "node_modules/rxjs/src/internal/operators/first.ts", "node_modules/rxjs/src/internal/operators/takeLast.ts", "node_modules/rxjs/src/internal/operators/merge.ts", "node_modules/rxjs/src/internal/operators/mergeWith.ts", "node_modules/rxjs/src/internal/operators/repeat.ts", "node_modules/rxjs/src/internal/operators/scan.ts", "node_modules/rxjs/src/internal/operators/share.ts", "node_modules/rxjs/src/internal/operators/shareReplay.ts", "node_modules/rxjs/src/internal/operators/skip.ts", "node_modules/rxjs/src/internal/operators/skipUntil.ts", "node_modules/rxjs/src/internal/operators/startWith.ts", "node_modules/rxjs/src/internal/operators/switchMap.ts", "node_modules/rxjs/src/internal/operators/takeUntil.ts", "node_modules/rxjs/src/internal/operators/takeWhile.ts", "node_modules/rxjs/src/internal/operators/tap.ts", "node_modules/rxjs/src/internal/operators/throttle.ts", "node_modules/rxjs/src/internal/operators/throttleTime.ts", "node_modules/rxjs/src/internal/operators/withLatestFrom.ts", "node_modules/rxjs/src/internal/operators/zip.ts", "node_modules/rxjs/src/internal/operators/zipWith.ts", "src/templates/assets/javascripts/browser/document/index.ts", "src/templates/assets/javascripts/browser/element/_/index.ts", "src/templates/assets/javascripts/browser/element/focus/index.ts", "src/templates/assets/javascripts/browser/element/hover/index.ts", "src/templates/assets/javascripts/utilities/h/index.ts", "src/templates/assets/javascripts/utilities/round/index.ts", "src/templates/assets/javascripts/browser/script/index.ts", "src/templates/assets/javascripts/browser/element/size/_/index.ts", "src/templates/assets/javascripts/browser/element/size/content/index.ts", "src/templates/assets/javascripts/browser/element/offset/_/index.ts", "src/templates/assets/javascripts/browser/element/offset/content/index.ts", "src/templates/assets/javascripts/browser/element/visibility/index.ts", "src/templates/assets/javascripts/browser/toggle/index.ts", "src/templates/assets/javascripts/browser/keyboard/index.ts", "src/templates/assets/javascripts/browser/location/_/index.ts", "src/templates/assets/javascripts/browser/location/hash/index.ts", "src/templates/assets/javascripts/browser/media/index.ts", "src/templates/assets/javascripts/browser/request/index.ts", "src/templates/assets/javascripts/browser/viewport/offset/index.ts", "src/templates/assets/javascripts/browser/viewport/size/index.ts", "src/templates/assets/javascripts/browser/viewport/_/index.ts", "src/templates/assets/javascripts/browser/viewport/at/index.ts", "src/templates/assets/javascripts/browser/worker/index.ts", "src/templates/assets/javascripts/_/index.ts", "src/templates/assets/javascripts/components/_/index.ts", "src/templates/assets/javascripts/components/announce/index.ts", "src/templates/assets/javascripts/components/consent/index.ts", "src/templates/assets/javascripts/templates/tooltip/index.tsx", "src/templates/assets/javascripts/templates/annotation/index.tsx", "src/templates/assets/javascripts/templates/clipboard/index.tsx", "src/templates/assets/javascripts/templates/search/index.tsx", "src/templates/assets/javascripts/templates/source/index.tsx", "src/templates/assets/javascripts/templates/tabbed/index.tsx", "src/templates/assets/javascripts/templates/table/index.tsx", "src/templates/assets/javascripts/templates/version/index.tsx", "src/templates/assets/javascripts/components/tooltip2/index.ts", "src/templates/assets/javascripts/components/content/annotation/_/index.ts", "src/templates/assets/javascripts/components/content/annotation/list/index.ts", "src/templates/assets/javascripts/components/content/annotation/block/index.ts", "src/templates/assets/javascripts/components/content/code/_/index.ts", "src/templates/assets/javascripts/components/content/details/index.ts", "src/templates/assets/javascripts/components/content/link/index.ts", "src/templates/assets/javascripts/components/content/mermaid/index.css", "src/templates/assets/javascripts/components/content/mermaid/index.ts", "src/templates/assets/javascripts/components/content/table/index.ts", "src/templates/assets/javascripts/components/content/tabs/index.ts", "src/templates/assets/javascripts/components/content/_/index.ts", "src/templates/assets/javascripts/components/dialog/index.ts", "src/templates/assets/javascripts/components/tooltip/index.ts", "src/templates/assets/javascripts/components/header/_/index.ts", "src/templates/assets/javascripts/components/header/title/index.ts", "src/templates/assets/javascripts/components/main/index.ts", "src/templates/assets/javascripts/components/palette/index.ts", "src/templates/assets/javascripts/components/progress/index.ts", "src/templates/assets/javascripts/integrations/sitemap/index.ts", "src/templates/assets/javascripts/integrations/alternate/index.ts", "src/templates/assets/javascripts/integrations/clipboard/index.ts", "src/templates/assets/javascripts/integrations/instant/index.ts", "src/templates/assets/javascripts/integrations/search/highlighter/index.ts", "src/templates/assets/javascripts/integrations/search/worker/message/index.ts", "src/templates/assets/javascripts/integrations/search/worker/_/index.ts", "src/templates/assets/javascripts/integrations/version/findurl/index.ts", "src/templates/assets/javascripts/integrations/version/index.ts", "src/templates/assets/javascripts/components/search/query/index.ts", "src/templates/assets/javascripts/components/search/result/index.ts", "src/templates/assets/javascripts/components/search/share/index.ts", "src/templates/assets/javascripts/components/search/suggest/index.ts", "src/templates/assets/javascripts/components/search/_/index.ts", "src/templates/assets/javascripts/components/search/highlight/index.ts", "src/templates/assets/javascripts/components/sidebar/index.ts", "src/templates/assets/javascripts/components/source/facts/github/index.ts", "src/templates/assets/javascripts/components/source/facts/gitlab/index.ts", "src/templates/assets/javascripts/components/source/facts/_/index.ts", "src/templates/assets/javascripts/components/source/_/index.ts", "src/templates/assets/javascripts/components/tabs/index.ts", "src/templates/assets/javascripts/components/toc/index.ts", "src/templates/assets/javascripts/components/top/index.ts", "src/templates/assets/javascripts/patches/ellipsis/index.ts", "src/templates/assets/javascripts/patches/indeterminate/index.ts", "src/templates/assets/javascripts/patches/scrollfix/index.ts", "src/templates/assets/javascripts/patches/scrolllock/index.ts", "src/templates/assets/javascripts/polyfills/index.ts"], + "sourcesContent": ["(function (global, factory) {\n typeof exports === 'object' && typeof module !== 'undefined' ? factory() :\n typeof define === 'function' && define.amd ? define(factory) :\n (factory());\n}(this, (function () { 'use strict';\n\n /**\n * Applies the :focus-visible polyfill at the given scope.\n * A scope in this case is either the top-level Document or a Shadow Root.\n *\n * @param {(Document|ShadowRoot)} scope\n * @see https://github.com/WICG/focus-visible\n */\n function applyFocusVisiblePolyfill(scope) {\n var hadKeyboardEvent = true;\n var hadFocusVisibleRecently = false;\n var hadFocusVisibleRecentlyTimeout = null;\n\n var inputTypesAllowlist = {\n text: true,\n search: true,\n url: true,\n tel: true,\n email: true,\n password: true,\n number: true,\n date: true,\n month: true,\n week: true,\n time: true,\n datetime: true,\n 'datetime-local': true\n };\n\n /**\n * Helper function for legacy browsers and iframes which sometimes focus\n * elements like document, body, and non-interactive SVG.\n * @param {Element} el\n */\n function isValidFocusTarget(el) {\n if (\n el &&\n el !== document &&\n el.nodeName !== 'HTML' &&\n el.nodeName !== 'BODY' &&\n 'classList' in el &&\n 'contains' in el.classList\n ) {\n return true;\n }\n return false;\n }\n\n /**\n * Computes whether the given element should automatically trigger the\n * `focus-visible` class being added, i.e. whether it should always match\n * `:focus-visible` when focused.\n * @param {Element} el\n * @return {boolean}\n */\n function focusTriggersKeyboardModality(el) {\n var type = el.type;\n var tagName = el.tagName;\n\n if (tagName === 'INPUT' && inputTypesAllowlist[type] && !el.readOnly) {\n return true;\n }\n\n if (tagName === 'TEXTAREA' && !el.readOnly) {\n return true;\n }\n\n if (el.isContentEditable) {\n return true;\n }\n\n return false;\n }\n\n /**\n * Add the `focus-visible` class to the given element if it was not added by\n * the author.\n * @param {Element} el\n */\n function addFocusVisibleClass(el) {\n if (el.classList.contains('focus-visible')) {\n return;\n }\n el.classList.add('focus-visible');\n el.setAttribute('data-focus-visible-added', '');\n }\n\n /**\n * Remove the `focus-visible` class from the given element if it was not\n * originally added by the author.\n * @param {Element} el\n */\n function removeFocusVisibleClass(el) {\n if (!el.hasAttribute('data-focus-visible-added')) {\n return;\n }\n el.classList.remove('focus-visible');\n el.removeAttribute('data-focus-visible-added');\n }\n\n /**\n * If the most recent user interaction was via the keyboard;\n * and the key press did not include a meta, alt/option, or control key;\n * then the modality is keyboard. Otherwise, the modality is not keyboard.\n * Apply `focus-visible` to any current active element and keep track\n * of our keyboard modality state with `hadKeyboardEvent`.\n * @param {KeyboardEvent} e\n */\n function onKeyDown(e) {\n if (e.metaKey || e.altKey || e.ctrlKey) {\n return;\n }\n\n if (isValidFocusTarget(scope.activeElement)) {\n addFocusVisibleClass(scope.activeElement);\n }\n\n hadKeyboardEvent = true;\n }\n\n /**\n * If at any point a user clicks with a pointing device, ensure that we change\n * the modality away from keyboard.\n * This avoids the situation where a user presses a key on an already focused\n * element, and then clicks on a different element, focusing it with a\n * pointing device, while we still think we're in keyboard modality.\n * @param {Event} e\n */\n function onPointerDown(e) {\n hadKeyboardEvent = false;\n }\n\n /**\n * On `focus`, add the `focus-visible` class to the target if:\n * - the target received focus as a result of keyboard navigation, or\n * - the event target is an element that will likely require interaction\n * via the keyboard (e.g. a text box)\n * @param {Event} e\n */\n function onFocus(e) {\n // Prevent IE from focusing the document or HTML element.\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (hadKeyboardEvent || focusTriggersKeyboardModality(e.target)) {\n addFocusVisibleClass(e.target);\n }\n }\n\n /**\n * On `blur`, remove the `focus-visible` class from the target.\n * @param {Event} e\n */\n function onBlur(e) {\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (\n e.target.classList.contains('focus-visible') ||\n e.target.hasAttribute('data-focus-visible-added')\n ) {\n // To detect a tab/window switch, we look for a blur event followed\n // rapidly by a visibility change.\n // If we don't see a visibility change within 100ms, it's probably a\n // regular focus change.\n hadFocusVisibleRecently = true;\n window.clearTimeout(hadFocusVisibleRecentlyTimeout);\n hadFocusVisibleRecentlyTimeout = window.setTimeout(function() {\n hadFocusVisibleRecently = false;\n }, 100);\n removeFocusVisibleClass(e.target);\n }\n }\n\n /**\n * If the user changes tabs, keep track of whether or not the previously\n * focused element had .focus-visible.\n * @param {Event} e\n */\n function onVisibilityChange(e) {\n if (document.visibilityState === 'hidden') {\n // If the tab becomes active again, the browser will handle calling focus\n // on the element (Safari actually calls it twice).\n // If this tab change caused a blur on an element with focus-visible,\n // re-apply the class when the user switches back to the tab.\n if (hadFocusVisibleRecently) {\n hadKeyboardEvent = true;\n }\n addInitialPointerMoveListeners();\n }\n }\n\n /**\n * Add a group of listeners to detect usage of any pointing devices.\n * These listeners will be added when the polyfill first loads, and anytime\n * the window is blurred, so that they are active when the window regains\n * focus.\n */\n function addInitialPointerMoveListeners() {\n document.addEventListener('mousemove', onInitialPointerMove);\n document.addEventListener('mousedown', onInitialPointerMove);\n document.addEventListener('mouseup', onInitialPointerMove);\n document.addEventListener('pointermove', onInitialPointerMove);\n document.addEventListener('pointerdown', onInitialPointerMove);\n document.addEventListener('pointerup', onInitialPointerMove);\n document.addEventListener('touchmove', onInitialPointerMove);\n document.addEventListener('touchstart', onInitialPointerMove);\n document.addEventListener('touchend', onInitialPointerMove);\n }\n\n function removeInitialPointerMoveListeners() {\n document.removeEventListener('mousemove', onInitialPointerMove);\n document.removeEventListener('mousedown', onInitialPointerMove);\n document.removeEventListener('mouseup', onInitialPointerMove);\n document.removeEventListener('pointermove', onInitialPointerMove);\n document.removeEventListener('pointerdown', onInitialPointerMove);\n document.removeEventListener('pointerup', onInitialPointerMove);\n document.removeEventListener('touchmove', onInitialPointerMove);\n document.removeEventListener('touchstart', onInitialPointerMove);\n document.removeEventListener('touchend', onInitialPointerMove);\n }\n\n /**\n * When the polfyill first loads, assume the user is in keyboard modality.\n * If any event is received from a pointing device (e.g. mouse, pointer,\n * touch), turn off keyboard modality.\n * This accounts for situations where focus enters the page from the URL bar.\n * @param {Event} e\n */\n function onInitialPointerMove(e) {\n // Work around a Safari quirk that fires a mousemove on whenever the\n // window blurs, even if you're tabbing out of the page. \u00AF\\_(\u30C4)_/\u00AF\n if (e.target.nodeName && e.target.nodeName.toLowerCase() === 'html') {\n return;\n }\n\n hadKeyboardEvent = false;\n removeInitialPointerMoveListeners();\n }\n\n // For some kinds of state, we are interested in changes at the global scope\n // only. For example, global pointer input, global key presses and global\n // visibility change should affect the state at every scope:\n document.addEventListener('keydown', onKeyDown, true);\n document.addEventListener('mousedown', onPointerDown, true);\n document.addEventListener('pointerdown', onPointerDown, true);\n document.addEventListener('touchstart', onPointerDown, true);\n document.addEventListener('visibilitychange', onVisibilityChange, true);\n\n addInitialPointerMoveListeners();\n\n // For focus and blur, we specifically care about state changes in the local\n // scope. This is because focus / blur events that originate from within a\n // shadow root are not re-dispatched from the host element if it was already\n // the active element in its own scope:\n scope.addEventListener('focus', onFocus, true);\n scope.addEventListener('blur', onBlur, true);\n\n // We detect that a node is a ShadowRoot by ensuring that it is a\n // DocumentFragment and also has a host property. This check covers native\n // implementation and polyfill implementation transparently. If we only cared\n // about the native implementation, we could just check if the scope was\n // an instance of a ShadowRoot.\n if (scope.nodeType === Node.DOCUMENT_FRAGMENT_NODE && scope.host) {\n // Since a ShadowRoot is a special kind of DocumentFragment, it does not\n // have a root element to add a class to. So, we add this attribute to the\n // host element instead:\n scope.host.setAttribute('data-js-focus-visible', '');\n } else if (scope.nodeType === Node.DOCUMENT_NODE) {\n document.documentElement.classList.add('js-focus-visible');\n document.documentElement.setAttribute('data-js-focus-visible', '');\n }\n }\n\n // It is important to wrap all references to global window and document in\n // these checks to support server-side rendering use cases\n // @see https://github.com/WICG/focus-visible/issues/199\n if (typeof window !== 'undefined' && typeof document !== 'undefined') {\n // Make the polyfill helper globally available. This can be used as a signal\n // to interested libraries that wish to coordinate with the polyfill for e.g.,\n // applying the polyfill to a shadow root:\n window.applyFocusVisiblePolyfill = applyFocusVisiblePolyfill;\n\n // Notify interested libraries of the polyfill's presence, in case the\n // polyfill was loaded lazily:\n var event;\n\n try {\n event = new CustomEvent('focus-visible-polyfill-ready');\n } catch (error) {\n // IE11 does not support using CustomEvent as a constructor directly:\n event = document.createEvent('CustomEvent');\n event.initCustomEvent('focus-visible-polyfill-ready', false, false, {});\n }\n\n window.dispatchEvent(event);\n }\n\n if (typeof document !== 'undefined') {\n // Apply the polyfill to the global document, so that no JavaScript\n // coordination is required to use the polyfill in the top-level document:\n applyFocusVisiblePolyfill(document);\n }\n\n})));\n", "/*!\n * escape-html\n * Copyright(c) 2012-2013 TJ Holowaychuk\n * Copyright(c) 2015 Andreas Lubbe\n * Copyright(c) 2015 Tiancheng \"Timothy\" Gu\n * MIT Licensed\n */\n\n'use strict';\n\n/**\n * Module variables.\n * @private\n */\n\nvar matchHtmlRegExp = /[\"'&<>]/;\n\n/**\n * Module exports.\n * @public\n */\n\nmodule.exports = escapeHtml;\n\n/**\n * Escape special characters in the given string of html.\n *\n * @param {string} string The string to escape for inserting into HTML\n * @return {string}\n * @public\n */\n\nfunction escapeHtml(string) {\n var str = '' + string;\n var match = matchHtmlRegExp.exec(str);\n\n if (!match) {\n return str;\n }\n\n var escape;\n var html = '';\n var index = 0;\n var lastIndex = 0;\n\n for (index = match.index; index < str.length; index++) {\n switch (str.charCodeAt(index)) {\n case 34: // \"\n escape = '"';\n break;\n case 38: // &\n escape = '&';\n break;\n case 39: // '\n escape = ''';\n break;\n case 60: // <\n escape = '<';\n break;\n case 62: // >\n escape = '>';\n break;\n default:\n continue;\n }\n\n if (lastIndex !== index) {\n html += str.substring(lastIndex, index);\n }\n\n lastIndex = index + 1;\n html += escape;\n }\n\n return lastIndex !== index\n ? html + str.substring(lastIndex, index)\n : html;\n}\n", "/*!\n * clipboard.js v2.0.11\n * https://clipboardjs.com/\n *\n * Licensed MIT \u00A9 Zeno Rocha\n */\n(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"ClipboardJS\"] = factory();\n\telse\n\t\troot[\"ClipboardJS\"] = factory();\n})(this, function() {\nreturn /******/ (function() { // webpackBootstrap\n/******/ \tvar __webpack_modules__ = ({\n\n/***/ 686:\n/***/ (function(__unused_webpack_module, __webpack_exports__, __webpack_require__) {\n\n\"use strict\";\n\n// EXPORTS\n__webpack_require__.d(__webpack_exports__, {\n \"default\": function() { return /* binding */ clipboard; }\n});\n\n// EXTERNAL MODULE: ./node_modules/tiny-emitter/index.js\nvar tiny_emitter = __webpack_require__(279);\nvar tiny_emitter_default = /*#__PURE__*/__webpack_require__.n(tiny_emitter);\n// EXTERNAL MODULE: ./node_modules/good-listener/src/listen.js\nvar listen = __webpack_require__(370);\nvar listen_default = /*#__PURE__*/__webpack_require__.n(listen);\n// EXTERNAL MODULE: ./node_modules/select/src/select.js\nvar src_select = __webpack_require__(817);\nvar select_default = /*#__PURE__*/__webpack_require__.n(src_select);\n;// CONCATENATED MODULE: ./src/common/command.js\n/**\n * Executes a given operation type.\n * @param {String} type\n * @return {Boolean}\n */\nfunction command(type) {\n try {\n return document.execCommand(type);\n } catch (err) {\n return false;\n }\n}\n;// CONCATENATED MODULE: ./src/actions/cut.js\n\n\n/**\n * Cut action wrapper.\n * @param {String|HTMLElement} target\n * @return {String}\n */\n\nvar ClipboardActionCut = function ClipboardActionCut(target) {\n var selectedText = select_default()(target);\n command('cut');\n return selectedText;\n};\n\n/* harmony default export */ var actions_cut = (ClipboardActionCut);\n;// CONCATENATED MODULE: ./src/common/create-fake-element.js\n/**\n * Creates a fake textarea element with a value.\n * @param {String} value\n * @return {HTMLElement}\n */\nfunction createFakeElement(value) {\n var isRTL = document.documentElement.getAttribute('dir') === 'rtl';\n var fakeElement = document.createElement('textarea'); // Prevent zooming on iOS\n\n fakeElement.style.fontSize = '12pt'; // Reset box model\n\n fakeElement.style.border = '0';\n fakeElement.style.padding = '0';\n fakeElement.style.margin = '0'; // Move element out of screen horizontally\n\n fakeElement.style.position = 'absolute';\n fakeElement.style[isRTL ? 'right' : 'left'] = '-9999px'; // Move element to the same position vertically\n\n var yPosition = window.pageYOffset || document.documentElement.scrollTop;\n fakeElement.style.top = \"\".concat(yPosition, \"px\");\n fakeElement.setAttribute('readonly', '');\n fakeElement.value = value;\n return fakeElement;\n}\n;// CONCATENATED MODULE: ./src/actions/copy.js\n\n\n\n/**\n * Create fake copy action wrapper using a fake element.\n * @param {String} target\n * @param {Object} options\n * @return {String}\n */\n\nvar fakeCopyAction = function fakeCopyAction(value, options) {\n var fakeElement = createFakeElement(value);\n options.container.appendChild(fakeElement);\n var selectedText = select_default()(fakeElement);\n command('copy');\n fakeElement.remove();\n return selectedText;\n};\n/**\n * Copy action wrapper.\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @return {String}\n */\n\n\nvar ClipboardActionCopy = function ClipboardActionCopy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n var selectedText = '';\n\n if (typeof target === 'string') {\n selectedText = fakeCopyAction(target, options);\n } else if (target instanceof HTMLInputElement && !['text', 'search', 'url', 'tel', 'password'].includes(target === null || target === void 0 ? void 0 : target.type)) {\n // If input type doesn't support `setSelectionRange`. Simulate it. https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange\n selectedText = fakeCopyAction(target.value, options);\n } else {\n selectedText = select_default()(target);\n command('copy');\n }\n\n return selectedText;\n};\n\n/* harmony default export */ var actions_copy = (ClipboardActionCopy);\n;// CONCATENATED MODULE: ./src/actions/default.js\nfunction _typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return _typeof(obj); }\n\n\n\n/**\n * Inner function which performs selection from either `text` or `target`\n * properties and then executes copy or cut operations.\n * @param {Object} options\n */\n\nvar ClipboardActionDefault = function ClipboardActionDefault() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n // Defines base properties passed from constructor.\n var _options$action = options.action,\n action = _options$action === void 0 ? 'copy' : _options$action,\n container = options.container,\n target = options.target,\n text = options.text; // Sets the `action` to be performed which can be either 'copy' or 'cut'.\n\n if (action !== 'copy' && action !== 'cut') {\n throw new Error('Invalid \"action\" value, use either \"copy\" or \"cut\"');\n } // Sets the `target` property using an element that will be have its content copied.\n\n\n if (target !== undefined) {\n if (target && _typeof(target) === 'object' && target.nodeType === 1) {\n if (action === 'copy' && target.hasAttribute('disabled')) {\n throw new Error('Invalid \"target\" attribute. Please use \"readonly\" instead of \"disabled\" attribute');\n }\n\n if (action === 'cut' && (target.hasAttribute('readonly') || target.hasAttribute('disabled'))) {\n throw new Error('Invalid \"target\" attribute. You can\\'t cut text from elements with \"readonly\" or \"disabled\" attributes');\n }\n } else {\n throw new Error('Invalid \"target\" value, use a valid Element');\n }\n } // Define selection strategy based on `text` property.\n\n\n if (text) {\n return actions_copy(text, {\n container: container\n });\n } // Defines which selection strategy based on `target` property.\n\n\n if (target) {\n return action === 'cut' ? actions_cut(target) : actions_copy(target, {\n container: container\n });\n }\n};\n\n/* harmony default export */ var actions_default = (ClipboardActionDefault);\n;// CONCATENATED MODULE: ./src/clipboard.js\nfunction clipboard_typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { clipboard_typeof = function _typeof(obj) { return typeof obj; }; } else { clipboard_typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return clipboard_typeof(obj); }\n\nfunction _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError(\"Cannot call a class as a function\"); } }\n\nfunction _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if (\"value\" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }\n\nfunction _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }\n\nfunction _inherits(subClass, superClass) { if (typeof superClass !== \"function\" && superClass !== null) { throw new TypeError(\"Super expression must either be null or a function\"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }\n\nfunction _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }\n\nfunction _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }\n\nfunction _possibleConstructorReturn(self, call) { if (call && (clipboard_typeof(call) === \"object\" || typeof call === \"function\")) { return call; } return _assertThisInitialized(self); }\n\nfunction _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError(\"this hasn't been initialised - super() hasn't been called\"); } return self; }\n\nfunction _isNativeReflectConstruct() { if (typeof Reflect === \"undefined\" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === \"function\") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }\n\nfunction _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }\n\n\n\n\n\n\n/**\n * Helper function to retrieve attribute value.\n * @param {String} suffix\n * @param {Element} element\n */\n\nfunction getAttributeValue(suffix, element) {\n var attribute = \"data-clipboard-\".concat(suffix);\n\n if (!element.hasAttribute(attribute)) {\n return;\n }\n\n return element.getAttribute(attribute);\n}\n/**\n * Base class which takes one or more elements, adds event listeners to them,\n * and instantiates a new `ClipboardAction` on each click.\n */\n\n\nvar Clipboard = /*#__PURE__*/function (_Emitter) {\n _inherits(Clipboard, _Emitter);\n\n var _super = _createSuper(Clipboard);\n\n /**\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n * @param {Object} options\n */\n function Clipboard(trigger, options) {\n var _this;\n\n _classCallCheck(this, Clipboard);\n\n _this = _super.call(this);\n\n _this.resolveOptions(options);\n\n _this.listenClick(trigger);\n\n return _this;\n }\n /**\n * Defines if attributes would be resolved using internal setter functions\n * or custom functions that were passed in the constructor.\n * @param {Object} options\n */\n\n\n _createClass(Clipboard, [{\n key: \"resolveOptions\",\n value: function resolveOptions() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n this.action = typeof options.action === 'function' ? options.action : this.defaultAction;\n this.target = typeof options.target === 'function' ? options.target : this.defaultTarget;\n this.text = typeof options.text === 'function' ? options.text : this.defaultText;\n this.container = clipboard_typeof(options.container) === 'object' ? options.container : document.body;\n }\n /**\n * Adds a click event listener to the passed trigger.\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n */\n\n }, {\n key: \"listenClick\",\n value: function listenClick(trigger) {\n var _this2 = this;\n\n this.listener = listen_default()(trigger, 'click', function (e) {\n return _this2.onClick(e);\n });\n }\n /**\n * Defines a new `ClipboardAction` on each click event.\n * @param {Event} e\n */\n\n }, {\n key: \"onClick\",\n value: function onClick(e) {\n var trigger = e.delegateTarget || e.currentTarget;\n var action = this.action(trigger) || 'copy';\n var text = actions_default({\n action: action,\n container: this.container,\n target: this.target(trigger),\n text: this.text(trigger)\n }); // Fires an event based on the copy operation result.\n\n this.emit(text ? 'success' : 'error', {\n action: action,\n text: text,\n trigger: trigger,\n clearSelection: function clearSelection() {\n if (trigger) {\n trigger.focus();\n }\n\n window.getSelection().removeAllRanges();\n }\n });\n }\n /**\n * Default `action` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultAction\",\n value: function defaultAction(trigger) {\n return getAttributeValue('action', trigger);\n }\n /**\n * Default `target` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultTarget\",\n value: function defaultTarget(trigger) {\n var selector = getAttributeValue('target', trigger);\n\n if (selector) {\n return document.querySelector(selector);\n }\n }\n /**\n * Allow fire programmatically a copy action\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @returns Text copied.\n */\n\n }, {\n key: \"defaultText\",\n\n /**\n * Default `text` lookup function.\n * @param {Element} trigger\n */\n value: function defaultText(trigger) {\n return getAttributeValue('text', trigger);\n }\n /**\n * Destroy lifecycle.\n */\n\n }, {\n key: \"destroy\",\n value: function destroy() {\n this.listener.destroy();\n }\n }], [{\n key: \"copy\",\n value: function copy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n return actions_copy(target, options);\n }\n /**\n * Allow fire programmatically a cut action\n * @param {String|HTMLElement} target\n * @returns Text cutted.\n */\n\n }, {\n key: \"cut\",\n value: function cut(target) {\n return actions_cut(target);\n }\n /**\n * Returns the support of the given action, or all actions if no action is\n * given.\n * @param {String} [action]\n */\n\n }, {\n key: \"isSupported\",\n value: function isSupported() {\n var action = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : ['copy', 'cut'];\n var actions = typeof action === 'string' ? [action] : action;\n var support = !!document.queryCommandSupported;\n actions.forEach(function (action) {\n support = support && !!document.queryCommandSupported(action);\n });\n return support;\n }\n }]);\n\n return Clipboard;\n}((tiny_emitter_default()));\n\n/* harmony default export */ var clipboard = (Clipboard);\n\n/***/ }),\n\n/***/ 828:\n/***/ (function(module) {\n\nvar DOCUMENT_NODE_TYPE = 9;\n\n/**\n * A polyfill for Element.matches()\n */\nif (typeof Element !== 'undefined' && !Element.prototype.matches) {\n var proto = Element.prototype;\n\n proto.matches = proto.matchesSelector ||\n proto.mozMatchesSelector ||\n proto.msMatchesSelector ||\n proto.oMatchesSelector ||\n proto.webkitMatchesSelector;\n}\n\n/**\n * Finds the closest parent that matches a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @return {Function}\n */\nfunction closest (element, selector) {\n while (element && element.nodeType !== DOCUMENT_NODE_TYPE) {\n if (typeof element.matches === 'function' &&\n element.matches(selector)) {\n return element;\n }\n element = element.parentNode;\n }\n}\n\nmodule.exports = closest;\n\n\n/***/ }),\n\n/***/ 438:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar closest = __webpack_require__(828);\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction _delegate(element, selector, type, callback, useCapture) {\n var listenerFn = listener.apply(this, arguments);\n\n element.addEventListener(type, listenerFn, useCapture);\n\n return {\n destroy: function() {\n element.removeEventListener(type, listenerFn, useCapture);\n }\n }\n}\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element|String|Array} [elements]\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction delegate(elements, selector, type, callback, useCapture) {\n // Handle the regular Element usage\n if (typeof elements.addEventListener === 'function') {\n return _delegate.apply(null, arguments);\n }\n\n // Handle Element-less usage, it defaults to global delegation\n if (typeof type === 'function') {\n // Use `document` as the first parameter, then apply arguments\n // This is a short way to .unshift `arguments` without running into deoptimizations\n return _delegate.bind(null, document).apply(null, arguments);\n }\n\n // Handle Selector-based usage\n if (typeof elements === 'string') {\n elements = document.querySelectorAll(elements);\n }\n\n // Handle Array-like based usage\n return Array.prototype.map.call(elements, function (element) {\n return _delegate(element, selector, type, callback, useCapture);\n });\n}\n\n/**\n * Finds closest match and invokes callback.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Function}\n */\nfunction listener(element, selector, type, callback) {\n return function(e) {\n e.delegateTarget = closest(e.target, selector);\n\n if (e.delegateTarget) {\n callback.call(element, e);\n }\n }\n}\n\nmodule.exports = delegate;\n\n\n/***/ }),\n\n/***/ 879:\n/***/ (function(__unused_webpack_module, exports) {\n\n/**\n * Check if argument is a HTML element.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.node = function(value) {\n return value !== undefined\n && value instanceof HTMLElement\n && value.nodeType === 1;\n};\n\n/**\n * Check if argument is a list of HTML elements.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.nodeList = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return value !== undefined\n && (type === '[object NodeList]' || type === '[object HTMLCollection]')\n && ('length' in value)\n && (value.length === 0 || exports.node(value[0]));\n};\n\n/**\n * Check if argument is a string.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.string = function(value) {\n return typeof value === 'string'\n || value instanceof String;\n};\n\n/**\n * Check if argument is a function.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.fn = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return type === '[object Function]';\n};\n\n\n/***/ }),\n\n/***/ 370:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar is = __webpack_require__(879);\nvar delegate = __webpack_require__(438);\n\n/**\n * Validates all params and calls the right\n * listener function based on its target type.\n *\n * @param {String|HTMLElement|HTMLCollection|NodeList} target\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listen(target, type, callback) {\n if (!target && !type && !callback) {\n throw new Error('Missing required arguments');\n }\n\n if (!is.string(type)) {\n throw new TypeError('Second argument must be a String');\n }\n\n if (!is.fn(callback)) {\n throw new TypeError('Third argument must be a Function');\n }\n\n if (is.node(target)) {\n return listenNode(target, type, callback);\n }\n else if (is.nodeList(target)) {\n return listenNodeList(target, type, callback);\n }\n else if (is.string(target)) {\n return listenSelector(target, type, callback);\n }\n else {\n throw new TypeError('First argument must be a String, HTMLElement, HTMLCollection, or NodeList');\n }\n}\n\n/**\n * Adds an event listener to a HTML element\n * and returns a remove listener function.\n *\n * @param {HTMLElement} node\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNode(node, type, callback) {\n node.addEventListener(type, callback);\n\n return {\n destroy: function() {\n node.removeEventListener(type, callback);\n }\n }\n}\n\n/**\n * Add an event listener to a list of HTML elements\n * and returns a remove listener function.\n *\n * @param {NodeList|HTMLCollection} nodeList\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNodeList(nodeList, type, callback) {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.addEventListener(type, callback);\n });\n\n return {\n destroy: function() {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.removeEventListener(type, callback);\n });\n }\n }\n}\n\n/**\n * Add an event listener to a selector\n * and returns a remove listener function.\n *\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenSelector(selector, type, callback) {\n return delegate(document.body, selector, type, callback);\n}\n\nmodule.exports = listen;\n\n\n/***/ }),\n\n/***/ 817:\n/***/ (function(module) {\n\nfunction select(element) {\n var selectedText;\n\n if (element.nodeName === 'SELECT') {\n element.focus();\n\n selectedText = element.value;\n }\n else if (element.nodeName === 'INPUT' || element.nodeName === 'TEXTAREA') {\n var isReadOnly = element.hasAttribute('readonly');\n\n if (!isReadOnly) {\n element.setAttribute('readonly', '');\n }\n\n element.select();\n element.setSelectionRange(0, element.value.length);\n\n if (!isReadOnly) {\n element.removeAttribute('readonly');\n }\n\n selectedText = element.value;\n }\n else {\n if (element.hasAttribute('contenteditable')) {\n element.focus();\n }\n\n var selection = window.getSelection();\n var range = document.createRange();\n\n range.selectNodeContents(element);\n selection.removeAllRanges();\n selection.addRange(range);\n\n selectedText = selection.toString();\n }\n\n return selectedText;\n}\n\nmodule.exports = select;\n\n\n/***/ }),\n\n/***/ 279:\n/***/ (function(module) {\n\nfunction E () {\n // Keep this empty so it's easier to inherit from\n // (via https://github.com/lipsmack from https://github.com/scottcorgan/tiny-emitter/issues/3)\n}\n\nE.prototype = {\n on: function (name, callback, ctx) {\n var e = this.e || (this.e = {});\n\n (e[name] || (e[name] = [])).push({\n fn: callback,\n ctx: ctx\n });\n\n return this;\n },\n\n once: function (name, callback, ctx) {\n var self = this;\n function listener () {\n self.off(name, listener);\n callback.apply(ctx, arguments);\n };\n\n listener._ = callback\n return this.on(name, listener, ctx);\n },\n\n emit: function (name) {\n var data = [].slice.call(arguments, 1);\n var evtArr = ((this.e || (this.e = {}))[name] || []).slice();\n var i = 0;\n var len = evtArr.length;\n\n for (i; i < len; i++) {\n evtArr[i].fn.apply(evtArr[i].ctx, data);\n }\n\n return this;\n },\n\n off: function (name, callback) {\n var e = this.e || (this.e = {});\n var evts = e[name];\n var liveEvents = [];\n\n if (evts && callback) {\n for (var i = 0, len = evts.length; i < len; i++) {\n if (evts[i].fn !== callback && evts[i].fn._ !== callback)\n liveEvents.push(evts[i]);\n }\n }\n\n // Remove event from queue to prevent memory leak\n // Suggested by https://github.com/lazd\n // Ref: https://github.com/scottcorgan/tiny-emitter/commit/c6ebfaa9bc973b33d110a84a307742b7cf94c953#commitcomment-5024910\n\n (liveEvents.length)\n ? e[name] = liveEvents\n : delete e[name];\n\n return this;\n }\n};\n\nmodule.exports = E;\nmodule.exports.TinyEmitter = E;\n\n\n/***/ })\n\n/******/ \t});\n/************************************************************************/\n/******/ \t// The module cache\n/******/ \tvar __webpack_module_cache__ = {};\n/******/ \t\n/******/ \t// The require function\n/******/ \tfunction __webpack_require__(moduleId) {\n/******/ \t\t// Check if module is in cache\n/******/ \t\tif(__webpack_module_cache__[moduleId]) {\n/******/ \t\t\treturn __webpack_module_cache__[moduleId].exports;\n/******/ \t\t}\n/******/ \t\t// Create a new module (and put it into the cache)\n/******/ \t\tvar module = __webpack_module_cache__[moduleId] = {\n/******/ \t\t\t// no module.id needed\n/******/ \t\t\t// no module.loaded needed\n/******/ \t\t\texports: {}\n/******/ \t\t};\n/******/ \t\n/******/ \t\t// Execute the module function\n/******/ \t\t__webpack_modules__[moduleId](module, module.exports, __webpack_require__);\n/******/ \t\n/******/ \t\t// Return the exports of the module\n/******/ \t\treturn module.exports;\n/******/ \t}\n/******/ \t\n/************************************************************************/\n/******/ \t/* webpack/runtime/compat get default export */\n/******/ \t!function() {\n/******/ \t\t// getDefaultExport function for compatibility with non-harmony modules\n/******/ \t\t__webpack_require__.n = function(module) {\n/******/ \t\t\tvar getter = module && module.__esModule ?\n/******/ \t\t\t\tfunction() { return module['default']; } :\n/******/ \t\t\t\tfunction() { return module; };\n/******/ \t\t\t__webpack_require__.d(getter, { a: getter });\n/******/ \t\t\treturn getter;\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/define property getters */\n/******/ \t!function() {\n/******/ \t\t// define getter functions for harmony exports\n/******/ \t\t__webpack_require__.d = function(exports, definition) {\n/******/ \t\t\tfor(var key in definition) {\n/******/ \t\t\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n/******/ \t\t\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n/******/ \t\t\t\t}\n/******/ \t\t\t}\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/hasOwnProperty shorthand */\n/******/ \t!function() {\n/******/ \t\t__webpack_require__.o = function(obj, prop) { return Object.prototype.hasOwnProperty.call(obj, prop); }\n/******/ \t}();\n/******/ \t\n/************************************************************************/\n/******/ \t// module exports must be returned from runtime so entry inlining is disabled\n/******/ \t// startup\n/******/ \t// Load entry module and return exports\n/******/ \treturn __webpack_require__(686);\n/******/ })()\n.default;\n});", "/*\n * Copyright (c) 2016-2025 Martin Donath \n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to\n * deal in the Software without restriction, including without limitation the\n * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or\n * sell copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\n * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\n * IN THE SOFTWARE.\n */\n\nimport \"focus-visible\"\n\nimport {\n EMPTY,\n NEVER,\n Observable,\n Subject,\n defer,\n delay,\n filter,\n map,\n merge,\n mergeWith,\n shareReplay,\n switchMap\n} from \"rxjs\"\n\nimport { configuration, feature } from \"./_\"\nimport {\n at,\n getActiveElement,\n getOptionalElement,\n requestJSON,\n setLocation,\n setToggle,\n watchDocument,\n watchKeyboard,\n watchLocation,\n watchLocationTarget,\n watchMedia,\n watchPrint,\n watchScript,\n watchViewport\n} from \"./browser\"\nimport {\n getComponentElement,\n getComponentElements,\n mountAnnounce,\n mountBackToTop,\n mountConsent,\n mountContent,\n mountDialog,\n mountHeader,\n mountHeaderTitle,\n mountPalette,\n mountProgress,\n mountSearch,\n mountSearchHiglight,\n mountSidebar,\n mountSource,\n mountTableOfContents,\n mountTabs,\n watchHeader,\n watchMain\n} from \"./components\"\nimport {\n SearchIndex,\n fetchSitemap,\n setupAlternate,\n setupClipboardJS,\n setupInstantNavigation,\n setupVersionSelector\n} from \"./integrations\"\nimport {\n patchEllipsis,\n patchIndeterminate,\n patchScrollfix,\n patchScrolllock\n} from \"./patches\"\nimport \"./polyfills\"\n\n/* ----------------------------------------------------------------------------\n * Functions - @todo refactor\n * ------------------------------------------------------------------------- */\n\n/**\n * Fetch search index\n *\n * @returns Search index observable\n */\nfunction fetchSearchIndex(): Observable {\n if (location.protocol === \"file:\") {\n return watchScript(\n `${new URL(\"search/search_index.js\", config.base)}`\n )\n .pipe(\n // @ts-ignore - @todo fix typings\n map(() => __index),\n shareReplay(1)\n )\n } else {\n return requestJSON(\n new URL(\"search/search_index.json\", config.base)\n )\n }\n}\n\n/* ----------------------------------------------------------------------------\n * Application\n * ------------------------------------------------------------------------- */\n\n/* Yay, JavaScript is available */\ndocument.documentElement.classList.remove(\"no-js\")\ndocument.documentElement.classList.add(\"js\")\n\n/* Set up navigation observables and subjects */\nconst document$ = watchDocument()\nconst location$ = watchLocation()\nconst target$ = watchLocationTarget(location$)\nconst keyboard$ = watchKeyboard()\n\n/* Set up media observables */\nconst viewport$ = watchViewport()\nconst tablet$ = watchMedia(\"(min-width: 60em)\")\nconst screen$ = watchMedia(\"(min-width: 76.25em)\")\nconst print$ = watchPrint()\n\n/* Retrieve search index, if search is enabled */\nconst config = configuration()\nconst index$ = document.forms.namedItem(\"search\")\n ? fetchSearchIndex()\n : NEVER\n\n/* Set up Clipboard.js integration */\nconst alert$ = new Subject()\nsetupClipboardJS({ alert$ })\n\n/* Set up language selector */\nsetupAlternate({ document$ })\n\n/* Set up progress indicator */\nconst progress$ = new Subject()\n\n/* Set up sitemap for instant navigation and previews */\nconst sitemap$ = fetchSitemap(config.base)\n\n/* Set up instant navigation, if enabled */\nif (feature(\"navigation.instant\"))\n setupInstantNavigation({ sitemap$, location$, viewport$, progress$ })\n .subscribe(document$)\n\n/* Set up version selector */\nif (config.version?.provider === \"mike\")\n setupVersionSelector({ document$ })\n\n/* Always close drawer and search on navigation */\nmerge(location$, target$)\n .pipe(\n delay(125)\n )\n .subscribe(() => {\n setToggle(\"drawer\", false)\n setToggle(\"search\", false)\n })\n\n/* Set up global keyboard handlers */\nkeyboard$\n .pipe(\n filter(({ mode }) => mode === \"global\")\n )\n .subscribe(key => {\n switch (key.type) {\n\n /* Go to previous page */\n case \"p\":\n case \",\":\n const prev = getOptionalElement(\"link[rel=prev]\")\n if (typeof prev !== \"undefined\")\n setLocation(prev)\n break\n\n /* Go to next page */\n case \"n\":\n case \".\":\n const next = getOptionalElement(\"link[rel=next]\")\n if (typeof next !== \"undefined\")\n setLocation(next)\n break\n\n /* Expand navigation, see https://bit.ly/3ZjG5io */\n case \"Enter\":\n const active = getActiveElement()\n if (active instanceof HTMLLabelElement)\n active.click()\n }\n })\n\n/* Set up patches */\npatchEllipsis({ viewport$, document$ })\npatchIndeterminate({ document$, tablet$ })\npatchScrollfix({ document$ })\npatchScrolllock({ viewport$, tablet$ })\n\n/* Set up header and main area observable */\nconst header$ = watchHeader(getComponentElement(\"header\"), { viewport$ })\nconst main$ = document$\n .pipe(\n map(() => getComponentElement(\"main\")),\n switchMap(el => watchMain(el, { viewport$, header$ })),\n shareReplay(1)\n )\n\n/* Set up control component observables */\nconst control$ = merge(\n\n /* Consent */\n ...getComponentElements(\"consent\")\n .map(el => mountConsent(el, { target$ })),\n\n /* Dialog */\n ...getComponentElements(\"dialog\")\n .map(el => mountDialog(el, { alert$ })),\n\n /* Color palette */\n ...getComponentElements(\"palette\")\n .map(el => mountPalette(el)),\n\n /* Progress bar */\n ...getComponentElements(\"progress\")\n .map(el => mountProgress(el, { progress$ })),\n\n /* Search */\n ...getComponentElements(\"search\")\n .map(el => mountSearch(el, { index$, keyboard$ })),\n\n /* Repository information */\n ...getComponentElements(\"source\")\n .map(el => mountSource(el))\n)\n\n/* Set up content component observables */\nconst content$ = defer(() => merge(\n\n /* Announcement bar */\n ...getComponentElements(\"announce\")\n .map(el => mountAnnounce(el)),\n\n /* Content */\n ...getComponentElements(\"content\")\n .map(el => mountContent(el, { sitemap$, viewport$, target$, print$ })),\n\n /* Search highlighting */\n ...getComponentElements(\"content\")\n .map(el => feature(\"search.highlight\")\n ? mountSearchHiglight(el, { index$, location$ })\n : EMPTY\n ),\n\n /* Header */\n ...getComponentElements(\"header\")\n .map(el => mountHeader(el, { viewport$, header$, main$ })),\n\n /* Header title */\n ...getComponentElements(\"header-title\")\n .map(el => mountHeaderTitle(el, { viewport$, header$ })),\n\n /* Sidebar */\n ...getComponentElements(\"sidebar\")\n .map(el => el.getAttribute(\"data-md-type\") === \"navigation\"\n ? at(screen$, () => mountSidebar(el, { viewport$, header$, main$ }))\n : at(tablet$, () => mountSidebar(el, { viewport$, header$, main$ }))\n ),\n\n /* Navigation tabs */\n ...getComponentElements(\"tabs\")\n .map(el => mountTabs(el, { viewport$, header$ })),\n\n /* Table of contents */\n ...getComponentElements(\"toc\")\n .map(el => mountTableOfContents(el, {\n viewport$, header$, main$, target$\n })),\n\n /* Back-to-top button */\n ...getComponentElements(\"top\")\n .map(el => mountBackToTop(el, { viewport$, header$, main$, target$ }))\n))\n\n/* Set up component observables */\nconst component$ = document$\n .pipe(\n switchMap(() => content$),\n mergeWith(control$),\n shareReplay(1)\n )\n\n/* Subscribe to all components */\ncomponent$.subscribe()\n\n/* ----------------------------------------------------------------------------\n * Exports\n * ------------------------------------------------------------------------- */\n\nwindow.document$ = document$ /* Document observable */\nwindow.location$ = location$ /* Location subject */\nwindow.target$ = target$ /* Location target observable */\nwindow.keyboard$ = keyboard$ /* Keyboard observable */\nwindow.viewport$ = viewport$ /* Viewport observable */\nwindow.tablet$ = tablet$ /* Media tablet observable */\nwindow.screen$ = screen$ /* Media screen observable */\nwindow.print$ = print$ /* Media print observable */\nwindow.alert$ = alert$ /* Alert subject */\nwindow.progress$ = progress$ /* Progress indicator subject */\nwindow.component$ = component$ /* Component observable */\n", "/******************************************************************************\nCopyright (c) Microsoft Corporation.\n\nPermission to use, copy, modify, and/or distribute this software for any\npurpose with or without fee is hereby granted.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\nAND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n***************************************************************************** */\n/* global Reflect, Promise, SuppressedError, Symbol, Iterator */\n\nvar extendStatics = function(d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n};\n\nexport function __extends(d, b) {\n if (typeof b !== \"function\" && b !== null)\n throw new TypeError(\"Class extends value \" + String(b) + \" is not a constructor or null\");\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n}\n\nexport var __assign = function() {\n __assign = Object.assign || function __assign(t) {\n for (var s, i = 1, n = arguments.length; i < n; i++) {\n s = arguments[i];\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];\n }\n return t;\n }\n return __assign.apply(this, arguments);\n}\n\nexport function __rest(s, e) {\n var t = {};\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)\n t[p] = s[p];\n if (s != null && typeof Object.getOwnPropertySymbols === \"function\")\n for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {\n if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))\n t[p[i]] = s[p[i]];\n }\n return t;\n}\n\nexport function __decorate(decorators, target, key, desc) {\n var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;\n if (typeof Reflect === \"object\" && typeof Reflect.decorate === \"function\") r = Reflect.decorate(decorators, target, key, desc);\n else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;\n return c > 3 && r && Object.defineProperty(target, key, r), r;\n}\n\nexport function __param(paramIndex, decorator) {\n return function (target, key) { decorator(target, key, paramIndex); }\n}\n\nexport function __esDecorate(ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {\n function accept(f) { if (f !== void 0 && typeof f !== \"function\") throw new TypeError(\"Function expected\"); return f; }\n var kind = contextIn.kind, key = kind === \"getter\" ? \"get\" : kind === \"setter\" ? \"set\" : \"value\";\n var target = !descriptorIn && ctor ? contextIn[\"static\"] ? ctor : ctor.prototype : null;\n var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});\n var _, done = false;\n for (var i = decorators.length - 1; i >= 0; i--) {\n var context = {};\n for (var p in contextIn) context[p] = p === \"access\" ? {} : contextIn[p];\n for (var p in contextIn.access) context.access[p] = contextIn.access[p];\n context.addInitializer = function (f) { if (done) throw new TypeError(\"Cannot add initializers after decoration has completed\"); extraInitializers.push(accept(f || null)); };\n var result = (0, decorators[i])(kind === \"accessor\" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);\n if (kind === \"accessor\") {\n if (result === void 0) continue;\n if (result === null || typeof result !== \"object\") throw new TypeError(\"Object expected\");\n if (_ = accept(result.get)) descriptor.get = _;\n if (_ = accept(result.set)) descriptor.set = _;\n if (_ = accept(result.init)) initializers.unshift(_);\n }\n else if (_ = accept(result)) {\n if (kind === \"field\") initializers.unshift(_);\n else descriptor[key] = _;\n }\n }\n if (target) Object.defineProperty(target, contextIn.name, descriptor);\n done = true;\n};\n\nexport function __runInitializers(thisArg, initializers, value) {\n var useValue = arguments.length > 2;\n for (var i = 0; i < initializers.length; i++) {\n value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);\n }\n return useValue ? value : void 0;\n};\n\nexport function __propKey(x) {\n return typeof x === \"symbol\" ? x : \"\".concat(x);\n};\n\nexport function __setFunctionName(f, name, prefix) {\n if (typeof name === \"symbol\") name = name.description ? \"[\".concat(name.description, \"]\") : \"\";\n return Object.defineProperty(f, \"name\", { configurable: true, value: prefix ? \"\".concat(prefix, \" \", name) : name });\n};\n\nexport function __metadata(metadataKey, metadataValue) {\n if (typeof Reflect === \"object\" && typeof Reflect.metadata === \"function\") return Reflect.metadata(metadataKey, metadataValue);\n}\n\nexport function __awaiter(thisArg, _arguments, P, generator) {\n function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }\n return new (P || (P = Promise))(function (resolve, reject) {\n function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }\n function rejected(value) { try { step(generator[\"throw\"](value)); } catch (e) { reject(e); } }\n function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }\n step((generator = generator.apply(thisArg, _arguments || [])).next());\n });\n}\n\nexport function __generator(thisArg, body) {\n var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === \"function\" ? Iterator : Object).prototype);\n return g.next = verb(0), g[\"throw\"] = verb(1), g[\"return\"] = verb(2), typeof Symbol === \"function\" && (g[Symbol.iterator] = function() { return this; }), g;\n function verb(n) { return function (v) { return step([n, v]); }; }\n function step(op) {\n if (f) throw new TypeError(\"Generator is already executing.\");\n while (g && (g = 0, op[0] && (_ = 0)), _) try {\n if (f = 1, y && (t = op[0] & 2 ? y[\"return\"] : op[0] ? y[\"throw\"] || ((t = y[\"return\"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;\n if (y = 0, t) op = [op[0] & 2, t.value];\n switch (op[0]) {\n case 0: case 1: t = op; break;\n case 4: _.label++; return { value: op[1], done: false };\n case 5: _.label++; y = op[1]; op = [0]; continue;\n case 7: op = _.ops.pop(); _.trys.pop(); continue;\n default:\n if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }\n if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }\n if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }\n if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }\n if (t[2]) _.ops.pop();\n _.trys.pop(); continue;\n }\n op = body.call(thisArg, _);\n } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }\n if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };\n }\n}\n\nexport var __createBinding = Object.create ? (function(o, m, k, k2) {\n if (k2 === undefined) k2 = k;\n var desc = Object.getOwnPropertyDescriptor(m, k);\n if (!desc || (\"get\" in desc ? !m.__esModule : desc.writable || desc.configurable)) {\n desc = { enumerable: true, get: function() { return m[k]; } };\n }\n Object.defineProperty(o, k2, desc);\n}) : (function(o, m, k, k2) {\n if (k2 === undefined) k2 = k;\n o[k2] = m[k];\n});\n\nexport function __exportStar(m, o) {\n for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(o, p)) __createBinding(o, m, p);\n}\n\nexport function __values(o) {\n var s = typeof Symbol === \"function\" && Symbol.iterator, m = s && o[s], i = 0;\n if (m) return m.call(o);\n if (o && typeof o.length === \"number\") return {\n next: function () {\n if (o && i >= o.length) o = void 0;\n return { value: o && o[i++], done: !o };\n }\n };\n throw new TypeError(s ? \"Object is not iterable.\" : \"Symbol.iterator is not defined.\");\n}\n\nexport function __read(o, n) {\n var m = typeof Symbol === \"function\" && o[Symbol.iterator];\n if (!m) return o;\n var i = m.call(o), r, ar = [], e;\n try {\n while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);\n }\n catch (error) { e = { error: error }; }\n finally {\n try {\n if (r && !r.done && (m = i[\"return\"])) m.call(i);\n }\n finally { if (e) throw e.error; }\n }\n return ar;\n}\n\n/** @deprecated */\nexport function __spread() {\n for (var ar = [], i = 0; i < arguments.length; i++)\n ar = ar.concat(__read(arguments[i]));\n return ar;\n}\n\n/** @deprecated */\nexport function __spreadArrays() {\n for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;\n for (var r = Array(s), k = 0, i = 0; i < il; i++)\n for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)\n r[k] = a[j];\n return r;\n}\n\nexport function __spreadArray(to, from, pack) {\n if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {\n if (ar || !(i in from)) {\n if (!ar) ar = Array.prototype.slice.call(from, 0, i);\n ar[i] = from[i];\n }\n }\n return to.concat(ar || Array.prototype.slice.call(from));\n}\n\nexport function __await(v) {\n return this instanceof __await ? (this.v = v, this) : new __await(v);\n}\n\nexport function __asyncGenerator(thisArg, _arguments, generator) {\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\n var g = generator.apply(thisArg, _arguments || []), i, q = [];\n return i = Object.create((typeof AsyncIterator === \"function\" ? AsyncIterator : Object).prototype), verb(\"next\"), verb(\"throw\"), verb(\"return\", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;\n function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }\n function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }\n function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }\n function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }\n function fulfill(value) { resume(\"next\", value); }\n function reject(value) { resume(\"throw\", value); }\n function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }\n}\n\nexport function __asyncDelegator(o) {\n var i, p;\n return i = {}, verb(\"next\"), verb(\"throw\", function (e) { throw e; }), verb(\"return\"), i[Symbol.iterator] = function () { return this; }, i;\n function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: false } : f ? f(v) : v; } : f; }\n}\n\nexport function __asyncValues(o) {\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\n var m = o[Symbol.asyncIterator], i;\n return m ? m.call(o) : (o = typeof __values === \"function\" ? __values(o) : o[Symbol.iterator](), i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i);\n function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }\n function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }\n}\n\nexport function __makeTemplateObject(cooked, raw) {\n if (Object.defineProperty) { Object.defineProperty(cooked, \"raw\", { value: raw }); } else { cooked.raw = raw; }\n return cooked;\n};\n\nvar __setModuleDefault = Object.create ? (function(o, v) {\n Object.defineProperty(o, \"default\", { enumerable: true, value: v });\n}) : function(o, v) {\n o[\"default\"] = v;\n};\n\nexport function __importStar(mod) {\n if (mod && mod.__esModule) return mod;\n var result = {};\n if (mod != null) for (var k in mod) if (k !== \"default\" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);\n __setModuleDefault(result, mod);\n return result;\n}\n\nexport function __importDefault(mod) {\n return (mod && mod.__esModule) ? mod : { default: mod };\n}\n\nexport function __classPrivateFieldGet(receiver, state, kind, f) {\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a getter\");\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot read private member from an object whose class did not declare it\");\n return kind === \"m\" ? f : kind === \"a\" ? f.call(receiver) : f ? f.value : state.get(receiver);\n}\n\nexport function __classPrivateFieldSet(receiver, state, value, kind, f) {\n if (kind === \"m\") throw new TypeError(\"Private method is not writable\");\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a setter\");\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot write private member to an object whose class did not declare it\");\n return (kind === \"a\" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;\n}\n\nexport function __classPrivateFieldIn(state, receiver) {\n if (receiver === null || (typeof receiver !== \"object\" && typeof receiver !== \"function\")) throw new TypeError(\"Cannot use 'in' operator on non-object\");\n return typeof state === \"function\" ? receiver === state : state.has(receiver);\n}\n\nexport function __addDisposableResource(env, value, async) {\n if (value !== null && value !== void 0) {\n if (typeof value !== \"object\" && typeof value !== \"function\") throw new TypeError(\"Object expected.\");\n var dispose, inner;\n if (async) {\n if (!Symbol.asyncDispose) throw new TypeError(\"Symbol.asyncDispose is not defined.\");\n dispose = value[Symbol.asyncDispose];\n }\n if (dispose === void 0) {\n if (!Symbol.dispose) throw new TypeError(\"Symbol.dispose is not defined.\");\n dispose = value[Symbol.dispose];\n if (async) inner = dispose;\n }\n if (typeof dispose !== \"function\") throw new TypeError(\"Object not disposable.\");\n if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };\n env.stack.push({ value: value, dispose: dispose, async: async });\n }\n else if (async) {\n env.stack.push({ async: true });\n }\n return value;\n}\n\nvar _SuppressedError = typeof SuppressedError === \"function\" ? SuppressedError : function (error, suppressed, message) {\n var e = new Error(message);\n return e.name = \"SuppressedError\", e.error = error, e.suppressed = suppressed, e;\n};\n\nexport function __disposeResources(env) {\n function fail(e) {\n env.error = env.hasError ? new _SuppressedError(e, env.error, \"An error was suppressed during disposal.\") : e;\n env.hasError = true;\n }\n var r, s = 0;\n function next() {\n while (r = env.stack.pop()) {\n try {\n if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);\n if (r.dispose) {\n var result = r.dispose.call(r.value);\n if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });\n }\n else s |= 1;\n }\n catch (e) {\n fail(e);\n }\n }\n if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();\n if (env.hasError) throw env.error;\n }\n return next();\n}\n\nexport default {\n __extends,\n __assign,\n __rest,\n __decorate,\n __param,\n __metadata,\n __awaiter,\n __generator,\n __createBinding,\n __exportStar,\n __values,\n __read,\n __spread,\n __spreadArrays,\n __spreadArray,\n __await,\n __asyncGenerator,\n __asyncDelegator,\n __asyncValues,\n __makeTemplateObject,\n __importStar,\n __importDefault,\n __classPrivateFieldGet,\n __classPrivateFieldSet,\n __classPrivateFieldIn,\n __addDisposableResource,\n __disposeResources,\n};\n", "/**\n * Returns true if the object is a function.\n * @param value The value to check\n */\nexport function isFunction(value: any): value is (...args: any[]) => any {\n return typeof value === 'function';\n}\n", "/**\n * Used to create Error subclasses until the community moves away from ES5.\n *\n * This is because compiling from TypeScript down to ES5 has issues with subclassing Errors\n * as well as other built-in types: https://github.com/Microsoft/TypeScript/issues/12123\n *\n * @param createImpl A factory function to create the actual constructor implementation. The returned\n * function should be a named function that calls `_super` internally.\n */\nexport function createErrorClass(createImpl: (_super: any) => any): T {\n const _super = (instance: any) => {\n Error.call(instance);\n instance.stack = new Error().stack;\n };\n\n const ctorFunc = createImpl(_super);\n ctorFunc.prototype = Object.create(Error.prototype);\n ctorFunc.prototype.constructor = ctorFunc;\n return ctorFunc;\n}\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface UnsubscriptionError extends Error {\n readonly errors: any[];\n}\n\nexport interface UnsubscriptionErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (errors: any[]): UnsubscriptionError;\n}\n\n/**\n * An error thrown when one or more errors have occurred during the\n * `unsubscribe` of a {@link Subscription}.\n */\nexport const UnsubscriptionError: UnsubscriptionErrorCtor = createErrorClass(\n (_super) =>\n function UnsubscriptionErrorImpl(this: any, errors: (Error | string)[]) {\n _super(this);\n this.message = errors\n ? `${errors.length} errors occurred during unsubscription:\n${errors.map((err, i) => `${i + 1}) ${err.toString()}`).join('\\n ')}`\n : '';\n this.name = 'UnsubscriptionError';\n this.errors = errors;\n }\n);\n", "/**\n * Removes an item from an array, mutating it.\n * @param arr The array to remove the item from\n * @param item The item to remove\n */\nexport function arrRemove(arr: T[] | undefined | null, item: T) {\n if (arr) {\n const index = arr.indexOf(item);\n 0 <= index && arr.splice(index, 1);\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { UnsubscriptionError } from './util/UnsubscriptionError';\nimport { SubscriptionLike, TeardownLogic, Unsubscribable } from './types';\nimport { arrRemove } from './util/arrRemove';\n\n/**\n * Represents a disposable resource, such as the execution of an Observable. A\n * Subscription has one important method, `unsubscribe`, that takes no argument\n * and just disposes the resource held by the subscription.\n *\n * Additionally, subscriptions may be grouped together through the `add()`\n * method, which will attach a child Subscription to the current Subscription.\n * When a Subscription is unsubscribed, all its children (and its grandchildren)\n * will be unsubscribed as well.\n */\nexport class Subscription implements SubscriptionLike {\n public static EMPTY = (() => {\n const empty = new Subscription();\n empty.closed = true;\n return empty;\n })();\n\n /**\n * A flag to indicate whether this Subscription has already been unsubscribed.\n */\n public closed = false;\n\n private _parentage: Subscription[] | Subscription | null = null;\n\n /**\n * The list of registered finalizers to execute upon unsubscription. Adding and removing from this\n * list occurs in the {@link #add} and {@link #remove} methods.\n */\n private _finalizers: Exclude[] | null = null;\n\n /**\n * @param initialTeardown A function executed first as part of the finalization\n * process that is kicked off when {@link #unsubscribe} is called.\n */\n constructor(private initialTeardown?: () => void) {}\n\n /**\n * Disposes the resources held by the subscription. May, for instance, cancel\n * an ongoing Observable execution or cancel any other type of work that\n * started when the Subscription was created.\n */\n unsubscribe(): void {\n let errors: any[] | undefined;\n\n if (!this.closed) {\n this.closed = true;\n\n // Remove this from it's parents.\n const { _parentage } = this;\n if (_parentage) {\n this._parentage = null;\n if (Array.isArray(_parentage)) {\n for (const parent of _parentage) {\n parent.remove(this);\n }\n } else {\n _parentage.remove(this);\n }\n }\n\n const { initialTeardown: initialFinalizer } = this;\n if (isFunction(initialFinalizer)) {\n try {\n initialFinalizer();\n } catch (e) {\n errors = e instanceof UnsubscriptionError ? e.errors : [e];\n }\n }\n\n const { _finalizers } = this;\n if (_finalizers) {\n this._finalizers = null;\n for (const finalizer of _finalizers) {\n try {\n execFinalizer(finalizer);\n } catch (err) {\n errors = errors ?? [];\n if (err instanceof UnsubscriptionError) {\n errors = [...errors, ...err.errors];\n } else {\n errors.push(err);\n }\n }\n }\n }\n\n if (errors) {\n throw new UnsubscriptionError(errors);\n }\n }\n }\n\n /**\n * Adds a finalizer to this subscription, so that finalization will be unsubscribed/called\n * when this subscription is unsubscribed. If this subscription is already {@link #closed},\n * because it has already been unsubscribed, then whatever finalizer is passed to it\n * will automatically be executed (unless the finalizer itself is also a closed subscription).\n *\n * Closed Subscriptions cannot be added as finalizers to any subscription. Adding a closed\n * subscription to a any subscription will result in no operation. (A noop).\n *\n * Adding a subscription to itself, or adding `null` or `undefined` will not perform any\n * operation at all. (A noop).\n *\n * `Subscription` instances that are added to this instance will automatically remove themselves\n * if they are unsubscribed. Functions and {@link Unsubscribable} objects that you wish to remove\n * will need to be removed manually with {@link #remove}\n *\n * @param teardown The finalization logic to add to this subscription.\n */\n add(teardown: TeardownLogic): void {\n // Only add the finalizer if it's not undefined\n // and don't add a subscription to itself.\n if (teardown && teardown !== this) {\n if (this.closed) {\n // If this subscription is already closed,\n // execute whatever finalizer is handed to it automatically.\n execFinalizer(teardown);\n } else {\n if (teardown instanceof Subscription) {\n // We don't add closed subscriptions, and we don't add the same subscription\n // twice. Subscription unsubscribe is idempotent.\n if (teardown.closed || teardown._hasParent(this)) {\n return;\n }\n teardown._addParent(this);\n }\n (this._finalizers = this._finalizers ?? []).push(teardown);\n }\n }\n }\n\n /**\n * Checks to see if a this subscription already has a particular parent.\n * This will signal that this subscription has already been added to the parent in question.\n * @param parent the parent to check for\n */\n private _hasParent(parent: Subscription) {\n const { _parentage } = this;\n return _parentage === parent || (Array.isArray(_parentage) && _parentage.includes(parent));\n }\n\n /**\n * Adds a parent to this subscription so it can be removed from the parent if it\n * unsubscribes on it's own.\n *\n * NOTE: THIS ASSUMES THAT {@link _hasParent} HAS ALREADY BEEN CHECKED.\n * @param parent The parent subscription to add\n */\n private _addParent(parent: Subscription) {\n const { _parentage } = this;\n this._parentage = Array.isArray(_parentage) ? (_parentage.push(parent), _parentage) : _parentage ? [_parentage, parent] : parent;\n }\n\n /**\n * Called on a child when it is removed via {@link #remove}.\n * @param parent The parent to remove\n */\n private _removeParent(parent: Subscription) {\n const { _parentage } = this;\n if (_parentage === parent) {\n this._parentage = null;\n } else if (Array.isArray(_parentage)) {\n arrRemove(_parentage, parent);\n }\n }\n\n /**\n * Removes a finalizer from this subscription that was previously added with the {@link #add} method.\n *\n * Note that `Subscription` instances, when unsubscribed, will automatically remove themselves\n * from every other `Subscription` they have been added to. This means that using the `remove` method\n * is not a common thing and should be used thoughtfully.\n *\n * If you add the same finalizer instance of a function or an unsubscribable object to a `Subscription` instance\n * more than once, you will need to call `remove` the same number of times to remove all instances.\n *\n * All finalizer instances are removed to free up memory upon unsubscription.\n *\n * @param teardown The finalizer to remove from this subscription\n */\n remove(teardown: Exclude): void {\n const { _finalizers } = this;\n _finalizers && arrRemove(_finalizers, teardown);\n\n if (teardown instanceof Subscription) {\n teardown._removeParent(this);\n }\n }\n}\n\nexport const EMPTY_SUBSCRIPTION = Subscription.EMPTY;\n\nexport function isSubscription(value: any): value is Subscription {\n return (\n value instanceof Subscription ||\n (value && 'closed' in value && isFunction(value.remove) && isFunction(value.add) && isFunction(value.unsubscribe))\n );\n}\n\nfunction execFinalizer(finalizer: Unsubscribable | (() => void)) {\n if (isFunction(finalizer)) {\n finalizer();\n } else {\n finalizer.unsubscribe();\n }\n}\n", "import { Subscriber } from './Subscriber';\nimport { ObservableNotification } from './types';\n\n/**\n * The {@link GlobalConfig} object for RxJS. It is used to configure things\n * like how to react on unhandled errors.\n */\nexport const config: GlobalConfig = {\n onUnhandledError: null,\n onStoppedNotification: null,\n Promise: undefined,\n useDeprecatedSynchronousErrorHandling: false,\n useDeprecatedNextContext: false,\n};\n\n/**\n * The global configuration object for RxJS, used to configure things\n * like how to react on unhandled errors. Accessible via {@link config}\n * object.\n */\nexport interface GlobalConfig {\n /**\n * A registration point for unhandled errors from RxJS. These are errors that\n * cannot were not handled by consuming code in the usual subscription path. For\n * example, if you have this configured, and you subscribe to an observable without\n * providing an error handler, errors from that subscription will end up here. This\n * will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onUnhandledError: ((err: any) => void) | null;\n\n /**\n * A registration point for notifications that cannot be sent to subscribers because they\n * have completed, errored or have been explicitly unsubscribed. By default, next, complete\n * and error notifications sent to stopped subscribers are noops. However, sometimes callers\n * might want a different behavior. For example, with sources that attempt to report errors\n * to stopped subscribers, a caller can configure RxJS to throw an unhandled error instead.\n * This will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onStoppedNotification: ((notification: ObservableNotification, subscriber: Subscriber) => void) | null;\n\n /**\n * The promise constructor used by default for {@link Observable#toPromise toPromise} and {@link Observable#forEach forEach}\n * methods.\n *\n * @deprecated As of version 8, RxJS will no longer support this sort of injection of a\n * Promise constructor. If you need a Promise implementation other than native promises,\n * please polyfill/patch Promise as you see appropriate. Will be removed in v8.\n */\n Promise?: PromiseConstructorLike;\n\n /**\n * If true, turns on synchronous error rethrowing, which is a deprecated behavior\n * in v6 and higher. This behavior enables bad patterns like wrapping a subscribe\n * call in a try/catch block. It also enables producer interference, a nasty bug\n * where a multicast can be broken for all observers by a downstream consumer with\n * an unhandled error. DO NOT USE THIS FLAG UNLESS IT'S NEEDED TO BUY TIME\n * FOR MIGRATION REASONS.\n *\n * @deprecated As of version 8, RxJS will no longer support synchronous throwing\n * of unhandled errors. All errors will be thrown on a separate call stack to prevent bad\n * behaviors described above. Will be removed in v8.\n */\n useDeprecatedSynchronousErrorHandling: boolean;\n\n /**\n * If true, enables an as-of-yet undocumented feature from v5: The ability to access\n * `unsubscribe()` via `this` context in `next` functions created in observers passed\n * to `subscribe`.\n *\n * This is being removed because the performance was severely problematic, and it could also cause\n * issues when types other than POJOs are passed to subscribe as subscribers, as they will likely have\n * their `this` context overwritten.\n *\n * @deprecated As of version 8, RxJS will no longer support altering the\n * context of next functions provided as part of an observer to Subscribe. Instead,\n * you will have access to a subscription or a signal or token that will allow you to do things like\n * unsubscribe and test closed status. Will be removed in v8.\n */\n useDeprecatedNextContext: boolean;\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetTimeoutFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearTimeoutFunction = (handle: TimerHandle) => void;\n\ninterface TimeoutProvider {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n delegate:\n | {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n }\n | undefined;\n}\n\nexport const timeoutProvider: TimeoutProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setTimeout(handler: () => void, timeout?: number, ...args) {\n const { delegate } = timeoutProvider;\n if (delegate?.setTimeout) {\n return delegate.setTimeout(handler, timeout, ...args);\n }\n return setTimeout(handler, timeout, ...args);\n },\n clearTimeout(handle) {\n const { delegate } = timeoutProvider;\n return (delegate?.clearTimeout || clearTimeout)(handle as any);\n },\n delegate: undefined,\n};\n", "import { config } from '../config';\nimport { timeoutProvider } from '../scheduler/timeoutProvider';\n\n/**\n * Handles an error on another job either with the user-configured {@link onUnhandledError},\n * or by throwing it on that new job so it can be picked up by `window.onerror`, `process.on('error')`, etc.\n *\n * This should be called whenever there is an error that is out-of-band with the subscription\n * or when an error hits a terminal boundary of the subscription and no error handler was provided.\n *\n * @param err the error to report\n */\nexport function reportUnhandledError(err: any) {\n timeoutProvider.setTimeout(() => {\n const { onUnhandledError } = config;\n if (onUnhandledError) {\n // Execute the user-configured error handler.\n onUnhandledError(err);\n } else {\n // Throw so it is picked up by the runtime's uncaught error mechanism.\n throw err;\n }\n });\n}\n", "/* tslint:disable:no-empty */\nexport function noop() { }\n", "import { CompleteNotification, NextNotification, ErrorNotification } from './types';\n\n/**\n * A completion object optimized for memory use and created to be the\n * same \"shape\" as other notifications in v8.\n * @internal\n */\nexport const COMPLETE_NOTIFICATION = (() => createNotification('C', undefined, undefined) as CompleteNotification)();\n\n/**\n * Internal use only. Creates an optimized error notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function errorNotification(error: any): ErrorNotification {\n return createNotification('E', undefined, error) as any;\n}\n\n/**\n * Internal use only. Creates an optimized next notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function nextNotification(value: T) {\n return createNotification('N', value, undefined) as NextNotification;\n}\n\n/**\n * Ensures that all notifications created internally have the same \"shape\" in v8.\n *\n * TODO: This is only exported to support a crazy legacy test in `groupBy`.\n * @internal\n */\nexport function createNotification(kind: 'N' | 'E' | 'C', value: any, error: any) {\n return {\n kind,\n value,\n error,\n };\n}\n", "import { config } from '../config';\n\nlet context: { errorThrown: boolean; error: any } | null = null;\n\n/**\n * Handles dealing with errors for super-gross mode. Creates a context, in which\n * any synchronously thrown errors will be passed to {@link captureError}. Which\n * will record the error such that it will be rethrown after the call back is complete.\n * TODO: Remove in v8\n * @param cb An immediately executed function.\n */\nexport function errorContext(cb: () => void) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n const isRoot = !context;\n if (isRoot) {\n context = { errorThrown: false, error: null };\n }\n cb();\n if (isRoot) {\n const { errorThrown, error } = context!;\n context = null;\n if (errorThrown) {\n throw error;\n }\n }\n } else {\n // This is the general non-deprecated path for everyone that\n // isn't crazy enough to use super-gross mode (useDeprecatedSynchronousErrorHandling)\n cb();\n }\n}\n\n/**\n * Captures errors only in super-gross mode.\n * @param err the error to capture\n */\nexport function captureError(err: any) {\n if (config.useDeprecatedSynchronousErrorHandling && context) {\n context.errorThrown = true;\n context.error = err;\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { Observer, ObservableNotification } from './types';\nimport { isSubscription, Subscription } from './Subscription';\nimport { config } from './config';\nimport { reportUnhandledError } from './util/reportUnhandledError';\nimport { noop } from './util/noop';\nimport { nextNotification, errorNotification, COMPLETE_NOTIFICATION } from './NotificationFactories';\nimport { timeoutProvider } from './scheduler/timeoutProvider';\nimport { captureError } from './util/errorContext';\n\n/**\n * Implements the {@link Observer} interface and extends the\n * {@link Subscription} class. While the {@link Observer} is the public API for\n * consuming the values of an {@link Observable}, all Observers get converted to\n * a Subscriber, in order to provide Subscription-like capabilities such as\n * `unsubscribe`. Subscriber is a common type in RxJS, and crucial for\n * implementing operators, but it is rarely used as a public API.\n */\nexport class Subscriber extends Subscription implements Observer {\n /**\n * A static factory for a Subscriber, given a (potentially partial) definition\n * of an Observer.\n * @param next The `next` callback of an Observer.\n * @param error The `error` callback of an\n * Observer.\n * @param complete The `complete` callback of an\n * Observer.\n * @return A Subscriber wrapping the (partially defined)\n * Observer represented by the given arguments.\n * @deprecated Do not use. Will be removed in v8. There is no replacement for this\n * method, and there is no reason to be creating instances of `Subscriber` directly.\n * If you have a specific use case, please file an issue.\n */\n static create(next?: (x?: T) => void, error?: (e?: any) => void, complete?: () => void): Subscriber {\n return new SafeSubscriber(next, error, complete);\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected isStopped: boolean = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected destination: Subscriber | Observer; // this `any` is the escape hatch to erase extra type param (e.g. R)\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * There is no reason to directly create an instance of Subscriber. This type is exported for typings reasons.\n */\n constructor(destination?: Subscriber | Observer) {\n super();\n if (destination) {\n this.destination = destination;\n // Automatically chain subscriptions together here.\n // if destination is a Subscription, then it is a Subscriber.\n if (isSubscription(destination)) {\n destination.add(this);\n }\n } else {\n this.destination = EMPTY_OBSERVER;\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `next` from\n * the Observable, with a value. The Observable may call this method 0 or more\n * times.\n * @param value The `next` value.\n */\n next(value: T): void {\n if (this.isStopped) {\n handleStoppedNotification(nextNotification(value), this);\n } else {\n this._next(value!);\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `error` from\n * the Observable, with an attached `Error`. Notifies the Observer that\n * the Observable has experienced an error condition.\n * @param err The `error` exception.\n */\n error(err?: any): void {\n if (this.isStopped) {\n handleStoppedNotification(errorNotification(err), this);\n } else {\n this.isStopped = true;\n this._error(err);\n }\n }\n\n /**\n * The {@link Observer} callback to receive a valueless notification of type\n * `complete` from the Observable. Notifies the Observer that the Observable\n * has finished sending push-based notifications.\n */\n complete(): void {\n if (this.isStopped) {\n handleStoppedNotification(COMPLETE_NOTIFICATION, this);\n } else {\n this.isStopped = true;\n this._complete();\n }\n }\n\n unsubscribe(): void {\n if (!this.closed) {\n this.isStopped = true;\n super.unsubscribe();\n this.destination = null!;\n }\n }\n\n protected _next(value: T): void {\n this.destination.next(value);\n }\n\n protected _error(err: any): void {\n try {\n this.destination.error(err);\n } finally {\n this.unsubscribe();\n }\n }\n\n protected _complete(): void {\n try {\n this.destination.complete();\n } finally {\n this.unsubscribe();\n }\n }\n}\n\n/**\n * This bind is captured here because we want to be able to have\n * compatibility with monoid libraries that tend to use a method named\n * `bind`. In particular, a library called Monio requires this.\n */\nconst _bind = Function.prototype.bind;\n\nfunction bind any>(fn: Fn, thisArg: any): Fn {\n return _bind.call(fn, thisArg);\n}\n\n/**\n * Internal optimization only, DO NOT EXPOSE.\n * @internal\n */\nclass ConsumerObserver implements Observer {\n constructor(private partialObserver: Partial>) {}\n\n next(value: T): void {\n const { partialObserver } = this;\n if (partialObserver.next) {\n try {\n partialObserver.next(value);\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n\n error(err: any): void {\n const { partialObserver } = this;\n if (partialObserver.error) {\n try {\n partialObserver.error(err);\n } catch (error) {\n handleUnhandledError(error);\n }\n } else {\n handleUnhandledError(err);\n }\n }\n\n complete(): void {\n const { partialObserver } = this;\n if (partialObserver.complete) {\n try {\n partialObserver.complete();\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n}\n\nexport class SafeSubscriber extends Subscriber {\n constructor(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((e?: any) => void) | null,\n complete?: (() => void) | null\n ) {\n super();\n\n let partialObserver: Partial>;\n if (isFunction(observerOrNext) || !observerOrNext) {\n // The first argument is a function, not an observer. The next\n // two arguments *could* be observers, or they could be empty.\n partialObserver = {\n next: (observerOrNext ?? undefined) as ((value: T) => void) | undefined,\n error: error ?? undefined,\n complete: complete ?? undefined,\n };\n } else {\n // The first argument is a partial observer.\n let context: any;\n if (this && config.useDeprecatedNextContext) {\n // This is a deprecated path that made `this.unsubscribe()` available in\n // next handler functions passed to subscribe. This only exists behind a flag\n // now, as it is *very* slow.\n context = Object.create(observerOrNext);\n context.unsubscribe = () => this.unsubscribe();\n partialObserver = {\n next: observerOrNext.next && bind(observerOrNext.next, context),\n error: observerOrNext.error && bind(observerOrNext.error, context),\n complete: observerOrNext.complete && bind(observerOrNext.complete, context),\n };\n } else {\n // The \"normal\" path. Just use the partial observer directly.\n partialObserver = observerOrNext;\n }\n }\n\n // Wrap the partial observer to ensure it's a full observer, and\n // make sure proper error handling is accounted for.\n this.destination = new ConsumerObserver(partialObserver);\n }\n}\n\nfunction handleUnhandledError(error: any) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n captureError(error);\n } else {\n // Ideal path, we report this as an unhandled error,\n // which is thrown on a new call stack.\n reportUnhandledError(error);\n }\n}\n\n/**\n * An error handler used when no error handler was supplied\n * to the SafeSubscriber -- meaning no error handler was supplied\n * do the `subscribe` call on our observable.\n * @param err The error to handle\n */\nfunction defaultErrorHandler(err: any) {\n throw err;\n}\n\n/**\n * A handler for notifications that cannot be sent to a stopped subscriber.\n * @param notification The notification being sent.\n * @param subscriber The stopped subscriber.\n */\nfunction handleStoppedNotification(notification: ObservableNotification, subscriber: Subscriber) {\n const { onStoppedNotification } = config;\n onStoppedNotification && timeoutProvider.setTimeout(() => onStoppedNotification(notification, subscriber));\n}\n\n/**\n * The observer used as a stub for subscriptions where the user did not\n * pass any arguments to `subscribe`. Comes with the default error handling\n * behavior.\n */\nexport const EMPTY_OBSERVER: Readonly> & { closed: true } = {\n closed: true,\n next: noop,\n error: defaultErrorHandler,\n complete: noop,\n};\n", "/**\n * Symbol.observable or a string \"@@observable\". Used for interop\n *\n * @deprecated We will no longer be exporting this symbol in upcoming versions of RxJS.\n * Instead polyfill and use Symbol.observable directly *or* use https://www.npmjs.com/package/symbol-observable\n */\nexport const observable: string | symbol = (() => (typeof Symbol === 'function' && Symbol.observable) || '@@observable')();\n", "/**\n * This function takes one parameter and just returns it. Simply put,\n * this is like `(x: T): T => x`.\n *\n * ## Examples\n *\n * This is useful in some cases when using things like `mergeMap`\n *\n * ```ts\n * import { interval, take, map, range, mergeMap, identity } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(5));\n *\n * const result$ = source$.pipe(\n * map(i => range(i)),\n * mergeMap(identity) // same as mergeMap(x => x)\n * );\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * Or when you want to selectively apply an operator\n *\n * ```ts\n * import { interval, take, identity } from 'rxjs';\n *\n * const shouldLimit = () => Math.random() < 0.5;\n *\n * const source$ = interval(1000);\n *\n * const result$ = source$.pipe(shouldLimit() ? take(5) : identity);\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * @param x Any value that is returned by this function\n * @returns The value passed as the first parameter to this function\n */\nexport function identity(x: T): T {\n return x;\n}\n", "import { identity } from './identity';\nimport { UnaryFunction } from '../types';\n\nexport function pipe(): typeof identity;\nexport function pipe(fn1: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction, fn3: UnaryFunction): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction,\n ...fns: UnaryFunction[]\n): UnaryFunction;\n\n/**\n * pipe() can be called on one or more functions, each of which can take one argument (\"UnaryFunction\")\n * and uses it to return a value.\n * It returns a function that takes one argument, passes it to the first UnaryFunction, and then\n * passes the result to the next one, passes that result to the next one, and so on. \n */\nexport function pipe(...fns: Array>): UnaryFunction {\n return pipeFromArray(fns);\n}\n\n/** @internal */\nexport function pipeFromArray(fns: Array>): UnaryFunction {\n if (fns.length === 0) {\n return identity as UnaryFunction;\n }\n\n if (fns.length === 1) {\n return fns[0];\n }\n\n return function piped(input: T): R {\n return fns.reduce((prev: any, fn: UnaryFunction) => fn(prev), input as any);\n };\n}\n", "import { Operator } from './Operator';\nimport { SafeSubscriber, Subscriber } from './Subscriber';\nimport { isSubscription, Subscription } from './Subscription';\nimport { TeardownLogic, OperatorFunction, Subscribable, Observer } from './types';\nimport { observable as Symbol_observable } from './symbol/observable';\nimport { pipeFromArray } from './util/pipe';\nimport { config } from './config';\nimport { isFunction } from './util/isFunction';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A representation of any set of values over any amount of time. This is the most basic building block\n * of RxJS.\n */\nexport class Observable implements Subscribable {\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n source: Observable | undefined;\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n operator: Operator | undefined;\n\n /**\n * @param subscribe The function that is called when the Observable is\n * initially subscribed to. This function is given a Subscriber, to which new values\n * can be `next`ed, or an `error` method can be called to raise an error, or\n * `complete` can be called to notify of a successful completion.\n */\n constructor(subscribe?: (this: Observable, subscriber: Subscriber) => TeardownLogic) {\n if (subscribe) {\n this._subscribe = subscribe;\n }\n }\n\n // HACK: Since TypeScript inherits static properties too, we have to\n // fight against TypeScript here so Subject can have a different static create signature\n /**\n * Creates a new Observable by calling the Observable constructor\n * @param subscribe the subscriber function to be passed to the Observable constructor\n * @return A new observable.\n * @deprecated Use `new Observable()` instead. Will be removed in v8.\n */\n static create: (...args: any[]) => any = (subscribe?: (subscriber: Subscriber) => TeardownLogic) => {\n return new Observable(subscribe);\n };\n\n /**\n * Creates a new Observable, with this Observable instance as the source, and the passed\n * operator defined as the new observable's operator.\n * @param operator the operator defining the operation to take on the observable\n * @return A new observable with the Operator applied.\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * If you have implemented an operator using `lift`, it is recommended that you create an\n * operator by simply returning `new Observable()` directly. See \"Creating new operators from\n * scratch\" section here: https://rxjs.dev/guide/operators\n */\n lift(operator?: Operator): Observable {\n const observable = new Observable();\n observable.source = this;\n observable.operator = operator;\n return observable;\n }\n\n subscribe(observerOrNext?: Partial> | ((value: T) => void)): Subscription;\n /** @deprecated Instead of passing separate callback arguments, use an observer argument. Signatures taking separate callback arguments will be removed in v8. Details: https://rxjs.dev/deprecations/subscribe-arguments */\n subscribe(next?: ((value: T) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription;\n /**\n * Invokes an execution of an Observable and registers Observer handlers for notifications it will emit.\n *\n * Use it when you have all these Observables, but still nothing is happening.\n *\n * `subscribe` is not a regular operator, but a method that calls Observable's internal `subscribe` function. It\n * might be for example a function that you passed to Observable's constructor, but most of the time it is\n * a library implementation, which defines what will be emitted by an Observable, and when it be will emitted. This means\n * that calling `subscribe` is actually the moment when Observable starts its work, not when it is created, as it is often\n * the thought.\n *\n * Apart from starting the execution of an Observable, this method allows you to listen for values\n * that an Observable emits, as well as for when it completes or errors. You can achieve this in two\n * of the following ways.\n *\n * The first way is creating an object that implements {@link Observer} interface. It should have methods\n * defined by that interface, but note that it should be just a regular JavaScript object, which you can create\n * yourself in any way you want (ES6 class, classic function constructor, object literal etc.). In particular, do\n * not attempt to use any RxJS implementation details to create Observers - you don't need them. Remember also\n * that your object does not have to implement all methods. If you find yourself creating a method that doesn't\n * do anything, you can simply omit it. Note however, if the `error` method is not provided and an error happens,\n * it will be thrown asynchronously. Errors thrown asynchronously cannot be caught using `try`/`catch`. Instead,\n * use the {@link onUnhandledError} configuration option or use a runtime handler (like `window.onerror` or\n * `process.on('error)`) to be notified of unhandled errors. Because of this, it's recommended that you provide\n * an `error` method to avoid missing thrown errors.\n *\n * The second way is to give up on Observer object altogether and simply provide callback functions in place of its methods.\n * This means you can provide three functions as arguments to `subscribe`, where the first function is equivalent\n * of a `next` method, the second of an `error` method and the third of a `complete` method. Just as in case of an Observer,\n * if you do not need to listen for something, you can omit a function by passing `undefined` or `null`,\n * since `subscribe` recognizes these functions by where they were placed in function call. When it comes\n * to the `error` function, as with an Observer, if not provided, errors emitted by an Observable will be thrown asynchronously.\n *\n * You can, however, subscribe with no parameters at all. This may be the case where you're not interested in terminal events\n * and you also handled emissions internally by using operators (e.g. using `tap`).\n *\n * Whichever style of calling `subscribe` you use, in both cases it returns a Subscription object.\n * This object allows you to call `unsubscribe` on it, which in turn will stop the work that an Observable does and will clean\n * up all resources that an Observable used. Note that cancelling a subscription will not call `complete` callback\n * provided to `subscribe` function, which is reserved for a regular completion signal that comes from an Observable.\n *\n * Remember that callbacks provided to `subscribe` are not guaranteed to be called asynchronously.\n * It is an Observable itself that decides when these functions will be called. For example {@link of}\n * by default emits all its values synchronously. Always check documentation for how given Observable\n * will behave when subscribed and if its default behavior can be modified with a `scheduler`.\n *\n * #### Examples\n *\n * Subscribe with an {@link guide/observer Observer}\n *\n * ```ts\n * import { of } from 'rxjs';\n *\n * const sumObserver = {\n * sum: 0,\n * next(value) {\n * console.log('Adding: ' + value);\n * this.sum = this.sum + value;\n * },\n * error() {\n * // We actually could just remove this method,\n * // since we do not really care about errors right now.\n * },\n * complete() {\n * console.log('Sum equals: ' + this.sum);\n * }\n * };\n *\n * of(1, 2, 3) // Synchronously emits 1, 2, 3 and then completes.\n * .subscribe(sumObserver);\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Subscribe with functions ({@link deprecations/subscribe-arguments deprecated})\n *\n * ```ts\n * import { of } from 'rxjs'\n *\n * let sum = 0;\n *\n * of(1, 2, 3).subscribe(\n * value => {\n * console.log('Adding: ' + value);\n * sum = sum + value;\n * },\n * undefined,\n * () => console.log('Sum equals: ' + sum)\n * );\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Cancel a subscription\n *\n * ```ts\n * import { interval } from 'rxjs';\n *\n * const subscription = interval(1000).subscribe({\n * next(num) {\n * console.log(num)\n * },\n * complete() {\n * // Will not be called, even when cancelling subscription.\n * console.log('completed!');\n * }\n * });\n *\n * setTimeout(() => {\n * subscription.unsubscribe();\n * console.log('unsubscribed!');\n * }, 2500);\n *\n * // Logs:\n * // 0 after 1s\n * // 1 after 2s\n * // 'unsubscribed!' after 2.5s\n * ```\n *\n * @param observerOrNext Either an {@link Observer} with some or all callback methods,\n * or the `next` handler that is called for each value emitted from the subscribed Observable.\n * @param error A handler for a terminal event resulting from an error. If no error handler is provided,\n * the error will be thrown asynchronously as unhandled.\n * @param complete A handler for a terminal event resulting from successful completion.\n * @return A subscription reference to the registered handlers.\n */\n subscribe(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((error: any) => void) | null,\n complete?: (() => void) | null\n ): Subscription {\n const subscriber = isSubscriber(observerOrNext) ? observerOrNext : new SafeSubscriber(observerOrNext, error, complete);\n\n errorContext(() => {\n const { operator, source } = this;\n subscriber.add(\n operator\n ? // We're dealing with a subscription in the\n // operator chain to one of our lifted operators.\n operator.call(subscriber, source)\n : source\n ? // If `source` has a value, but `operator` does not, something that\n // had intimate knowledge of our API, like our `Subject`, must have\n // set it. We're going to just call `_subscribe` directly.\n this._subscribe(subscriber)\n : // In all other cases, we're likely wrapping a user-provided initializer\n // function, so we need to catch errors and handle them appropriately.\n this._trySubscribe(subscriber)\n );\n });\n\n return subscriber;\n }\n\n /** @internal */\n protected _trySubscribe(sink: Subscriber): TeardownLogic {\n try {\n return this._subscribe(sink);\n } catch (err) {\n // We don't need to return anything in this case,\n // because it's just going to try to `add()` to a subscription\n // above.\n sink.error(err);\n }\n }\n\n /**\n * Used as a NON-CANCELLABLE means of subscribing to an observable, for use with\n * APIs that expect promises, like `async/await`. You cannot unsubscribe from this.\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * #### Example\n *\n * ```ts\n * import { interval, take } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(4));\n *\n * async function getTotal() {\n * let total = 0;\n *\n * await source$.forEach(value => {\n * total += value;\n * console.log('observable -> ' + value);\n * });\n *\n * return total;\n * }\n *\n * getTotal().then(\n * total => console.log('Total: ' + total)\n * );\n *\n * // Expected:\n * // 'observable -> 0'\n * // 'observable -> 1'\n * // 'observable -> 2'\n * // 'observable -> 3'\n * // 'Total: 6'\n * ```\n *\n * @param next A handler for each value emitted by the observable.\n * @return A promise that either resolves on observable completion or\n * rejects with the handled error.\n */\n forEach(next: (value: T) => void): Promise;\n\n /**\n * @param next a handler for each value emitted by the observable\n * @param promiseCtor a constructor function used to instantiate the Promise\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n * @deprecated Passing a Promise constructor will no longer be available\n * in upcoming versions of RxJS. This is because it adds weight to the library, for very\n * little benefit. If you need this functionality, it is recommended that you either\n * polyfill Promise, or you create an adapter to convert the returned native promise\n * to whatever promise implementation you wanted. Will be removed in v8.\n */\n forEach(next: (value: T) => void, promiseCtor: PromiseConstructorLike): Promise;\n\n forEach(next: (value: T) => void, promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n const subscriber = new SafeSubscriber({\n next: (value) => {\n try {\n next(value);\n } catch (err) {\n reject(err);\n subscriber.unsubscribe();\n }\n },\n error: reject,\n complete: resolve,\n });\n this.subscribe(subscriber);\n }) as Promise;\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): TeardownLogic {\n return this.source?.subscribe(subscriber);\n }\n\n /**\n * An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable\n * @return This instance of the observable.\n */\n [Symbol_observable]() {\n return this;\n }\n\n /* tslint:disable:max-line-length */\n pipe(): Observable;\n pipe(op1: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction,\n ...operations: OperatorFunction[]\n ): Observable;\n /* tslint:enable:max-line-length */\n\n /**\n * Used to stitch together functional operators into a chain.\n *\n * ## Example\n *\n * ```ts\n * import { interval, filter, map, scan } from 'rxjs';\n *\n * interval(1000)\n * .pipe(\n * filter(x => x % 2 === 0),\n * map(x => x + x),\n * scan((acc, x) => acc + x)\n * )\n * .subscribe(x => console.log(x));\n * ```\n *\n * @return The Observable result of all the operators having been called\n * in the order they were passed in.\n */\n pipe(...operations: OperatorFunction[]): Observable {\n return pipeFromArray(operations)(this);\n }\n\n /* tslint:disable:max-line-length */\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: typeof Promise): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: PromiseConstructorLike): Promise;\n /* tslint:enable:max-line-length */\n\n /**\n * Subscribe to this Observable and get a Promise resolving on\n * `complete` with the last emission (if any).\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * @param [promiseCtor] a constructor function used to instantiate\n * the Promise\n * @return A Promise that resolves with the last value emit, or\n * rejects on an error. If there were no emissions, Promise\n * resolves with undefined.\n * @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise\n */\n toPromise(promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n let value: T | undefined;\n this.subscribe(\n (x: T) => (value = x),\n (err: any) => reject(err),\n () => resolve(value)\n );\n }) as Promise;\n }\n}\n\n/**\n * Decides between a passed promise constructor from consuming code,\n * A default configured promise constructor, and the native promise\n * constructor and returns it. If nothing can be found, it will throw\n * an error.\n * @param promiseCtor The optional promise constructor to passed by consuming code\n */\nfunction getPromiseCtor(promiseCtor: PromiseConstructorLike | undefined) {\n return promiseCtor ?? config.Promise ?? Promise;\n}\n\nfunction isObserver(value: any): value is Observer {\n return value && isFunction(value.next) && isFunction(value.error) && isFunction(value.complete);\n}\n\nfunction isSubscriber(value: any): value is Subscriber {\n return (value && value instanceof Subscriber) || (isObserver(value) && isSubscription(value));\n}\n", "import { Observable } from '../Observable';\nimport { Subscriber } from '../Subscriber';\nimport { OperatorFunction } from '../types';\nimport { isFunction } from './isFunction';\n\n/**\n * Used to determine if an object is an Observable with a lift function.\n */\nexport function hasLift(source: any): source is { lift: InstanceType['lift'] } {\n return isFunction(source?.lift);\n}\n\n/**\n * Creates an `OperatorFunction`. Used to define operators throughout the library in a concise way.\n * @param init The logic to connect the liftedSource to the subscriber at the moment of subscription.\n */\nexport function operate(\n init: (liftedSource: Observable, subscriber: Subscriber) => (() => void) | void\n): OperatorFunction {\n return (source: Observable) => {\n if (hasLift(source)) {\n return source.lift(function (this: Subscriber, liftedSource: Observable) {\n try {\n return init(liftedSource, this);\n } catch (err) {\n this.error(err);\n }\n });\n }\n throw new TypeError('Unable to lift unknown Observable type');\n };\n}\n", "import { Subscriber } from '../Subscriber';\n\n/**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional teardown logic here. This will only be called on teardown if the\n * subscriber itself is not already closed. This is called after all other teardown logic is executed.\n */\nexport function createOperatorSubscriber(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n onFinalize?: () => void\n): Subscriber {\n return new OperatorSubscriber(destination, onNext, onComplete, onError, onFinalize);\n}\n\n/**\n * A generic helper for allowing operators to be created with a Subscriber and\n * use closures to capture necessary state from the operator function itself.\n */\nexport class OperatorSubscriber extends Subscriber {\n /**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional finalization logic here. This will only be called on finalization if the\n * subscriber itself is not already closed. This is called after all other finalization logic is executed.\n * @param shouldUnsubscribe An optional check to see if an unsubscribe call should truly unsubscribe.\n * NOTE: This currently **ONLY** exists to support the strange behavior of {@link groupBy}, where unsubscription\n * to the resulting observable does not actually disconnect from the source if there are active subscriptions\n * to any grouped observable. (DO NOT EXPOSE OR USE EXTERNALLY!!!)\n */\n constructor(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n private onFinalize?: () => void,\n private shouldUnsubscribe?: () => boolean\n ) {\n // It's important - for performance reasons - that all of this class's\n // members are initialized and that they are always initialized in the same\n // order. This will ensure that all OperatorSubscriber instances have the\n // same hidden class in V8. This, in turn, will help keep the number of\n // hidden classes involved in property accesses within the base class as\n // low as possible. If the number of hidden classes involved exceeds four,\n // the property accesses will become megamorphic and performance penalties\n // will be incurred - i.e. inline caches won't be used.\n //\n // The reasons for ensuring all instances have the same hidden class are\n // further discussed in this blog post from Benedikt Meurer:\n // https://benediktmeurer.de/2018/03/23/impact-of-polymorphism-on-component-based-frameworks-like-react/\n super(destination);\n this._next = onNext\n ? function (this: OperatorSubscriber, value: T) {\n try {\n onNext(value);\n } catch (err) {\n destination.error(err);\n }\n }\n : super._next;\n this._error = onError\n ? function (this: OperatorSubscriber, err: any) {\n try {\n onError(err);\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._error;\n this._complete = onComplete\n ? function (this: OperatorSubscriber) {\n try {\n onComplete();\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._complete;\n }\n\n unsubscribe() {\n if (!this.shouldUnsubscribe || this.shouldUnsubscribe()) {\n const { closed } = this;\n super.unsubscribe();\n // Execute additional teardown if we have any and we didn't already do so.\n !closed && this.onFinalize?.();\n }\n }\n}\n", "import { Subscription } from '../Subscription';\n\ninterface AnimationFrameProvider {\n schedule(callback: FrameRequestCallback): Subscription;\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n delegate:\n | {\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n }\n | undefined;\n}\n\nexport const animationFrameProvider: AnimationFrameProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n schedule(callback) {\n let request = requestAnimationFrame;\n let cancel: typeof cancelAnimationFrame | undefined = cancelAnimationFrame;\n const { delegate } = animationFrameProvider;\n if (delegate) {\n request = delegate.requestAnimationFrame;\n cancel = delegate.cancelAnimationFrame;\n }\n const handle = request((timestamp) => {\n // Clear the cancel function. The request has been fulfilled, so\n // attempting to cancel the request upon unsubscription would be\n // pointless.\n cancel = undefined;\n callback(timestamp);\n });\n return new Subscription(() => cancel?.(handle));\n },\n requestAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.requestAnimationFrame || requestAnimationFrame)(...args);\n },\n cancelAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.cancelAnimationFrame || cancelAnimationFrame)(...args);\n },\n delegate: undefined,\n};\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface ObjectUnsubscribedError extends Error {}\n\nexport interface ObjectUnsubscribedErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (): ObjectUnsubscribedError;\n}\n\n/**\n * An error thrown when an action is invalid because the object has been\n * unsubscribed.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n *\n * @class ObjectUnsubscribedError\n */\nexport const ObjectUnsubscribedError: ObjectUnsubscribedErrorCtor = createErrorClass(\n (_super) =>\n function ObjectUnsubscribedErrorImpl(this: any) {\n _super(this);\n this.name = 'ObjectUnsubscribedError';\n this.message = 'object unsubscribed';\n }\n);\n", "import { Operator } from './Operator';\nimport { Observable } from './Observable';\nimport { Subscriber } from './Subscriber';\nimport { Subscription, EMPTY_SUBSCRIPTION } from './Subscription';\nimport { Observer, SubscriptionLike, TeardownLogic } from './types';\nimport { ObjectUnsubscribedError } from './util/ObjectUnsubscribedError';\nimport { arrRemove } from './util/arrRemove';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A Subject is a special type of Observable that allows values to be\n * multicasted to many Observers. Subjects are like EventEmitters.\n *\n * Every Subject is an Observable and an Observer. You can subscribe to a\n * Subject, and you can call next to feed values as well as error and complete.\n */\nexport class Subject extends Observable implements SubscriptionLike {\n closed = false;\n\n private currentObservers: Observer[] | null = null;\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n observers: Observer[] = [];\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n isStopped = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n hasError = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n thrownError: any = null;\n\n /**\n * Creates a \"subject\" by basically gluing an observer to an observable.\n *\n * @deprecated Recommended you do not use. Will be removed at some point in the future. Plans for replacement still under discussion.\n */\n static create: (...args: any[]) => any = (destination: Observer, source: Observable): AnonymousSubject => {\n return new AnonymousSubject(destination, source);\n };\n\n constructor() {\n // NOTE: This must be here to obscure Observable's constructor.\n super();\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n lift(operator: Operator): Observable {\n const subject = new AnonymousSubject(this, this);\n subject.operator = operator as any;\n return subject as any;\n }\n\n /** @internal */\n protected _throwIfClosed() {\n if (this.closed) {\n throw new ObjectUnsubscribedError();\n }\n }\n\n next(value: T) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n if (!this.currentObservers) {\n this.currentObservers = Array.from(this.observers);\n }\n for (const observer of this.currentObservers) {\n observer.next(value);\n }\n }\n });\n }\n\n error(err: any) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.hasError = this.isStopped = true;\n this.thrownError = err;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.error(err);\n }\n }\n });\n }\n\n complete() {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.isStopped = true;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.complete();\n }\n }\n });\n }\n\n unsubscribe() {\n this.isStopped = this.closed = true;\n this.observers = this.currentObservers = null!;\n }\n\n get observed() {\n return this.observers?.length > 0;\n }\n\n /** @internal */\n protected _trySubscribe(subscriber: Subscriber): TeardownLogic {\n this._throwIfClosed();\n return super._trySubscribe(subscriber);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._checkFinalizedStatuses(subscriber);\n return this._innerSubscribe(subscriber);\n }\n\n /** @internal */\n protected _innerSubscribe(subscriber: Subscriber) {\n const { hasError, isStopped, observers } = this;\n if (hasError || isStopped) {\n return EMPTY_SUBSCRIPTION;\n }\n this.currentObservers = null;\n observers.push(subscriber);\n return new Subscription(() => {\n this.currentObservers = null;\n arrRemove(observers, subscriber);\n });\n }\n\n /** @internal */\n protected _checkFinalizedStatuses(subscriber: Subscriber) {\n const { hasError, thrownError, isStopped } = this;\n if (hasError) {\n subscriber.error(thrownError);\n } else if (isStopped) {\n subscriber.complete();\n }\n }\n\n /**\n * Creates a new Observable with this Subject as the source. You can do this\n * to create custom Observer-side logic of the Subject and conceal it from\n * code that uses the Observable.\n * @return Observable that this Subject casts to.\n */\n asObservable(): Observable {\n const observable: any = new Observable();\n observable.source = this;\n return observable;\n }\n}\n\nexport class AnonymousSubject extends Subject {\n constructor(\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n public destination?: Observer,\n source?: Observable\n ) {\n super();\n this.source = source;\n }\n\n next(value: T) {\n this.destination?.next?.(value);\n }\n\n error(err: any) {\n this.destination?.error?.(err);\n }\n\n complete() {\n this.destination?.complete?.();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n return this.source?.subscribe(subscriber) ?? EMPTY_SUBSCRIPTION;\n }\n}\n", "import { Subject } from './Subject';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\n\n/**\n * A variant of Subject that requires an initial value and emits its current\n * value whenever it is subscribed to.\n */\nexport class BehaviorSubject extends Subject {\n constructor(private _value: T) {\n super();\n }\n\n get value(): T {\n return this.getValue();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n const subscription = super._subscribe(subscriber);\n !subscription.closed && subscriber.next(this._value);\n return subscription;\n }\n\n getValue(): T {\n const { hasError, thrownError, _value } = this;\n if (hasError) {\n throw thrownError;\n }\n this._throwIfClosed();\n return _value;\n }\n\n next(value: T): void {\n super.next((this._value = value));\n }\n}\n", "import { TimestampProvider } from '../types';\n\ninterface DateTimestampProvider extends TimestampProvider {\n delegate: TimestampProvider | undefined;\n}\n\nexport const dateTimestampProvider: DateTimestampProvider = {\n now() {\n // Use the variable rather than `this` so that the function can be called\n // without being bound to the provider.\n return (dateTimestampProvider.delegate || Date).now();\n },\n delegate: undefined,\n};\n", "import { Subject } from './Subject';\nimport { TimestampProvider } from './types';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * A variant of {@link Subject} that \"replays\" old values to new subscribers by emitting them when they first subscribe.\n *\n * `ReplaySubject` has an internal buffer that will store a specified number of values that it has observed. Like `Subject`,\n * `ReplaySubject` \"observes\" values by having them passed to its `next` method. When it observes a value, it will store that\n * value for a time determined by the configuration of the `ReplaySubject`, as passed to its constructor.\n *\n * When a new subscriber subscribes to the `ReplaySubject` instance, it will synchronously emit all values in its buffer in\n * a First-In-First-Out (FIFO) manner. The `ReplaySubject` will also complete, if it has observed completion; and it will\n * error if it has observed an error.\n *\n * There are two main configuration items to be concerned with:\n *\n * 1. `bufferSize` - This will determine how many items are stored in the buffer, defaults to infinite.\n * 2. `windowTime` - The amount of time to hold a value in the buffer before removing it from the buffer.\n *\n * Both configurations may exist simultaneously. So if you would like to buffer a maximum of 3 values, as long as the values\n * are less than 2 seconds old, you could do so with a `new ReplaySubject(3, 2000)`.\n *\n * ### Differences with BehaviorSubject\n *\n * `BehaviorSubject` is similar to `new ReplaySubject(1)`, with a couple of exceptions:\n *\n * 1. `BehaviorSubject` comes \"primed\" with a single value upon construction.\n * 2. `ReplaySubject` will replay values, even after observing an error, where `BehaviorSubject` will not.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n * @see {@link shareReplay}\n */\nexport class ReplaySubject extends Subject {\n private _buffer: (T | number)[] = [];\n private _infiniteTimeWindow = true;\n\n /**\n * @param _bufferSize The size of the buffer to replay on subscription\n * @param _windowTime The amount of time the buffered items will stay buffered\n * @param _timestampProvider An object with a `now()` method that provides the current timestamp. This is used to\n * calculate the amount of time something has been buffered.\n */\n constructor(\n private _bufferSize = Infinity,\n private _windowTime = Infinity,\n private _timestampProvider: TimestampProvider = dateTimestampProvider\n ) {\n super();\n this._infiniteTimeWindow = _windowTime === Infinity;\n this._bufferSize = Math.max(1, _bufferSize);\n this._windowTime = Math.max(1, _windowTime);\n }\n\n next(value: T): void {\n const { isStopped, _buffer, _infiniteTimeWindow, _timestampProvider, _windowTime } = this;\n if (!isStopped) {\n _buffer.push(value);\n !_infiniteTimeWindow && _buffer.push(_timestampProvider.now() + _windowTime);\n }\n this._trimBuffer();\n super.next(value);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._trimBuffer();\n\n const subscription = this._innerSubscribe(subscriber);\n\n const { _infiniteTimeWindow, _buffer } = this;\n // We use a copy here, so reentrant code does not mutate our array while we're\n // emitting it to a new subscriber.\n const copy = _buffer.slice();\n for (let i = 0; i < copy.length && !subscriber.closed; i += _infiniteTimeWindow ? 1 : 2) {\n subscriber.next(copy[i] as T);\n }\n\n this._checkFinalizedStatuses(subscriber);\n\n return subscription;\n }\n\n private _trimBuffer() {\n const { _bufferSize, _timestampProvider, _buffer, _infiniteTimeWindow } = this;\n // If we don't have an infinite buffer size, and we're over the length,\n // use splice to truncate the old buffer values off. Note that we have to\n // double the size for instances where we're not using an infinite time window\n // because we're storing the values and the timestamps in the same array.\n const adjustedBufferSize = (_infiniteTimeWindow ? 1 : 2) * _bufferSize;\n _bufferSize < Infinity && adjustedBufferSize < _buffer.length && _buffer.splice(0, _buffer.length - adjustedBufferSize);\n\n // Now, if we're not in an infinite time window, remove all values where the time is\n // older than what is allowed.\n if (!_infiniteTimeWindow) {\n const now = _timestampProvider.now();\n let last = 0;\n // Search the array for the first timestamp that isn't expired and\n // truncate the buffer up to that point.\n for (let i = 1; i < _buffer.length && (_buffer[i] as number) <= now; i += 2) {\n last = i;\n }\n last && _buffer.splice(0, last + 1);\n }\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Subscription } from '../Subscription';\nimport { SchedulerAction } from '../types';\n\n/**\n * A unit of work to be executed in a `scheduler`. An action is typically\n * created from within a {@link SchedulerLike} and an RxJS user does not need to concern\n * themselves about creating and manipulating an Action.\n *\n * ```ts\n * class Action extends Subscription {\n * new (scheduler: Scheduler, work: (state?: T) => void);\n * schedule(state?: T, delay: number = 0): Subscription;\n * }\n * ```\n */\nexport class Action extends Subscription {\n constructor(scheduler: Scheduler, work: (this: SchedulerAction, state?: T) => void) {\n super();\n }\n /**\n * Schedules this action on its parent {@link SchedulerLike} for execution. May be passed\n * some context object, `state`. May happen at some point in the future,\n * according to the `delay` parameter, if specified.\n * @param state Some contextual data that the `work` function uses when called by the\n * Scheduler.\n * @param delay Time to wait before executing the work, where the time unit is implicit\n * and defined by the Scheduler.\n * @return A subscription in order to be able to unsubscribe the scheduled work.\n */\n public schedule(state?: T, delay: number = 0): Subscription {\n return this;\n }\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetIntervalFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearIntervalFunction = (handle: TimerHandle) => void;\n\ninterface IntervalProvider {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n delegate:\n | {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n }\n | undefined;\n}\n\nexport const intervalProvider: IntervalProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setInterval(handler: () => void, timeout?: number, ...args) {\n const { delegate } = intervalProvider;\n if (delegate?.setInterval) {\n return delegate.setInterval(handler, timeout, ...args);\n }\n return setInterval(handler, timeout, ...args);\n },\n clearInterval(handle) {\n const { delegate } = intervalProvider;\n return (delegate?.clearInterval || clearInterval)(handle as any);\n },\n delegate: undefined,\n};\n", "import { Action } from './Action';\nimport { SchedulerAction } from '../types';\nimport { Subscription } from '../Subscription';\nimport { AsyncScheduler } from './AsyncScheduler';\nimport { intervalProvider } from './intervalProvider';\nimport { arrRemove } from '../util/arrRemove';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncAction extends Action {\n public id: TimerHandle | undefined;\n public state?: T;\n // @ts-ignore: Property has no initializer and is not definitely assigned\n public delay: number;\n protected pending: boolean = false;\n\n constructor(protected scheduler: AsyncScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (this.closed) {\n return this;\n }\n\n // Always replace the current state with the new state.\n this.state = state;\n\n const id = this.id;\n const scheduler = this.scheduler;\n\n //\n // Important implementation note:\n //\n // Actions only execute once by default, unless rescheduled from within the\n // scheduled callback. This allows us to implement single and repeat\n // actions via the same code path, without adding API surface area, as well\n // as mimic traditional recursion but across asynchronous boundaries.\n //\n // However, JS runtimes and timers distinguish between intervals achieved by\n // serial `setTimeout` calls vs. a single `setInterval` call. An interval of\n // serial `setTimeout` calls can be individually delayed, which delays\n // scheduling the next `setTimeout`, and so on. `setInterval` attempts to\n // guarantee the interval callback will be invoked more precisely to the\n // interval period, regardless of load.\n //\n // Therefore, we use `setInterval` to schedule single and repeat actions.\n // If the action reschedules itself with the same delay, the interval is not\n // canceled. If the action doesn't reschedule, or reschedules with a\n // different delay, the interval will be canceled after scheduled callback\n // execution.\n //\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, delay);\n }\n\n // Set the pending flag indicating that this action has been scheduled, or\n // has recursively rescheduled itself.\n this.pending = true;\n\n this.delay = delay;\n // If this action has already an async Id, don't request a new one.\n this.id = this.id ?? this.requestAsyncId(scheduler, this.id, delay);\n\n return this;\n }\n\n protected requestAsyncId(scheduler: AsyncScheduler, _id?: TimerHandle, delay: number = 0): TimerHandle {\n return intervalProvider.setInterval(scheduler.flush.bind(scheduler, this), delay);\n }\n\n protected recycleAsyncId(_scheduler: AsyncScheduler, id?: TimerHandle, delay: number | null = 0): TimerHandle | undefined {\n // If this action is rescheduled with the same delay time, don't clear the interval id.\n if (delay != null && this.delay === delay && this.pending === false) {\n return id;\n }\n // Otherwise, if the action's delay time is different from the current delay,\n // or the action has been rescheduled before it's executed, clear the interval id\n if (id != null) {\n intervalProvider.clearInterval(id);\n }\n\n return undefined;\n }\n\n /**\n * Immediately executes this action and the `work` it contains.\n */\n public execute(state: T, delay: number): any {\n if (this.closed) {\n return new Error('executing a cancelled action');\n }\n\n this.pending = false;\n const error = this._execute(state, delay);\n if (error) {\n return error;\n } else if (this.pending === false && this.id != null) {\n // Dequeue if the action didn't reschedule itself. Don't call\n // unsubscribe(), because the action could reschedule later.\n // For example:\n // ```\n // scheduler.schedule(function doWork(counter) {\n // /* ... I'm a busy worker bee ... */\n // var originalAction = this;\n // /* wait 100ms before rescheduling the action */\n // setTimeout(function () {\n // originalAction.schedule(counter + 1);\n // }, 100);\n // }, 1000);\n // ```\n this.id = this.recycleAsyncId(this.scheduler, this.id, null);\n }\n }\n\n protected _execute(state: T, _delay: number): any {\n let errored: boolean = false;\n let errorValue: any;\n try {\n this.work(state);\n } catch (e) {\n errored = true;\n // HACK: Since code elsewhere is relying on the \"truthiness\" of the\n // return here, we can't have it return \"\" or 0 or false.\n // TODO: Clean this up when we refactor schedulers mid-version-8 or so.\n errorValue = e ? e : new Error('Scheduled action threw falsy error');\n }\n if (errored) {\n this.unsubscribe();\n return errorValue;\n }\n }\n\n unsubscribe() {\n if (!this.closed) {\n const { id, scheduler } = this;\n const { actions } = scheduler;\n\n this.work = this.state = this.scheduler = null!;\n this.pending = false;\n\n arrRemove(actions, this);\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, null);\n }\n\n this.delay = null!;\n super.unsubscribe();\n }\n }\n}\n", "import { Action } from './scheduler/Action';\nimport { Subscription } from './Subscription';\nimport { SchedulerLike, SchedulerAction } from './types';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * An execution context and a data structure to order tasks and schedule their\n * execution. Provides a notion of (potentially virtual) time, through the\n * `now()` getter method.\n *\n * Each unit of work in a Scheduler is called an `Action`.\n *\n * ```ts\n * class Scheduler {\n * now(): number;\n * schedule(work, delay?, state?): Subscription;\n * }\n * ```\n *\n * @deprecated Scheduler is an internal implementation detail of RxJS, and\n * should not be used directly. Rather, create your own class and implement\n * {@link SchedulerLike}. Will be made internal in v8.\n */\nexport class Scheduler implements SchedulerLike {\n public static now: () => number = dateTimestampProvider.now;\n\n constructor(private schedulerActionCtor: typeof Action, now: () => number = Scheduler.now) {\n this.now = now;\n }\n\n /**\n * A getter method that returns a number representing the current time\n * (at the time this function was called) according to the scheduler's own\n * internal clock.\n * @return A number that represents the current time. May or may not\n * have a relation to wall-clock time. May or may not refer to a time unit\n * (e.g. milliseconds).\n */\n public now: () => number;\n\n /**\n * Schedules a function, `work`, for execution. May happen at some point in\n * the future, according to the `delay` parameter, if specified. May be passed\n * some context object, `state`, which will be passed to the `work` function.\n *\n * The given arguments will be processed an stored as an Action object in a\n * queue of actions.\n *\n * @param work A function representing a task, or some unit of work to be\n * executed by the Scheduler.\n * @param delay Time to wait before executing the work, where the time unit is\n * implicit and defined by the Scheduler itself.\n * @param state Some contextual data that the `work` function uses when called\n * by the Scheduler.\n * @return A subscription in order to be able to unsubscribe the scheduled work.\n */\n public schedule(work: (this: SchedulerAction, state?: T) => void, delay: number = 0, state?: T): Subscription {\n return new this.schedulerActionCtor(this, work).schedule(state, delay);\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Action } from './Action';\nimport { AsyncAction } from './AsyncAction';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncScheduler extends Scheduler {\n public actions: Array> = [];\n /**\n * A flag to indicate whether the Scheduler is currently executing a batch of\n * queued actions.\n * @internal\n */\n public _active: boolean = false;\n /**\n * An internal ID used to track the latest asynchronous task such as those\n * coming from `setTimeout`, `setInterval`, `requestAnimationFrame`, and\n * others.\n * @internal\n */\n public _scheduled: TimerHandle | undefined;\n\n constructor(SchedulerAction: typeof Action, now: () => number = Scheduler.now) {\n super(SchedulerAction, now);\n }\n\n public flush(action: AsyncAction): void {\n const { actions } = this;\n\n if (this._active) {\n actions.push(action);\n return;\n }\n\n let error: any;\n this._active = true;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions.shift()!)); // exhaust the scheduler queue\n\n this._active = false;\n\n if (error) {\n while ((action = actions.shift()!)) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\n/**\n *\n * Async Scheduler\n *\n * Schedule task as if you used setTimeout(task, duration)\n *\n * `async` scheduler schedules tasks asynchronously, by putting them on the JavaScript\n * event loop queue. It is best used to delay tasks in time or to schedule tasks repeating\n * in intervals.\n *\n * If you just want to \"defer\" task, that is to perform it right after currently\n * executing synchronous code ends (commonly achieved by `setTimeout(deferredTask, 0)`),\n * better choice will be the {@link asapScheduler} scheduler.\n *\n * ## Examples\n * Use async scheduler to delay task\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * const task = () => console.log('it works!');\n *\n * asyncScheduler.schedule(task, 2000);\n *\n * // After 2 seconds logs:\n * // \"it works!\"\n * ```\n *\n * Use async scheduler to repeat task in intervals\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * function task(state) {\n * console.log(state);\n * this.schedule(state + 1, 1000); // `this` references currently executing Action,\n * // which we reschedule with new state and delay\n * }\n *\n * asyncScheduler.schedule(task, 3000, 0);\n *\n * // Logs:\n * // 0 after 3s\n * // 1 after 4s\n * // 2 after 5s\n * // 3 after 6s\n * ```\n */\n\nexport const asyncScheduler = new AsyncScheduler(AsyncAction);\n\n/**\n * @deprecated Renamed to {@link asyncScheduler}. Will be removed in v8.\n */\nexport const async = asyncScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { Subscription } from '../Subscription';\nimport { QueueScheduler } from './QueueScheduler';\nimport { SchedulerAction } from '../types';\nimport { TimerHandle } from './timerHandle';\n\nexport class QueueAction extends AsyncAction {\n constructor(protected scheduler: QueueScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (delay > 0) {\n return super.schedule(state, delay);\n }\n this.delay = delay;\n this.state = state;\n this.scheduler.flush(this);\n return this;\n }\n\n public execute(state: T, delay: number): any {\n return delay > 0 || this.closed ? super.execute(state, delay) : this._execute(state, delay);\n }\n\n protected requestAsyncId(scheduler: QueueScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n\n if ((delay != null && delay > 0) || (delay == null && this.delay > 0)) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n\n // Otherwise flush the scheduler starting with this action.\n scheduler.flush(this);\n\n // HACK: In the past, this was returning `void`. However, `void` isn't a valid\n // `TimerHandle`, and generally the return value here isn't really used. So the\n // compromise is to return `0` which is both \"falsy\" and a valid `TimerHandle`,\n // as opposed to refactoring every other instanceo of `requestAsyncId`.\n return 0;\n }\n}\n", "import { AsyncScheduler } from './AsyncScheduler';\n\nexport class QueueScheduler extends AsyncScheduler {\n}\n", "import { QueueAction } from './QueueAction';\nimport { QueueScheduler } from './QueueScheduler';\n\n/**\n *\n * Queue Scheduler\n *\n * Put every next task on a queue, instead of executing it immediately\n *\n * `queue` scheduler, when used with delay, behaves the same as {@link asyncScheduler} scheduler.\n *\n * When used without delay, it schedules given task synchronously - executes it right when\n * it is scheduled. However when called recursively, that is when inside the scheduled task,\n * another task is scheduled with queue scheduler, instead of executing immediately as well,\n * that task will be put on a queue and wait for current one to finish.\n *\n * This means that when you execute task with `queue` scheduler, you are sure it will end\n * before any other task scheduled with that scheduler will start.\n *\n * ## Examples\n * Schedule recursively first, then do something\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(() => {\n * queueScheduler.schedule(() => console.log('second')); // will not happen now, but will be put on a queue\n *\n * console.log('first');\n * });\n *\n * // Logs:\n * // \"first\"\n * // \"second\"\n * ```\n *\n * Reschedule itself recursively\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(function(state) {\n * if (state !== 0) {\n * console.log('before', state);\n * this.schedule(state - 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * console.log('after', state);\n * }\n * }, 0, 3);\n *\n * // In scheduler that runs recursively, you would expect:\n * // \"before\", 3\n * // \"before\", 2\n * // \"before\", 1\n * // \"after\", 1\n * // \"after\", 2\n * // \"after\", 3\n *\n * // But with queue it logs:\n * // \"before\", 3\n * // \"after\", 3\n * // \"before\", 2\n * // \"after\", 2\n * // \"before\", 1\n * // \"after\", 1\n * ```\n */\n\nexport const queueScheduler = new QueueScheduler(QueueAction);\n\n/**\n * @deprecated Renamed to {@link queueScheduler}. Will be removed in v8.\n */\nexport const queue = queueScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\nimport { SchedulerAction } from '../types';\nimport { animationFrameProvider } from './animationFrameProvider';\nimport { TimerHandle } from './timerHandle';\n\nexport class AnimationFrameAction extends AsyncAction {\n constructor(protected scheduler: AnimationFrameScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n protected requestAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay is greater than 0, request as an async action.\n if (delay !== null && delay > 0) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n // Push the action to the end of the scheduler queue.\n scheduler.actions.push(this);\n // If an animation frame has already been requested, don't request another\n // one. If an animation frame hasn't been requested yet, request one. Return\n // the current animation frame request id.\n return scheduler._scheduled || (scheduler._scheduled = animationFrameProvider.requestAnimationFrame(() => scheduler.flush(undefined)));\n }\n\n protected recycleAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle | undefined {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n if (delay != null ? delay > 0 : this.delay > 0) {\n return super.recycleAsyncId(scheduler, id, delay);\n }\n // If the scheduler queue has no remaining actions with the same async id,\n // cancel the requested animation frame and set the scheduled flag to\n // undefined so the next AnimationFrameAction will request its own.\n const { actions } = scheduler;\n if (id != null && id === scheduler._scheduled && actions[actions.length - 1]?.id !== id) {\n animationFrameProvider.cancelAnimationFrame(id as number);\n scheduler._scheduled = undefined;\n }\n // Return undefined so the action knows to request a new async id if it's rescheduled.\n return undefined;\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\nexport class AnimationFrameScheduler extends AsyncScheduler {\n public flush(action?: AsyncAction): void {\n this._active = true;\n // The async id that effects a call to flush is stored in _scheduled.\n // Before executing an action, it's necessary to check the action's async\n // id to determine whether it's supposed to be executed in the current\n // flush.\n // Previous implementations of this method used a count to determine this,\n // but that was unsound, as actions that are unsubscribed - i.e. cancelled -\n // are removed from the actions array and that can shift actions that are\n // scheduled to be executed in a subsequent flush into positions at which\n // they are executed within the current flush.\n let flushId;\n if (action) {\n flushId = action.id;\n } else {\n flushId = this._scheduled;\n this._scheduled = undefined;\n }\n\n const { actions } = this;\n let error: any;\n action = action || actions.shift()!;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions[0]) && action.id === flushId && actions.shift());\n\n this._active = false;\n\n if (error) {\n while ((action = actions[0]) && action.id === flushId && actions.shift()) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AnimationFrameAction } from './AnimationFrameAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\n\n/**\n *\n * Animation Frame Scheduler\n *\n * Perform task when `window.requestAnimationFrame` would fire\n *\n * When `animationFrame` scheduler is used with delay, it will fall back to {@link asyncScheduler} scheduler\n * behaviour.\n *\n * Without delay, `animationFrame` scheduler can be used to create smooth browser animations.\n * It makes sure scheduled task will happen just before next browser content repaint,\n * thus performing animations as efficiently as possible.\n *\n * ## Example\n * Schedule div height animation\n * ```ts\n * // html:
\n * import { animationFrameScheduler } from 'rxjs';\n *\n * const div = document.querySelector('div');\n *\n * animationFrameScheduler.schedule(function(height) {\n * div.style.height = height + \"px\";\n *\n * this.schedule(height + 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * }, 0, 0);\n *\n * // You will see a div element growing in height\n * ```\n */\n\nexport const animationFrameScheduler = new AnimationFrameScheduler(AnimationFrameAction);\n\n/**\n * @deprecated Renamed to {@link animationFrameScheduler}. Will be removed in v8.\n */\nexport const animationFrame = animationFrameScheduler;\n", "import { Observable } from '../Observable';\nimport { SchedulerLike } from '../types';\n\n/**\n * A simple Observable that emits no items to the Observer and immediately\n * emits a complete notification.\n *\n * Just emits 'complete', and nothing else.\n *\n * ![](empty.png)\n *\n * A simple Observable that only emits the complete notification. It can be used\n * for composing with other Observables, such as in a {@link mergeMap}.\n *\n * ## Examples\n *\n * Log complete notification\n *\n * ```ts\n * import { EMPTY } from 'rxjs';\n *\n * EMPTY.subscribe({\n * next: () => console.log('Next'),\n * complete: () => console.log('Complete!')\n * });\n *\n * // Outputs\n * // Complete!\n * ```\n *\n * Emit the number 7, then complete\n *\n * ```ts\n * import { EMPTY, startWith } from 'rxjs';\n *\n * const result = EMPTY.pipe(startWith(7));\n * result.subscribe(x => console.log(x));\n *\n * // Outputs\n * // 7\n * ```\n *\n * Map and flatten only odd numbers to the sequence `'a'`, `'b'`, `'c'`\n *\n * ```ts\n * import { interval, mergeMap, of, EMPTY } from 'rxjs';\n *\n * const interval$ = interval(1000);\n * const result = interval$.pipe(\n * mergeMap(x => x % 2 === 1 ? of('a', 'b', 'c') : EMPTY),\n * );\n * result.subscribe(x => console.log(x));\n *\n * // Results in the following to the console:\n * // x is equal to the count on the interval, e.g. (0, 1, 2, 3, ...)\n * // x will occur every 1000ms\n * // if x % 2 is equal to 1, print a, b, c (each on its own)\n * // if x % 2 is not equal to 1, nothing will be output\n * ```\n *\n * @see {@link Observable}\n * @see {@link NEVER}\n * @see {@link of}\n * @see {@link throwError}\n */\nexport const EMPTY = new Observable((subscriber) => subscriber.complete());\n\n/**\n * @param scheduler A {@link SchedulerLike} to use for scheduling\n * the emission of the complete notification.\n * @deprecated Replaced with the {@link EMPTY} constant or {@link scheduled} (e.g. `scheduled([], scheduler)`). Will be removed in v8.\n */\nexport function empty(scheduler?: SchedulerLike) {\n return scheduler ? emptyScheduled(scheduler) : EMPTY;\n}\n\nfunction emptyScheduled(scheduler: SchedulerLike) {\n return new Observable((subscriber) => scheduler.schedule(() => subscriber.complete()));\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport function isScheduler(value: any): value is SchedulerLike {\n return value && isFunction(value.schedule);\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\nimport { isScheduler } from './isScheduler';\n\nfunction last(arr: T[]): T | undefined {\n return arr[arr.length - 1];\n}\n\nexport function popResultSelector(args: any[]): ((...args: unknown[]) => unknown) | undefined {\n return isFunction(last(args)) ? args.pop() : undefined;\n}\n\nexport function popScheduler(args: any[]): SchedulerLike | undefined {\n return isScheduler(last(args)) ? args.pop() : undefined;\n}\n\nexport function popNumber(args: any[], defaultValue: number): number {\n return typeof last(args) === 'number' ? args.pop()! : defaultValue;\n}\n", "export const isArrayLike = ((x: any): x is ArrayLike => x && typeof x.length === 'number' && typeof x !== 'function');", "import { isFunction } from \"./isFunction\";\n\n/**\n * Tests to see if the object is \"thennable\".\n * @param value the object to test\n */\nexport function isPromise(value: any): value is PromiseLike {\n return isFunction(value?.then);\n}\n", "import { InteropObservable } from '../types';\nimport { observable as Symbol_observable } from '../symbol/observable';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being Observable (but not necessary an Rx Observable) */\nexport function isInteropObservable(input: any): input is InteropObservable {\n return isFunction(input[Symbol_observable]);\n}\n", "import { isFunction } from './isFunction';\n\nexport function isAsyncIterable(obj: any): obj is AsyncIterable {\n return Symbol.asyncIterator && isFunction(obj?.[Symbol.asyncIterator]);\n}\n", "/**\n * Creates the TypeError to throw if an invalid object is passed to `from` or `scheduled`.\n * @param input The object that was passed.\n */\nexport function createInvalidObservableTypeError(input: any) {\n // TODO: We should create error codes that can be looked up, so this can be less verbose.\n return new TypeError(\n `You provided ${\n input !== null && typeof input === 'object' ? 'an invalid object' : `'${input}'`\n } where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.`\n );\n}\n", "export function getSymbolIterator(): symbol {\n if (typeof Symbol !== 'function' || !Symbol.iterator) {\n return '@@iterator' as any;\n }\n\n return Symbol.iterator;\n}\n\nexport const iterator = getSymbolIterator();\n", "import { iterator as Symbol_iterator } from '../symbol/iterator';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being an Iterable */\nexport function isIterable(input: any): input is Iterable {\n return isFunction(input?.[Symbol_iterator]);\n}\n", "import { ReadableStreamLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport async function* readableStreamLikeToAsyncGenerator(readableStream: ReadableStreamLike): AsyncGenerator {\n const reader = readableStream.getReader();\n try {\n while (true) {\n const { value, done } = await reader.read();\n if (done) {\n return;\n }\n yield value!;\n }\n } finally {\n reader.releaseLock();\n }\n}\n\nexport function isReadableStreamLike(obj: any): obj is ReadableStreamLike {\n // We don't want to use instanceof checks because they would return\n // false for instances from another Realm, like an

\ No newline at end of file diff --git a/credits/index.html b/credits/index.html new file mode 100644 index 00000000..88c3fa80 --- /dev/null +++ b/credits/index.html @@ -0,0 +1,35 @@ + Credits - mkdocstrings-python

Credits¤

These projects were used to build mkdocstrings-python. Thank you!

Python | uv | copier-uv

Runtime dependencies¤

Project Summary Version (accepted) Version (last resolved) License
click Composable command line interface toolkit >=8.0.0, >=7.0 8.3.1 BSD-3-Clause
colorama Cross-platform colored terminal text. >=0.4 0.4.6 BSD License
ghp-import Copy your docs directly to the gh-pages branch. >=1.0 2.1.0 Apache Software License
griffelib Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API. >=2.0 2.0.0 ISC
Jinja2 A very fast and expressive template engine. >=3.1 3.1.6 BSD License
Markdown Python implementation of John Gruber's Markdown. >=3.6 3.10.2 BSD-3-Clause
MarkupSafe Safely add untrusted strings to HTML/XML markup. >=1.1 3.0.3 BSD-3-Clause
mergedeep A deep merge function for 🐍. >=1.3.4 1.3.4 MIT License
mkdocs Project documentation with Markdown. >=1.6 1.6.1 BSD-2-Clause
mkdocs-autorefs Automatically link across pages in MkDocs. >=1.4 1.4.4 ISC
mkdocs-get-deps MkDocs extension that lists all dependencies according to a mkdocs.yml file >=0.2.0 0.2.0 MIT
mkdocstrings Automatic documentation from sources, for MkDocs. >=0.30, >=0.29 1.0.3 ISC
packaging Core utilities for Python packages >=24.1, >=20.5 26.0 Apache-2.0 OR BSD-2-Clause
pathspec Utility library for gitignore style pattern matching of file paths. >=1.0.0, >=0.11.1 1.0.4 Mozilla Public License 2.0 (MPL 2.0)
platformdirs A small Python package for determining appropriate platform-specific dirs, e.g. a user data dir. >=2.2.0, >=2 4.9.2 MIT
pymdown-extensions Extension pack for Python Markdown. >=9, >=6.3 10.21 MIT
python-dateutil Extensions to the standard Python datetime module >=2.8.1 2.9.0.post0 BSD License + Apache Software License
PyYAML YAML parser and emitter for Python >=5.1 6.0.3 MIT
pyyaml_env_tag A custom YAML tag for referencing environment variables in YAML files. >=0.1 1.1 MIT
six Python 2 and 3 compatibility utilities >=1.5, >=1.15, <2 1.17.0 MIT
typing_extensions Backported and Experimental Type Hints for Python 3.9+ >=4.0.1, >=4.0 4.15.0 PSF-2.0
watchdog Filesystem events monitoring >=2.0 6.0.0 Apache-2.0

Development dependencies¤

Project Summary Version (accepted) Version (last resolved) License
annotated-types Reusable constraint types to use with typing.Annotated >=0.6.0 0.7.0 MIT License
ansimarkup Produce colored terminal text with an xml-like markup ~=1.4 1.5.0 Revised BSD License
asttokens Annotate AST trees with source code positions >=2.0.5 3.0.1 Apache 2.0
babel Internationalization utilities >=2.7.0 2.18.0 BSD-3-Clause
backrefs A wrapper around re and regex that adds additional back references. >=5.7.post1 6.2 MIT
beautifulsoup4 Screen-scraping library >=4.12.3 4.14.3 MIT License
black The uncompromising code formatter. >=25.1 26.1.0 MIT
build A simple, correct Python build frontend >=1.2 1.4.0 MIT
cappa Declarative CLI argument parser. >=0.29 0.31.0 ?
certifi Python package for providing Mozilla's CA Bundle. >=2017.4.17 2026.1.4 MPL-2.0
cffi Foreign Function Interface for Python calling C code. >=1.14 2.0.0 MIT
charset-normalizer The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet. >=2, <4 3.4.4 MIT
click Composable command line interface toolkit >=8.0.0, >=7.0 8.3.1 BSD-3-Clause
colorama Cross-platform colored terminal text. >=0.4 0.4.6 BSD License
coverage Code coverage measurement for Python >=7.10.6 7.13.4 Apache-2.0
cryptography cryptography is a package which provides cryptographic recipes and primitives to Python developers. >=2.0 46.0.5 Apache-2.0 OR BSD-3-Clause
csscompressor A python port of YUI CSS Compressor >=0.9.5 0.9.5 BSD
docutils Docutils -- Python Documentation Utilities >=0.21.2 0.22.4 Public Domain + BSD License + GNU General Public License (GPL)
duty A simple task runner. >=1.6 1.9.0 ISC
execnet execnet: rapid multi-Python deployment >=2.1 2.1.2 MIT
executing Get the currently executing AST node of a frame, and other information >=2.2.0 2.2.1 MIT
failprint Run a command, print its output only if it fails. >=1.0.5 1.1.0 ISC
ghp-import Copy your docs directly to the gh-pages branch. >=1.0 2.1.0 Apache Software License
git-changelog Automatic Changelog generator using Jinja2 templates. >=2.5 2.7.1 ISC
gitdb Git Object Database >=4.0.1, <5 4.0.12 BSD License
GitPython GitPython is a Python library used to interact with Git repositories >=3.1.44 3.1.46 BSD-3-Clause
htmlmin2 An HTML Minifier >=0.1.13 0.1.13 BSD
humanize Python humanize utilities >=4.9 4.15.0 MIT
id A tool for generating OIDC identities 1.6.1 Apache Software License
idna Internationalized Domain Names in Applications (IDNA) >=2.5, <4 3.11 BSD-3-Clause
iniconfig brain-dead simple config-ini parsing >=1.0.1 2.3.0 MIT
inline-snapshot golden master/snapshot/approval testing library which puts the values right into your source code >=0.25 0.32.1 MIT License
jaraco.classes Utility functions for Python class constructs 3.4.0 MIT License
jaraco.context Useful decorators and context managers 6.1.0 MIT
jaraco.functools Functools like those found in stdlib 4.4.0 MIT
jeepney Low-level, pure Python DBus protocol wrapper. >=0.4.2 0.9.0 MIT
Jinja2 A very fast and expressive template engine. >=3.1 3.1.6 BSD License
jsmin JavaScript minifier. >=3.0.1 3.0.1 MIT License
keyring Store and access your passwords safely. >=21.2.0 25.7.0 MIT
librt Mypyc runtime library >=0.6.2 0.8.1 MIT
Markdown Python implementation of John Gruber's Markdown. >=3.6 3.10.2 BSD-3-Clause
markdown-callouts Markdown extension: a classier syntax for admonitions >=0.4 0.4.0 MIT
markdown-exec Utilities to execute code blocks in Markdown files. >=1.8 1.12.1 ISC
markdown-it-py Python port of markdown-it. Markdown parsing, done right! >=1.0.0, <4.0.0 3.0.0 MIT License
markdownify Convert HTML to markdown. >=0.14 1.2.2 MIT License
MarkupSafe Safely add untrusted strings to HTML/XML markup. >=1.1 3.0.3 BSD-3-Clause
mdformat CommonMark compliant Markdown formatter >=0.7.21 0.7.22 MIT License
mdformat_tables An mdformat plugin for rendering tables. >=1.0 1.0.0 MIT License
mdurl Markdown URL utilities ~=0.1 0.1.2 MIT License
mergedeep A deep merge function for 🐍. >=1.3.4 1.3.4 MIT License
mkdocs Project documentation with Markdown. >=1.6 1.6.1 BSD-2-Clause
mkdocs-autorefs Automatically link across pages in MkDocs. >=1.4 1.4.4 ISC
mkdocs-coverage MkDocs plugin to integrate your coverage HTML report into your site. >=1.0 2.0.0 ISC
mkdocs-get-deps MkDocs extension that lists all dependencies according to a mkdocs.yml file >=0.2.0 0.2.0 MIT
mkdocs-git-revision-date-localized-plugin Mkdocs plugin that enables displaying the localized date of the last git modification of a markdown file. >=1.2 1.5.1 MIT
mkdocs-llmstxt MkDocs plugin to generate an /llms.txt file. >=0.2 0.5.0 ISC
mkdocs-material Documentation that simply works >=9.5 9.7.2 MIT
mkdocs-material-extensions Extension pack for Python Markdown and MkDocs Material. >=1.3 1.3.1 MIT
mkdocs-minify-plugin An MkDocs plugin to minify HTML, JS or CSS files prior to being written to disk >=0.8 0.8.0 MIT
mkdocs-redirects A MkDocs plugin for dynamic page redirects to prevent broken links >=1.2 1.2.2 MIT
mkdocs-section-index MkDocs plugin to allow clickable sections that lead to an index page >=0.3 0.3.10 MIT
mkdocstrings Automatic documentation from sources, for MkDocs. >=0.30, >=0.29 1.0.3 ISC
more-itertools More routines for operating on iterables, beyond itertools 10.8.0 MIT
mypy Optional static typing for Python >=1.10 1.19.1 MIT
mypy_extensions Type system extensions for programs checked with the mypy type checker. >=0.4.3 1.1.0 MIT
nh3 Python binding to Ammonia HTML sanitizer Rust crate >=0.2.14 0.3.3 MIT
packaging Core utilities for Python packages >=24.1, >=20.5 26.0 Apache-2.0 OR BSD-2-Clause
paginate Divides large result sets into pages for easier browsing >=0.5 0.5.7 MIT
pathspec Utility library for gitignore style pattern matching of file paths. >=1.0.0, >=0.11.1 1.0.4 Mozilla Public License 2.0 (MPL 2.0)
platformdirs A small Python package for determining appropriate platform-specific dirs, e.g. a user data dir. >=2.2.0, >=2 4.9.2 MIT
pluggy plugin and hook calling mechanisms for python >=1.2 1.6.0 MIT
ptyprocess Run a subprocess in a pseudo terminal ~=0.6 0.7.0 ISC License (ISCL)
pycparser C parser in Python 3.0 BSD-3-Clause
pydantic Data validation using Python type hints >=2.10 2.12.5 MIT
pydantic_core Core functionality for Pydantic validation and serialization ==2.41.5 2.41.5 MIT
Pygments Pygments is a syntax highlighting package written in Python. >=2.5.1 2.19.2 BSD-2-Clause
pymdown-extensions Extension pack for Python Markdown. >=9, >=6.3 10.21 MIT
pyproject_hooks Wrappers to call pyproject.toml-based build backend hooks. 1.2.0 MIT License
pytest pytest: simple powerful testing with Python >=8.2 9.0.2 MIT
pytest-cov Pytest plugin for measuring coverage. >=5.0 7.0.0 MIT
pytest-randomly Pytest plugin to randomly order tests and control random.seed. >=3.15 4.0.1 MIT
pytest-xdist pytest xdist plugin for distributed testing, most importantly across multiple CPUs >=3.6 3.8.0 MIT
python-dateutil Extensions to the standard Python datetime module >=2.8.1 2.9.0.post0 BSD License + Apache Software License
pytokens A Fast, spec compliant Python 3.14+ tokenizer that runs on older Pythons. >=0.3.0 0.4.1 MIT License
PyYAML YAML parser and emitter for Python >=5.1 6.0.3 MIT
pyyaml_env_tag A custom YAML tag for referencing environment variables in YAML files. >=0.1 1.1 MIT
readme_renderer readme_renderer is a library for rendering readme descriptions for Warehouse >=35.0 44.0 Apache License, Version 2.0
requests Python HTTP for Humans. >=2.20 2.32.5 Apache-2.0
requests-toolbelt A utility belt for advanced users of python-requests >=0.8.0, !=0.9.0 1.0.0 Apache 2.0
rfc3986 Validating URI References per RFC 3986 >=1.4.0 2.0.0 Apache 2.0
rich Render rich text, tables, progress bars, syntax highlighting, markdown and more to the terminal >=12.0.0 14.3.3 MIT
ruff An extremely fast Python linter and code formatter, written in Rust. >=0.4 0.15.2 MIT License
SecretStorage Python bindings to FreeDesktop.org Secret Service API >=3.2 3.5.0 BSD-3-Clause
semver Python helper for Semantic Versioning (https://semver.org) >=3.0 3.0.4 BSD License
six Python 2 and 3 compatibility utilities >=1.5, >=1.15, <2 1.17.0 MIT
smmap A pure Python implementation of a sliding window memory map manager >=3.0.1, <6 5.0.2 BSD-3-Clause
soupsieve A modern CSS selector implementation for Beautiful Soup. >=1.6.1 2.8.3 MIT
twine Collection of utilities for publishing packages on PyPI >=5.1 6.2.0 Apache-2.0
type-lens type-lens is a Python template project designed to simplify the setup of a new project. >=0.2.5 0.2.6 MIT
types-Markdown Typing stubs for Markdown >=3.6 3.10.2.20260211 Apache-2.0
types-PyYAML Typing stubs for PyYAML >=6.0 6.0.12.20250915 Apache-2.0
typing-inspection Runtime typing introspection tools >=0.4.2 0.4.2 MIT
typing_extensions Backported and Experimental Type Hints for Python 3.9+ >=4.0.1, >=4.0 4.15.0 PSF-2.0
urllib3 HTTP library with thread-safe connection pooling, file post, and more. >=1.26.0 2.6.3 MIT
watchdog Filesystem events monitoring >=2.0 6.0.0 Apache-2.0
wcwidth Measures the displayed width of unicode strings in a terminal >=0.2.13 0.6.0 MIT
yore Manage legacy code with comments. >=0.3.3 0.4.7 ISC

More credits from the author

\ No newline at end of file diff --git a/docs/css/material.css b/css/material.css similarity index 100% rename from docs/css/material.css rename to css/material.css diff --git a/docs/css/mkdocstrings.css b/css/mkdocstrings.css similarity index 100% rename from docs/css/mkdocstrings.css rename to css/mkdocstrings.css diff --git a/css/timeago.css b/css/timeago.css new file mode 100644 index 00000000..55d8b36f --- /dev/null +++ b/css/timeago.css @@ -0,0 +1,14 @@ +/* + timeago output is dynamic, which breaks when you print a page. + + This CSS is only included when type: timeago + and ensures fallback to type "iso_date" when printing. + + */ + +.git-revision-date-localized-plugin-iso_date { display: none } + +@media print { + .git-revision-date-localized-plugin-iso_date { display: inline } + .git-revision-date-localized-plugin-timeago { display: none } +} diff --git a/docs/.glossary.md b/docs/.glossary.md deleted file mode 100644 index e11a6781..00000000 --- a/docs/.glossary.md +++ /dev/null @@ -1,13 +0,0 @@ -[__all__]: https://docs.python.org/3/tutorial/modules.html#importing-from-a-package -[class template]: https://github.com/mkdocstrings/python/blob/master/src/mkdocstrings_handlers/python/templates/material/_base/class.html -[function template]: https://github.com/mkdocstrings/python/blob/master/src/mkdocstrings_handlers/python/templates/material/_base/function.html -[autodoc syntax]: https://mkdocstrings.github.io/usage/#autodoc-syntax -[autopages recipe]: https://mkdocstrings.github.io/recipes/#automatic-code-reference-pages -[Griffe]: https://github.com/mkdocstrings/griffe -[ReadTheDocs Sphinx theme]: https://sphinx-rtd-theme.readthedocs.io/en/stable/index.html -[Spacy's documentation]: https://spacy.io/api/doc/ -[Black]: https://pypi.org/project/black/ -[Material for MkDocs]: https://squidfunk.github.io/mkdocs-material -[Ruff]: https://docs.astral.sh/ruff - -*[ToC]: Table of Contents diff --git a/docs/.overrides/partials/comments.html b/docs/.overrides/partials/comments.html deleted file mode 100644 index 1d5c6051..00000000 --- a/docs/.overrides/partials/comments.html +++ /dev/null @@ -1,57 +0,0 @@ - - - \ No newline at end of file diff --git a/docs/.overrides/partials/path-item.html b/docs/.overrides/partials/path-item.html deleted file mode 100644 index a9c95446..00000000 --- a/docs/.overrides/partials/path-item.html +++ /dev/null @@ -1,22 +0,0 @@ -{# Fix breadcrumbs for when mkdocs-section-index is used. #} -{# See https://github.com/squidfunk/mkdocs-material/issues/7614. #} - - -{% macro render_content(nav_item) %} - - {{ nav_item.title }} - -{% endmacro %} - - -{% macro render(nav_item, ref=nav_item) %} - {% if nav_item.is_page %} -
  • - - {{ render_content(ref) }} - -
  • - {% elif nav_item.children %} - {{ render(nav_item.children | first, ref) }} - {% endif %} -{% endmacro %} diff --git a/docs/changelog.md b/docs/changelog.md deleted file mode 100644 index 0536cbbe..00000000 --- a/docs/changelog.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Changelog ---- - ---8<-- "CHANGELOG.md" diff --git a/docs/code_of_conduct.md b/docs/code_of_conduct.md deleted file mode 100644 index 002b2a04..00000000 --- a/docs/code_of_conduct.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Code of Conduct ---- - ---8<-- "CODE_OF_CONDUCT.md" diff --git a/docs/contributing.md b/docs/contributing.md deleted file mode 100644 index 61935e5d..00000000 --- a/docs/contributing.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Contributing ---- - ---8<-- "CONTRIBUTING.md" diff --git a/docs/credits.md b/docs/credits.md deleted file mode 100644 index f6ab1aa2..00000000 --- a/docs/credits.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Credits -hide: -- toc ---- - -```python exec="yes" ---8<-- "scripts/gen_credits.py" -``` diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 82377e21..00000000 --- a/docs/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Overview -hide: -- feedback ---- - ---8<-- "README.md" diff --git a/docs/license.md b/docs/license.md deleted file mode 100644 index 5b25a00f..00000000 --- a/docs/license.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: License -hide: -- feedback ---- - -# License - -``` ---8<-- "LICENSE" -``` diff --git a/docs/logo.png b/docs/logo.png deleted file mode 100644 index 5b42478c..00000000 Binary files a/docs/logo.png and /dev/null differ diff --git a/docs/reference/api.md b/docs/reference/api.md deleted file mode 100644 index 587e99db..00000000 --- a/docs/reference/api.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: API reference -hide: -- navigation ---- - -# ::: mkdocstrings_handlers.python - options: - show_submodules: true diff --git a/docs/usage/configuration/docstrings.md b/docs/usage/configuration/docstrings.md deleted file mode 100644 index 95f9032f..00000000 --- a/docs/usage/configuration/docstrings.md +++ /dev/null @@ -1,1461 +0,0 @@ -# Docstrings options - -[](){#option-docstring_style} -## `docstring_style` - -- **:octicons-package-24: Type [`str`][] :material-equal: `"google"`{ title="default value" }** - - -The docstring style to expect when parsing docstrings. - -Possible values: - -- `"google"`: see [Google style](../docstrings/google.md). -- `"numpy"`: see [Numpy style](../docstrings/numpy.md). -- `"sphinx"`: see [Sphinx style](../docstrings/sphinx.md). -- `None` (`null` or `~` in YAML): no style at all, parse as regular text. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - docstring_style: google -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - docstring_style: numpy -``` - -WARNING: **The style is applied to the specified object only, not its members.** Local `docstring_style` options (in `:::` instructions) will only be applied to the specified object, and not its members. Instead of changing the style when rendering, we strongly recommend to *set the right style as early as possible*, for example by using the [auto-style](https://mkdocstrings.github.io/griffe/reference/docstrings/#auto-style) (sponsors only), or with a custom Griffe extension - - -/// admonition | Preview - type: preview - -Every style gets rendered the same way. -Here are some docstring examples. - -//// tab | Google -```python -def greet(name: str) -> str: - """Greet someone. - - Parameters: - name: The name of the person to greet. - - Returns: - A greeting message. - """ - return f"Hello {name}!" -``` -//// - -//// tab | Numpy -```python -def greet(name: str) -> str: - """Greet someone. - - Parameters - ---------- - name - The name of the person to greet. - - Returns - ------- - A greeting message. - """ - return f"Hello {name}!" -``` -//// - -//// tab | Sphinx -```python -def greet(name: str) -> str: - """Greet someone. - - :param name: The name of the person to greet. - :return: A greeting message. - """ - return f"Hello {name}!" -``` -//// -/// - -[](){#option-docstring_options} -## `docstring_options` - -- **:octicons-package-24: Type [`dict`][] :material-equal: `{}`{ title="default value" }** - - -The options for the docstring parser. - -- [Google-style options](https://mkdocstrings.github.io/griffe/docstrings/#parser-options){ .external } -- [Numpydoc-style options](https://mkdocstrings.github.io/griffe/docstrings/#parser-options_1){ .external } - -The Sphinx style does not offer any option. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - docstring_options: - ignore_init_summary: false - trim_doctest_flags: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - docstring_options: - ignore_init_summary: true - trim_doctest_flags: false -``` - -```python -class PrintOK: - """Class docstring.""" - - def __init__(self): - """Initialize the instance. - - Examples: - >>> PrintOK() # doctest: +NORMALIZE_WHITESPACE - ok - """ - print("ok") -``` - -/// admonition | Preview - type: preview - -//// tab | Ignore init summary, trim doctest flags -

    PrintOK

    -

    Class docstring.

    -

    __init__

    -

    Examples:

    - -```pycon ->>> PrintOK() -ok -``` -//// - -//// tab | Keep init summary and doctest flags -

    PrintOK

    -

    Class docstring.

    -

    __init__

    -

    Initialize the instance.

    -

    Examples:

    - -```pycon ->>> PrintOK() # doctest: +NORMALIZE_WHITESPACE -ok -``` -//// -/// - -[](){#option-docstring_section_style} -## `docstring_section_style` - -- **:octicons-package-24: Type [`str`][] :material-equal: `"table"`{ title="default value" }** - - -The style used to render docstring sections. - -A section is a block of text that has a special meaning in a docstring. -There are sections for documenting attributes of an object, -parameters of a function, exceptions raised by a function, -the return value of a function, etc. - -Sections are parsed as structured data and can therefore be rendered -in different ways. Possible values: - -- `"table"`: a simple table, usually with type, name and description columns -- `"list"`: a simple list, akin to what you get with the [ReadTheDocs Sphinx theme]{ .external } -- `"spacy"`: a poor implementation of the amazing tables in [Spacy's documentation]{ .external } - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - docstring_section_style: table -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - docstring_section_style: list -``` - -/// admonition | Preview - type: preview - -//// tab | Table -Tables work well when you have lots of items with short names, type annotations, descriptions, etc.. -With longer strings, the columns risk getting squished horizontally. -In that case, the Spacy tables can help. - -**Parameters:** - -**Type** | **Name** | **Description** | **Default** ----------- | ----------- | ------------------------ | ----------- -[`int`][] | `threshold` | Threshold for something. | *required* -[`bool`][] | `flag` | Enable something. | `False` - -**Other Parameters:** - -**Type** | **Name** | **Description** | **Default** ----------- | ----------- | ------------------------ | ----------- -list[int \| float] | `gravity_forces` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | *required* -VacuumType \| Literal["regular"] | `vacuum_type` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | `VacuumType.PLASMA` -//// - -//// tab | List -Lists work well whatever the length of names, type annotations, descriptions, etc. - -**Parameters:** - -- `threshold` ([`int`][]) — Threshold for something. -- `flag` ([`bool`][]) — Enable something. - -**Other Parameters:** - -- `gravity_forces` (list[int \| float]) — Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. -- `vacuum_type` (VacuumType \| Literal["regular"]) — Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. -//// - -//// tab | Spacy -Spacy tables work better than regular tables with longer names, type annotations, descriptions, etc., -by reserving more horizontal space on the second column. - -**Parameters:** - -**Name** | **Description** ------------ | --------------- -`threshold` | Threshold for something.
    **TYPE:** [`int`][] DEFAULT: required -`flag` | Enable something.
    **TYPE:** [`bool`][] DEFAULT: False - -**Other Parameters:** - -**Name** | **Description** ------------ | --------------- -`gravity_forces` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
    **TYPE:** list[int \| float] DEFAULT: required -`vacuum_type` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
    **TYPE:**VacuumType \| Literal["regular"] DEFAULT: VacuumType.PLASMA -//// -/// - -[](){#option-merge_init_into_class} -## `merge_init_into_class` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -Whether to merge the `__init__` method into the class' signature and docstring. - -By default, only the class name is rendered in headings. -When merging, the `__init__` method parameters are added after the class name, -like a signature, and the `__init__` method docstring is appended to the class' docstring. -This option is well used in combination with the `ignore_init_summary` [docstring option][docstring_options], -to discard the first line of the `__init__` docstring which is not often useful. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - docstring_options: - ignore_init_summary: false - merge_init_into_class: false -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - docstring_options: - ignore_init_summary: true - merge_init_into_class: true -``` - -```python -class Thing: - """A class for things.""" - - def __init__(self, value: int = 0): - """Initialize a thing. - - Parameters: - value: The thing's value. - """ - self.value = value -``` - -/// admonition | Preview - type: preview - -//// tab | Merged, summary discarded -

    Thing(value=0)

    -

    Class docstring.

    -

    Parameters:

    - -**Type** | **Name** | **Description** | **Default** ---------- | -------- | ------------------ | ----------- -[`int`][] | `value` | The thing's value. | `0` -//// - -//// tab | Unmerged, summary kept -

    Thing

    -

    Class docstring.

    -

    __init__(value=0)

    -

    Initialize a thing.

    -

    Parameters:

    - -**Type** | **Name** | **Description** | **Default** ---------- | -------- | ------------------ | ----------- -[`int`][] | `value` | The thing's value. | `0` -//// -/// - -[](){#option-relative_crossrefs} -## `relative_crossrefs` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -Whether to enable the relative-crossref syntax. - -The relative-crossref syntax lets you reference the current object or its parent by prefixing a crossref identifier with dots. For example, to cross-reference the current object's `name` member, you can write `[link to name attribute][.name]`. The "current object" is the object containing the docstring being rendered. - - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - relative_crossrefs: false -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - relative_crossrefs: true -``` - -/// admonition | Examples - type: preview - -```python title="pkg/module.py" -"""Summary. - -- Link to [`module`][.]. -- Link to [`module_attribute`][.module_attribute]. -- Link to [`Class`][.Class]. -- Link to [`class_attribute`][.Class.class_attribute]. -- Link to [`instance_attribute`][.Class.instance_attribute]. -- Link to [`method`][.Class.method]. -""" - -module_attribute = 0 -"""Summary. - -- Link to [`module`][..]. -- Link to [`module_attribute`][.]. -- Link to [`Class`][..Class]. -- Link to [`class_attribute`][..Class.class_attribute]. -- Link to [`instance_attribute`][..Class.instance_attribute]. -- Link to [`method`][..Class.method]. -""" - -class Class: - """Summary. - - - Link to [`module`][..]. - - Link to [`module_attribute`][..module_attribute]. - - Link to [`Class`][.]. - - Link to [`class_attribute`][.class_attribute]. - - Link to [`instance_attribute`][.instance_attribute]. - - Link to [`method`][.method]. - """ - - class_attribute = 0 - """Summary. - - - Link to [`module`][...]. - - Link to [`module_attribute`][...module_attribute]. - - Link to [`Class`][..]. - - Link to [`class_attribute`][.]. - - Link to [`instance_attribute`][..instance_attribute]. - - Link to [`method`][..method]. - """ - - def __init__(self): - """Summary. - - - Link to [`module`][...]. - - Link to [`module_attribute`][...module_attribute]. - - Link to [`Class`][..]. - - Link to [`class_attribute`][..class_attribute]. - - Link to [`instance_attribute`][..instance_attribute]. - - Link to [`method`][..method]. - """ - self.instance_attribute = 0 - """Summary. - - - Link to [`module`][...]. - - Link to [`module_attribute`][...module_attribute]. - - Link to [`Class`][..]. - - Link to [`class_attribute`][..class_attribute]. - - Link to [`instance_attribute`][.]. - - Link to [`method`][..method]. - """ - - def method(self): - """Summary. - - - Link to [`module`][...]. - - Link to [`module_attribute`][...module_attribute]. - - Link to [`Class`][..]. - - Link to [`class_attribute`][..class_attribute]. - - Link to [`instance_attribute`][..instance_attribute]. - - Link to [`method`][.]. - """ -``` - -/// - -INFO: **There is an alternative, third-party Python handler that handles relative references: [mkdocstrings-python-xref](https://github.com/analog-garage/mkdocstrings-python-xref).** - -[](){#option-scoped_crossrefs} -## `scoped_crossrefs` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -Whether to enable scoped cross-references. - -With scoped cross-references, you can write identifiers as if you wanted to access them from the current object's scope. The scoping rules do not exactly match Python's: you can reference members and siblings too, without prefixing with `self.` or `cls.`. - -The following order is applied when resolving a name in a given scope: - -1. member of the current object -2. parent class -3. repeat 1-2 within parent's scope - -In practice, it means that the name is first looked up in members, then it is compared against the parent name (only if it's a class), then it is looked up in siblings. It continues climbing up the object tree until there's no parent, in which case it raises a name resolution error. - -Cross-referencing an imported object will directly link to this object if the objects inventory of the project it comes from was [loaded][inventories]. You won't be able to cross-reference it within your own documentation with scoped references, if you happen to be rendering this external object too. In that case, you can use an absolute reference or a [relative][relative_crossrefs] one instead. - -Another limitation is that you won't be able to reference an external package if its name can be resolved in the current object's scope. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - scoped_crossrefs: false -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - scoped_crossrefs: true -``` - -/// admonition | Examples - type: preview - -```python title="pkg/module.py" -"""Summary. - -- Link to [`module_attribute`][module_attribute]. -- Link to [`Class`][Class]. -- Link to [`class_attribute`][Class.class_attribute]. -- Link to [`instance_attribute`][Class.instance_attribute]. -- Link to [`method`][Class.method]. -""" - -module_attribute = 0 -"""Summary. - -- Link to [`Class`][Class]. -- Link to [`class_attribute`][Class.class_attribute]. -- Link to [`instance_attribute`][Class.instance_attribute]. -- Link to [`method`][Class.method]. -""" - -class Class: - """Summary. - - - Link to [`module_attribute`][module_attribute]. - - Link to [`class_attribute`][class_attribute]. - - Link to [`instance_attribute`][instance_attribute]. - - Link to [`method`][method]. - """ - - class_attribute = 0 - """Summary. - - - Link to [`module_attribute`][module_attribute]. - - Link to [`Class`][Class]. - - Link to [`instance_attribute`][instance_attribute]. - - Link to [`method`][method]. - """ - - def __init__(self): - """Summary. - - - Link to [`module_attribute`][module_attribute]. - - Link to [`Class`][Class]. - - Link to [`class_attribute`][class_attribute]. - - Link to [`instance_attribute`][instance_attribute]. - - Link to [`method`][method]. - """ - self.instance_attribute = 0 - """Summary. - - - Link to [`module_attribute`][module_attribute]. - - Link to [`Class`][Class]. - - Link to [`class_attribute`][class_attribute]. - - Link to [`method`][method]. - """ - - def method(self): - """Summary. - - - Link to [`module_attribute`][module_attribute]. - - Link to [`Class`][Class]. - - Link to [`class_attribute`][class_attribute]. - - Link to [`instance_attribute`][instance_attribute]. - """ -``` - -/// - -[](){#option-show_if_no_docstring} -## `show_if_no_docstring` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -Show the object heading even if it has no docstring or children with docstrings. - -Without an explicit list of [`members`][], members are selected based on [`filters`][], -and then filtered again to keep only those with docstrings. Checking if a member has a docstring -is done recursively: if at least one of its direct or indirect members (lower in the tree) -has a docstring, the member is rendered. If the member does not have a docstring, -and none of its members have a docstring, it is excluded. - -With this option you can tell the Python handler to skip the docstring check. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_if_no_docstring: false -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - show_if_no_docstring: true -``` - -```python -def function_without_docstring(): - ... - - -def function_with_docstring(): - """Hello.""" - - -class ClassWithoutDocstring: - def method_without_docstring(self): - ... - - def method_with_docstring(self): - """Hello.""" -``` - -/// admonition | Preview - type: preview - -//// tab | Show -

    function_without_docstring

    -

    function_with_docstring

    -

    Hello.

    -

    ClassWithoutDocstring

    -

    method_without_docstring

    -

    method_with_docstring

    -

    Hello.

    -//// - -//// tab | Don't show -

    function_with_docstring

    -

    Hello.

    -

    ClassWithoutDocstring

    -

    method_with_docstring

    -

    Hello.

    -//// -/// - -[](){#option-show_docstring_attributes} -## `show_docstring_attributes` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Whether to render the "Attributes" section of docstrings. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_docstring_attributes: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - show_docstring_attributes: false -``` - -```python -class Class: - """Summary. - - Attributes: - attr: Some attribute. - """ - - attr: int = 1 -``` - -/// admonition | Preview - type: preview - -//// tab | With attributes -

    Class

    -

    Summary.

    -

    Attributes:

    - -**Type** | **Name** | **Description** ---------- | -------- | --------------- -[`int`][] | `attr` | Some attribute. -//// - -//// tab | Without attributes -

    Class

    -

    Summary.

    -//// -/// - -[](){#option-show_docstring_functions} -## `show_docstring_functions` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Whether to render the "Functions" or "Methods" section of docstrings. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_docstring_functions: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - show_docstring_functions: false -``` - -```python -"""Summary. - -Functions: - foo: Some function. -""" - - -def foo(): - ... - - -class Class: - """Summary. - - Methods: - bar: Some method. - """ - - def bar(self): - ... -``` - -/// admonition | Preview - type: preview - -//// tab | With functions -

    module

    -

    Summary.

    -

    Functions:

    - -**Name** | **Description** --------- | --------------- -`foo` | Some function. - -

    Class

    -

    Summary.

    -

    Methods:

    - -**Name** | **Description** --------- | --------------- -`bar` | Some method. -//// - -//// tab | Without functions -

    module

    -

    Summary.

    -

    Class

    -

    Summary.

    -//// -/// - -[](){#option-show_docstring_classes} -## `show_docstring_classes` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Whether to render the "Classes" section of docstrings. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_docstring_classes: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - show_docstring_classes: false -``` - -```python -"""Summary. - -Classes: - Class: Some class. -""" - - -class Class: - """Summary.""" -``` - -/// admonition | Preview - type: preview - -//// tab | With classes -

    module

    -

    Summary.

    -

    Classes:

    - -**Name** | **Description** --------- | --------------- -`Class` | Some class. - -

    Class

    -

    Summary.

    -//// - -//// tab | Without classes -

    module

    -

    Summary.

    -

    Class

    -

    Summary.

    -//// -/// - -[](){#option-show_docstring_type_aliases} -## `show_docstring_type_aliases` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - -Whether to render the "Type Aliases" section of docstrings. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_docstring_type_aliases: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - show_docstring_type_aliases: false -``` - -```python -"""Summary. - -Type Aliases: - TypeAlias: Some type alias. -""" - - -type TypeAlias = int -"""Summary.""" -``` - -/// admonition | Preview - type: preview - -//// tab | With type_aliases -

    module

    -

    Summary.

    -

    Type Aliases:

    - -**Name** | **Description** ------------- | ---------------- -`TypeAlias` | Some type alias. - -

    TypeAlias

    -

    Summary.

    -//// - -//// tab | Without classes -

    module

    -

    Summary.

    -

    TypeAlias

    -

    Summary.

    -//// -/// - -[](){#option-show_docstring_modules} -## `show_docstring_modules` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Whether to render the "Modules" section of docstrings. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_docstring_modules: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - show_docstring_modules: false -``` - -```tree -module/ - __init__.py - submodule.py -``` - -```python title="module/__init__.py" -"""Summary. - -Modules: - submodule: Some module. -""" -``` - -/// admonition | Preview - type: preview - -//// tab | With modules -

    module

    -

    Summary.

    -

    Modules:

    - -**Name** | **Description** ------------ | --------------- -`submodule` | Some module. - -//// - -//// tab | Without modules -

    module

    -

    Summary.

    -//// -/// - -[](){#option-show_docstring_description} -## `show_docstring_description` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Whether to render the textual blocks (including admonitions) of docstrings. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_docstring_description: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - show_docstring_description: false -``` - -```python -class Class: - """Summary. - - Long description. - - Warning: Deprecated - Stop using this class. - - Attributes: - attr: Some attribute. - """ - - attr: int = 1 -``` - -/// admonition | Preview - type: preview - -//// tab | With description blocks -

    Class

    -

    Summary.

    -

    Long description.

    -
    Deprecated

    Stop using this class.

    -

    Attributes:

    - -**Type** | **Name** | **Description** ---------- | -------- | --------------- -[`int`][] | `attr` | Some attribute. -//// - -//// tab | Without description blocks -

    Class

    -

    Attributes:

    - -**Type** | **Name** | **Description** ---------- | -------- | --------------- -[`int`][] | `attr` | Some attribute. -//// -/// - -[](){#option-show_docstring_examples} -## `show_docstring_examples` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Whether to render the "Examples" section of docstrings. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_docstring_examples: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - show_docstring_examples: false -``` - -```python -def print_hello(): - """Print hello. - - Examples: - >>> print("hello") - hello - """ - print("hello") -``` - -/// admonition | Preview - type: preview - -//// tab | With examples -

    print_hello

    -

    Print hello.

    -

    Examples:

    - -```pycon ->>> print("hello") -hello -``` -//// - -//// tab | Without examples -

    print_hello

    -

    Print hello.

    -//// -/// - -[](){#option-show_docstring_other_parameters} -## `show_docstring_other_parameters` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Whether to render the "Other Parameters" section of docstrings. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_docstring_other_parameters: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - show_docstring_other_parameters: false -``` - -```python -def do_something(**kwargs): - """Do something. - - Other parameters: - whatever (int): Some integer. - """ -``` - -/// admonition | Preview - type: preview - -//// tab | With other parameters -

    do_something

    -

    Do something.

    -

    Other parameters:

    - -**Type** | **Name** | **Description** ---------- | ---------- | --------------- -[`int`][] | `whatever` | Some integer. -//// - -//// tab | Without other parameters -

    do_something

    -

    Do something.

    -//// -/// - -[](){#option-show_docstring_parameters} -## `show_docstring_parameters` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Whether to render the "Parameters" section of docstrings. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_docstring_parameters: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - show_docstring_parameters: false -``` - -```python -def do_something(whatever: int = 0): - """Do something. - - Parameters: - whatever: Some integer. - """ -``` - -/// admonition | Preview - type: preview - -//// tab | With parameters -

    do_something

    -

    Do something.

    -

    Parameters:

    - -**Type** | **Name** | **Description** | **Default** ---------- | ---------- | --------------- | ----------- -[`int`][] | `whatever` | Some integer. | `0` -//// - -//// tab | Without parameters -

    do_something

    -

    Do something.

    -//// -/// - -[](){#option-show_docstring_raises} -## `show_docstring_raises` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Whether to render the "Raises" section of docstrings. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_docstring_raises: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - show_docstring_raises: false -``` - -```python -def raise_runtime_error(): - """Raise a runtime error. - - Raises: - RuntimeError: Not good. - """ - raise RuntimeError -``` - -/// admonition | Preview - type: preview - -//// tab | With exceptions -

    raise_runtime_error

    -

    Raise a runtime error.

    -

    Raises:

    - -**Type** | **Description** ------------------- | --------------- -[`RuntimeError`][] | Not good. -//// - -//// tab | Without exceptions -

    raise_runtime_error

    -

    Raise a runtime error.

    -//// -/// - -[](){#option-show_docstring_receives} -## `show_docstring_receives` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Whether to render the "Receives" section of docstrings. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_docstring_receives: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - show_docstring_receives: false -``` - -```python -def iter_skip( - iterable: Iterable[T], - initial_skip: int = 0, -) -> Generator[T, int, None]: - """Iterate and skip elements. - - Receives: - skip: Number of elements to skip. - """ - skip = initial_skip - for element in iterable: - if skip or 0 > 0: - skip -= 1 - else: - skip = yield element -``` - -/// admonition | Preview - type: preview - -//// tab | With received values -

    iter_skip

    -

    Iterate and skip elements.

    -

    Receives:

    - -**Type** | **Description** ---------- | --------------- -[`int`][] | Number of elements to skip. -//// - -//// tab | Without received values -

    iter_skip

    -

    Iterate and skip elements.

    -//// -/// - -[](){#option-show_docstring_returns} -## `show_docstring_returns` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Whether to render the "Returns" section of docstrings. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_docstring_returns: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - show_docstring_returns: false -``` - -```python -def rand() -> int: - """Return a random number. - - Returns: - A random number. - """ - return random.randint(0, 1000) -``` - -/// admonition | Preview - type: preview - -//// tab | With return value -

    rand

    -

    Return a random number.

    -

    Returns:

    - -**Type** | **Description** ---------- | --------------- -[`int`][] | A random number. -//// - -//// tab | Without return value -

    rand

    -

    Return a random number.

    -//// -/// - -[](){#option-show_docstring_type_parameters} -## `show_docstring_type_parameters` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Whether to render the "Type Parameters" section of docstrings. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_docstring_type_parameters: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - show_docstring_type_parameters: false -``` - -```python -class AClass[X: (int, str) = str]: - """Represents something. - - Type Parameters: - X: Something. - """ -``` - -/// admonition | Preview - type: preview - -//// tab | With parameters -

    AClass

    -

    Represents something.

    -

    Type Parameters:

    - -**Name** | **Bound or Constraints** | **Description** | **Default** ----------- | ------------------------ | --------------- | ----------- -`whatever` | `(int, str)` | Something. | `str` -//// - -//// tab | Without parameters -

    AClass

    -

    Represents something.

    -//// -/// - -[](){#option-show_docstring_warns} -## `show_docstring_warns` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Whether to render the "Warns" section of docstrings. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_docstring_warns: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - show_docstring_warns: false -``` - -```python -def warn(): - """Warn user. - - Warns: - UserWarning: When this is inappropriate. - """ - warnings.warn(UserWarning("This is inappropriate")) -``` - -/// admonition | Preview - type: preview - -//// tab | With warnings -

    warn

    -

    Warn user.

    -

    Warns:

    - -**Type** | **Description** ------------------ | --------------- -[`UserWarning`][] | When this is inappropriate. -//// - -//// tab | Without warnings -

    warn

    -

    Warn user.

    -//// -/// - -[](){#option-show_docstring_yields} -## `show_docstring_yields` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Whether to render the "Yields" section of docstrings. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_docstring_yields: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - show_docstring_yields: false -``` - -```python -def iter_skip( - iterable: Iterable[T], - initial_skip: int = 0, -) -> Generator[T, int, None]: - """Iterate and skip elements. - - Yields: - Elements of the iterable. - """ - skip = initial_skip - for element in iterable: - if skip or 0 > 0: - skip -= 1 - else: - skip = yield element -``` - -/// admonition | Preview - type: preview - -//// tab | With yielded values -

    iter_skip

    -

    Iterate and skip elements.

    -

    Yields:

    - -**Type** | **Description** ---------- | --------------- -`T` | Elements of the iterable. -//// - -//// tab | Without yielded values -

    iter_skip

    -

    Iterate and skip elements.

    -//// -/// diff --git a/docs/usage/configuration/general.md b/docs/usage/configuration/general.md deleted file mode 100644 index 921f3b27..00000000 --- a/docs/usage/configuration/general.md +++ /dev/null @@ -1,687 +0,0 @@ -# General options - -[](){#option-allow_inspection} -## `allow_inspection` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Whether to allow inspecting modules (importing them) -when it is not possible to visit them (parse their source code). - -When loading data for a given package, [Griffe] discovers every Python module, -compiled or not, and inspects or visits them accordingly. - -If you have compiled modules but also provide stubs for them, -you might want to disable the inspection of these modules, -because inspection picks up many more members, -and sometimes the collected data is inaccurate -(depending on the tool that was used to compile the module) -or too low-level/technical for API documentation. - -See also [`force_inspection`](#force_inspection). - -WARNING: **Packages are loaded only once.** When mkdocstrings-python collects data from a Python package (thanks to [Griffe](https://mkdocstrings.github.io/griffe/)), it collects *the entire package* and *caches it*. Next time an object from the same package is rendered, the package is retrieved from the cache and not collected again. The `allow_inspection` option will therefore only have an effect the first time a package is collected, and will do nothing for objects rendered afterwards. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - allow_inspection: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.object - options: - allow_inspection: false -``` - -/// admonition | Preview - type: preview - -//// tab | With inspection -

    SomeClass

    -

    Docstring of the class.

    -

    __eq__

    -

    Method docstring.

    -

    __weakref__

    -

    Method docstring.

    -

    documented_method

    -

    Method docstring.

    -//// - -//// tab | Without inspection -

    SomeClass

    -

    Docstring of the class.

    -

    documented_method

    -

    Method docstring.

    -//// -/// - -[](){#option-backlinks} -## `backlinks` - -- **:octicons-package-24: Type Literal["flat", "tree", False] :material-equal: `False`{ title="default value" }** - -The `backlinks` option enables rendering of backlinks within your API documentation. - -When an arbitrary section of your documentation links to an API symbol, this link will be collected as a backlink, and rendered below your API symbol. In short, the API symbol will link back to the section that links to it. Such backlinks will help your users navigate the documentation, as they will immediately which functions return a specific symbol, or where a specific symbol is accepted as parameter, etc.. - -Each backlink is a list of breadcrumbs that represent the navigation, from the root page down to the given section. - -The available styles for rendering backlinks are **`flat`** and **`tree`**. - -- **`flat`** will render backlinks as a single-layer list. This can lead to repetition of breadcrumbs. -- **`tree`** will combine backlinks into a tree, to remove repetition of breadcrumbs. - -WARNING: **Global-only option.** For now, the option only works when set globally in `mkdocs.yml`. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - backlinks: tree -``` - -/// admonition | Preview - type: preview - -//// tab | Flat -![backlinks-flat](https://github.com/user-attachments/assets/f7a15b01-f194-4c55-8281-50adbb4a74af) -//// - -//// tab | Tree -![backlinks-tree](https://github.com/user-attachments/assets/3457db21-45e1-4e03-bd8c-2e9e75dc778b) -//// -/// - -[](){#option-extensions} -## `extensions` - -- **:octicons-package-24: Type list[str | dict[str, dict[str, Any]]] :material-equal: `[]`{ title="default value" }** - - -The `extensions` option lets you enable [Griffe extensions](https://mkdocstrings.github.io/griffe/extensions/), which enhance or modify the data collected from Python sources (or compiled modules). - -Elements in the list can be strings or dictionaries. - -Strings denote the path to an extension module, like `griffe_typingdoc`, or to an extension class directly, like `griffe_typingdoc.TypingDocExtension`. When using a module path, all extensions within that module will be loaded and enabled. Strings can also be the path to a Python module, and a class name separated with `:`, like `scripts/griffe_extensions.py` or `scripts/griffe_extensions.py:MyExtension`. - -Dictionaries have a single key, which is the module/class path (as a dot-separated qualifier or file path and colon-separated class name, like above), and its value is another dictionary specifying options that will be passed when to class constructors when instantiating extensions. - -WARNING: **Packages are loaded only once.** When mkdocstrings-python collects data from a Python package (thanks to [Griffe](https://mkdocstrings.github.io/griffe/)), it collects *the entire package* and *caches it*. Next time an object from the same package is rendered, the package is retrieved from the cache and not collected again. Only the extensions specified the first time the package is loaded will be used. You cannot use a different set of extensions for specific objects rendered afterwards, and you cannot deactivate extensions for objects rendered afterwards either. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - extensions: - - griffe_sphinx - - griffe_pydantic: {schema: true} - - scripts/exts.py:DynamicDocstrings: - paths: [mypkg.mymod.myobj] -``` - -```md title="or in docs/some_page.md (local configuration)" -::: your_package.your_module.your_func - options: - extensions: - - griffe_typingdoc -``` - -[](){#option-extra} -## `extra` - -- **:octicons-package-24: Type [`dict`][] :material-equal: `{}`{ title="default value" }** - - -The `extra` option lets you inject additional variables into the Jinja context used when rendering templates. You can then use this extra context in your [overridden templates][templates]. - -Local `extra` options will be merged into the global `extra` option: - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - extra: - hello: world -``` - -```md title="in docs/some_page.md (local configuration)" -::: your_package.your_module.your_func - options: - extra: - foo: bar -``` - -...will inject both `hello` and `foo` into the Jinja context when rendering `your_package.your_module.your_func`. - -> WARNING: Previously, extra options were supported directly under the `options` key. -> -> ```yaml -> plugins: -> - mkdocstrings: -> handlers: -> python: -> options: -> hello: world -> ``` -> -> Now that we introduced optional validation of options and automatic JSON schema generation thanks to Pydantic, we require extra options to be put under `options.extra`. Extra options directly under `options` are still supported, but deprecated, and will emit deprecation warnings. Support will be removed in a future version of mkdocstrings-python. - -[](){#option-find_stubs_package} -## `find_stubs_package` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -When looking for documentation specified in [autodoc instructions][autodoc syntax] (`::: identifier`), also look for -the stubs package as defined in [PEP 561](https://peps.python.org/pep-0561/) if it exists. This is useful when -most of your documentation is separately provided by such a package and not inline in your main package. - -WARNING: **Packages are loaded only once.** When mkdocstrings-python collects data from a Python package (thanks to [Griffe](https://mkdocstrings.github.io/griffe/)), it collects *the entire package* and *caches it*. Next time an object from the same package is rendered, the package is retrieved from the cache and not collected again. The `find_stubs_package` option will therefore only have an effect the first time a package is collected, and will do nothing for objects rendered afterwards. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - find_stubs_package: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: your_package.your_module.your_func - options: - find_stubs_package: true -``` - -```python title="your_package/your_module.py" - -def your_func(a, b): - # Function code - ... - -# rest of your code -``` - -```python title="your_package-stubs/your_module.pyi" - -def your_func(a: int, b: str): - """ - - """ - ... - -# rest of your code -``` - -/// admonition | Preview - type: preview - -//// tab | With find_stubs_package -

    your_func

    -

    Function docstring

    -//// - -//// tab | Without find_stubs_package -

    your_func

    -//// -/// - -[](){#option-force_inspection} -## `force_inspection` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -Whether to force inspecting modules (importing them) even if their source code is available. - -This option is useful when you know that dynamic analysis (inspection) yields better results than static analysis. Do not use this blindly: the recommended approach is to write a Griffe extension that will improve extracted API data. See [How to selectively inspect objects](https://mkdocstrings.github.io/griffe/guide/users/how-to/selectively-inspect/). - -See also [`allow_inspection`](#allow_inspection). - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - force_inspection: false -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.object - options: - force_inspection: true -``` - -WARNING: **Packages are loaded only once.** When mkdocstrings-python collects data from a Python package (thanks to [Griffe](https://mkdocstrings.github.io/griffe/)), it collects *the entire package* and *caches it*. Next time an object from the same package is rendered, the package is retrieved from the cache and not collected again. The `force_inspection` option will therefore only have an effect the first time a package is collected, and will do nothing for objects rendered afterwards. - -[](){#option-inheritance_diagram_direction} -## `inheritance_diagram_direction` - -The direction of the Mermaid chart presenting the inheritance diagram of a class, `TD` by default. - -```yaml title="mkdocs.yml" -extra_javascript: -- https://unpkg.com/mermaid@10.9.0/dist/mermaid.min.js -``` - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - inheritance_diagram_direction: TD -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.object - options: - inheritance_diagram_direction: TD -``` - -/// admonition | Preview - type: preview - - -With the following classes: - -```python -class SuperAbstract: - """Super abstract class.""" -class Mixin1: - """Mixin 1.""" -class Abstract(SuperAbstract, Mixin1): - """Abstract class.""" -class Mixin2A: - """Mixin 2A.""" -class Mixin2B(Mixin2A): - """Mixin 2B.""" -class Concrete(Abstract, Mixin2B): - """Concrete class.""" -class SuperConcrete(Concrete): - """Super concrete class.""" -``` - -//// tab | `TD` (or `TB`) - -```mermaid -flowchart TD -SuperConcrete[SuperConcrete] -Concrete[Concrete] -Abstract[Abstract] -SuperAbstract[SuperAbstract] -Mixin1[Mixin1] -Mixin2B[Mixin2B] -Mixin2A[Mixin2A] - -Concrete --> SuperConcrete -Abstract --> Concrete -SuperAbstract --> Abstract -Mixin1 --> Abstract -Mixin2B --> Concrete -Mixin2A --> Mixin2B -``` - -//// - -//// tab | `BT` - -```mermaid -flowchart BT -SuperConcrete[SuperConcrete] -Concrete[Concrete] -Abstract[Abstract] -SuperAbstract[SuperAbstract] -Mixin1[Mixin1] -Mixin2B[Mixin2B] -Mixin2A[Mixin2A] - -Concrete --> SuperConcrete -Abstract --> Concrete -SuperAbstract --> Abstract -Mixin1 --> Abstract -Mixin2B --> Concrete -Mixin2A --> Mixin2B -``` - -//// - -//// tab | `RL` - -```mermaid -flowchart RL -SuperConcrete[SuperConcrete] -Concrete[Concrete] -Abstract[Abstract] -SuperAbstract[SuperAbstract] -Mixin1[Mixin1] -Mixin2B[Mixin2B] -Mixin2A[Mixin2A] - -Concrete --> SuperConcrete -Abstract --> Concrete -SuperAbstract --> Abstract -Mixin1 --> Abstract -Mixin2B --> Concrete -Mixin2A --> Mixin2B -``` - -//// - -//// tab | `LR` - -```mermaid -flowchart LR -SuperConcrete[SuperConcrete] -Concrete[Concrete] -Abstract[Abstract] -SuperAbstract[SuperAbstract] -Mixin1[Mixin1] -Mixin2B[Mixin2B] -Mixin2A[Mixin2A] - -Concrete --> SuperConcrete -Abstract --> Concrete -SuperAbstract --> Abstract -Mixin1 --> Abstract -Mixin2B --> Concrete -Mixin2A --> Mixin2B -``` - -//// -/// - -[](){#option-preload_modules} -## `preload_modules` - -- **:octicons-package-24: Type list[str] | None :material-equal: `None`{ title="default value" }** - - -Pre-load modules that are not specified directly in [autodoc instructions][autodoc syntax] (`::: identifier`). -It is useful when you want to render documentation for a particular member of an object, -and this member is imported from another package than its parent. - -For an imported member to be rendered, -you need to add it to the [`__all__`][__all__] attribute of the importing module. -The package from which the imported object originates must be accessible to the handler -(see [Finding modules](../index.md#finding-modules)). - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - preload_modules: - - their_package -``` - -```md title="or in docs/some_page.md (local configuration)" -::: your_package.your_module - options: - preload_modules: - - their_package -``` - -```python title="your_package/your_module.py" -from their_package.their_module import their_object - -__all__ = ["their_object"] - -# rest of your code -``` - -/// admonition | Preview - type: preview - -//// tab | With preloaded modules -

    your_module

    -

    Docstring of your module.

    -

    their_object

    -

    Docstring of their object.

    -//// - -//// tab | Without preloaded modules -

    your_module

    -

    Docstring of your module.

    -//// -/// - -[](){#option-show_bases} -## `show_bases` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Show the base classes of a class. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_bases: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.object - options: - show_bases: false -``` - -/// admonition | Preview - type: preview - -//// tab | With bases -

    SomeClass()

    -

    Bases: SomeBaseClass

    -

    Docstring of the class.

    -//// - -//// tab | Without bases -

    SomeClass()

    -

    Docstring of the class.

    -//// -/// - -[](){#option-show_inheritance_diagram} -## `show_inheritance_diagram` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -Show the inheritance diagram of a class using [Mermaid](https://mermaid.js.org/). - -With this option enabled, an inheritance diagram (as a flowchart) -will be displayed after a class signature. -Each node will act as a cross-reference -and will bring you to the relevant class' documentation -when clicking on it. - -It should work out of the box with [Material for MkDocs][]. -For other themes, you must include Mermaid's Javascript code manually: - -```yaml title="mkdocs.yml" -extra_javascript: -- https://unpkg.com/mermaid@10.9.0/dist/mermaid.min.js -``` - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_inheritance_diagram: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.object - options: - show_inheritance_diagram: false -``` - -/// admonition | Preview - type: preview - -With the following classes: - -```python -class SuperAbstract: - """Super abstract class.""" -class Mixin1: - """Mixin 1.""" -class Abstract(SuperAbstract, Mixin1): - """Abstract class.""" -class Mixin2A: - """Mixin 2A.""" -class Mixin2B(Mixin2A): - """Mixin 2B.""" -class Concrete(Abstract, Mixin2B): - """Concrete class.""" -class SuperConcrete(Concrete): - """Super concrete class.""" -``` - -The diagram for `SuperConcrete` will look like this: - -```mermaid -flowchart TD -SuperConcrete[SuperConcrete] -Concrete[Concrete] -Abstract[Abstract] -SuperAbstract[SuperAbstract] -Mixin1[Mixin1] -Mixin2B[Mixin2B] -Mixin2A[Mixin2A] - -Concrete --> SuperConcrete -Abstract --> Concrete -SuperAbstract --> Abstract -Mixin1 --> Abstract -Mixin2B --> Concrete -Mixin2A --> Mixin2B -``` - -*Nodes are not clickable in this example -because these classes do not exist in our documentation.* -/// - -[](){#option-show_source} -## `show_source` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Show the source code of this object. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_source: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.object - options: - show_source: false -``` - -/// admonition | Preview - type: preview - -//// tab | With source -

    some_function()

    -

    Docstring of the function.

    - -///// details | Source code in `package/module.py` - type: quote - -```python linenums="1" -def some_function(): - ... -``` -///// -//// - -//// tab | Without source -

    some_function()

    -

    Docstring of the function.

    -//// -/// - -[](){#option-skip_local_inventory} -## `skip_local_inventory` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -Whether to skip registering symbols in the objects inventory. - -With this option enabled, re-rendering docstrings for objects from external inventories is possible with their cross-references pointing to the original external inventory, not local. Similarly, it becomes possible to render the same symbol several times in the same documentation, with only one canonical location being used for cross-references (preventing confusion in mkdocs-autorefs). - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - skip_local_inventory: false -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - skip_local_inventory: true -``` - -/// admonition | Preview - type: preview - - -//// tab | Without `skip_local_inventory` - -```md exec="on" -::: bisect.bisect_left - options: - heading_level: 3 - skip_local_inventory: false - show_docstring_description: false -``` - -Notice how [`bisect.bisect_left`][] now points to the section above. - -//// - -//// tab | With `skip_local_inventory` - -```md exec="on" -::: bisect.bisect_right - inventories: - - https://docs.python.org/3/objects.inv - options: - heading_level: 3 - skip_local_inventory: true - show_docstring_description: false -``` - -Notice how [`bisect.bisect_right`][] points to the original Python documentation. - -//// -/// diff --git a/docs/usage/configuration/headings.md b/docs/usage/configuration/headings.md deleted file mode 100644 index 593b6fb0..00000000 --- a/docs/usage/configuration/headings.md +++ /dev/null @@ -1,810 +0,0 @@ -# Headings options - -[](){#option-heading} -## `heading` - -- **:octicons-package-24: Type [`str`][] :material-equal: `""`{ title="default value" }** - - -A custom string to use as the heading of the root object (i.e. the object specified directly after the identifier `:::`). This will override the default heading generated by the plugin. See also the [`toc_label` option][option-toc_label]. - -WARNING: **Not advised to be used as a global configuration option.** This option is not advised to be used as a global configuration option, as it will override the default heading for all objects. It is recommended to use it only in specific cases where you want to override the heading for a specific object. - -```md title="in docs/some_page.md (local configuration)" -::: path.to.module - options: - heading: "My fancy module" -``` - -[](){#option-heading_level} -## `heading_level` - -- **:octicons-package-24: Type [`int`][] :material-equal: `2`{ title="default value" }** - - -The initial heading level to use. - -When injecting documentation for an object, -the object itself and its members are rendered. -For each layer of objects, we increase the heading level by 1. - -The initial heading level will be used for the first layer. -If you set it to 3, then headings will start with `

    `. - -If the [heading for the root object][show_root_heading] is not shown, -then the initial heading level is used for its members. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - heading_level: 2 -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - heading_level: 3 -``` - -/// admonition | Preview - type: preview - -//// tab | With level 3 and root heading -

    module (3)

    -

    Docstring of the module.

    -

    ClassA (4)

    -

    Docstring of class A.

    -

    ClassB (4)

    -

    Docstring of class B.

    -
    method_1 (5)
    -

    Docstring of the method.

    -//// - -//// tab | With level 3, without root heading -

    Docstring of the module.

    -

    ClassA (3)

    -

    Docstring of class A.

    -

    ClassB (3)

    -

    Docstring of class B.

    -

    method_1 (4)

    -

    Docstring of the method.

    -//// -/// - -[](){#option-parameter_headings} -## `parameter_headings` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -Whether to render headings for function/method parameters. - -With this option enabled, each function/method parameter -(including parameters of `__init__` methods merged in their parent class -with the [`merge_init_into_class`][] option) -gets a permalink, an entry in the Table of Contents, -and an entry in the generated objects inventory (unless [`skip_local_inventory`][] is enabled). -The permalink and inventory entry allow cross-references -from internal and external pages. - -The identifier used in the permalink and inventory is of the following form: -`path.to.function(param_name)`. To manually cross-reference a parameter, -you can therefore use this Markdown syntax: - -```md -- Class parameter: [`param`][package.module.Class(param)] -- Method parameter: [`param`][package.module.Class.method(param)] -- Function parameter: [`param`][package.module.function(param)] -- Variadic positional parameters: [`*args`][package.module.function(*args)] -- Variadic keyword parameters: [`**kwargs`][package.module.function(**kwargs)] -``` - -Enabling this option along with [`signature_crossrefs`][] will automatically -render cross-references to parameters in class/function/method signatures -and attributes values. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - parameter_headings: false -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - parameter_headings: true -``` - -/// admonition | Preview: Cross-references - type: preview - -```md exec="on" -::: package.get_version - options: - heading_level: 3 - parameter_headings: true - docstring_section_style: list - -::: package.current_version - options: - heading_level: 3 - line_length: 100 -``` - -/// - -/// admonition | Preview: Parameter sections - type: preview - -//// tab | Table style -```md exec="on" -::: package.get_version - options: - heading_level: 3 - show_root_heading: false - show_root_toc_entry: false - parameter_headings: true - docstring_section_style: table - show_docstring_returns: false - show_docstring_description: false -``` -//// - -//// tab | List style -```md exec="on" -::: package.get_version - options: - heading_level: 3 - show_root_heading: false - show_root_toc_entry: false - parameter_headings: true - docstring_section_style: list - show_docstring_returns: false - show_docstring_description: false -``` -//// - -//// tab | Spacy style -```md exec="on" -::: package.get_version - options: - heading_level: 3 - show_root_heading: false - show_root_toc_entry: false - parameter_headings: true - docstring_section_style: spacy - show_docstring_returns: false - show_docstring_description: false -``` -//// -/// - -/// admonition | Preview: Table of contents (with symbol types) - type: preview - - get_version
    - dist - -To customize symbols, see [Customizing symbol types](../customization.md/#symbol-types). - -/// - -[](){#option-show_root_heading} -## `show_root_heading` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -Show the heading of the object at the root of the documentation tree -(i.e. the object referenced by the identifier after `:::`). - -It is pretty common to inject documentation for one module per page, -especially when following our [automatic reference pages recipe][autopages recipe]. -Since each page already has a title, usually being the module's name, -we can spare one heading level by not showing the heading for the module itself -(heading levels are limited to 6 by the HTML specification). - -Sparing that extra level can be helpful when your objects tree is deeply nested -(e.g. method in a class in a class in a module). -If your objects tree is not deeply nested, and you are injecting documentation -for many different objects on a single page, it might be preferable to render -the heading of each object. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_root_heading: false -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.ClassA - options: - show_root_heading: true - -::: path.to.ClassB - options: - show_root_heading: true -``` - -/// admonition | Preview - type: preview - -//// tab | With root heading -

    ClassA (2)

    -

    Docstring of class A.

    -

    method_a1 (3)

    -

    Docstring of the method.

    -

    ClassB (2)

    -

    Docstring of class B.

    -

    method_b1 (3)

    -

    Docstring of the method.

    -//// - -//// tab | Without root heading -

    Docstring of class A.

    -

    method_a1 (2)

    -

    Docstring of the method.

    -

    Docstring of class B.

    -

    method_b1 (2)

    -

    Docstring of the method.

    -//// -/// - -[](){#option-show_root_toc_entry} -## `show_root_toc_entry` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -If the root heading is not shown, at least add a ToC entry for it. - -If you inject documentation for an object in the middle of a page, -after long paragraphs, and without showing the [root heading][show_root_heading], -then you will not be able to link to this particular object -as it won't have a permalink and will be "lost" in the middle of text. -In that case, it is useful to add a hidden anchor to the document, -which will also appear in the table of contents. - -In other cases, you might want to disable the entry to avoid polluting the ToC. -It is not possible to show the root heading *and* hide the ToC entry. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_root_toc_entry: true -``` - -```md title="or in docs/some_page.md (local configuration)" -## Some heading - -Lots of text. - -::: path.to.object - options: - show_root_toc_entry: false - -## Other heading. - -More text. -``` - -/// admonition | Preview - type: preview - -//// tab | With ToC entry -**Table of contents** -[Some heading](#permalink-to-some-heading){ title="#permalink-to-some-heading" } -[`object`](#permalink-to-object){ title="#permalink-to-object" } -[Other heading](#permalink-to-other-heading){ title="#permalink-to-other-heading" } -//// - -//// tab | Without ToC entry -**Table of contents** -[Some heading](#permalink-to-some-heading){ title="#permalink-to-some-heading" } -[Other heading](#permalink-to-other-heading){ title="#permalink-to-other-heading" } -//// -/// - -[](){#option-show_root_full_path} -## `show_root_full_path` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Show the full Python path for the root object heading. - -The path of a Python object is the dot-separated list of names -under which it is accessible, for example `package.module.Class.method`. - -With this option you can choose to show the full path of the object -you inject documentation for, or just its name. This option impacts -only the object you specify, not its members. For members, see the two -other options [`show_root_members_full_path`][] -and [`show_object_full_path`][]. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_root_full_path: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: package.module.Class.method - options: - show_root_full_path: false -``` - -/// admonition | Preview - type: preview - -//// tab | With root full path -

    package.module.Class.method

    -

    Docstring of the method.

    -//// - -//// tab | Without root full path -

    method

    -

    Docstring of the method.

    -//// -/// - -[](){#option-show_root_members_full_path} -## `show_root_members_full_path` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -Show the full Python path of the root members. - -This option does the same thing as [`show_root_full_path`][], -but for direct members of the root object instead of the root object itself. - -To show the full path for every member recursively, -see [`show_object_full_path`][]. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_root_members_full_path: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: package.module - options: - show_root_members_full_path: false -``` - -/// admonition | Preview - type: preview - -//// tab | With members full path -

    Docstring of the module.

    -

    package.module.Class

    -

    Docstring of the class.

    -

    method

    -

    Docstring of the method.

    -//// - -//// tab | Without members full path -

    Docstring of the module.

    -

    Class

    -

    Docstring of the class.

    -

    method

    -

    Docstring of the method.

    -//// -/// - -[](){#option-show_object_full_path} -## `show_object_full_path` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -Show the full Python path of every object. - -Same as for [`show_root_members_full_path`][], -but for every member, recursively. This option takes precedence over -[`show_root_members_full_path`][]: - -`show_root_members_full_path` | `show_object_full_path` | Direct root members path ------------------------------ | ----------------------- | ------------------------ -False | False | Name only -False | True | Full -True | False | Full -True | True | Full - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_object_full_path: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: package.module - options: - show_object_full_path: false -``` - -/// admonition | Preview - type: preview - -//// tab | With objects full path -

    Docstring of the module.

    -

    package.module.Class

    -

    Docstring of the class.

    -

    package.module.Class.method

    -

    Docstring of the method.

    -//// - -//// tab | Without objects full path -

    Docstring of the module.

    -

    Class

    -

    Docstring of the class.

    -

    method

    -

    Docstring of the method.

    -//// -/// - -[](){#option-show_category_heading} -## `show_category_heading` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -When [grouped by categories][group_by_category], show a heading for each category. -These category headings will appear in the table of contents, -allowing you to link to them using their permalinks. - -WARNING: **Not recommended with deeply nested objects.** -When injecting documentation for deeply nested objects, -you'll quickly run out of heading levels, and the objects -at the bottom of the tree risk all getting documented -using H6 headings, which might decrease the readability -of your API docs. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - group_by_category: true - show_category_heading: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: package.module - options: - group_by_category: true - show_category_heading: false -``` - -/// admonition | Preview - type: preview - -//// tab | With category headings -

    Docstring of the module.

    -

    Attributes (2)

    -

    module_attribute (3)

    -

    Docstring of the module attribute.

    -

    Classes (2)

    -

    Class (3)

    -

    Docstring of the class.

    -

    Attributes (4)

    -
    class_attribute (5)
    -

    Docstring of the class attribute.

    -

    Methods (4)

    -
    method (5)
    -

    Docstring of the method.

    -//// - -//// tab | Without category headings -

    Docstring of the module.

    -

    module_attribute (2)

    -

    Docstring of the module attribute.

    -

    Class (2)

    -

    Docstring of the class.

    -

    class_attribute (3)

    -

    Docstring of the class attribute.

    -

    method (3)

    -

    Docstring of the method.

    -//// -/// - -[](){#option-show_symbol_type_heading} -## `show_symbol_type_heading` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -Show the symbol type in headings. - -This option will prefix headings with -, -, -, - or - types. -See also [`show_symbol_type_toc`][show_symbol_type_toc]. - -To customize symbols, see [Customizing symbol types](../customization.md/#symbol-types). - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_symbol_type_heading: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: package.module - options: - show_symbol_type_heading: false -``` - -/// admonition | Preview - type: preview - -//// tab | With symbol type in headings -

    module

    -

    Docstring of the module.

    -

    attribute

    -

    Docstring of the module attribute.

    -

    function

    -

    Docstring of the function.

    -

    Class

    -

    Docstring of the class.

    -

    method

    -

    Docstring of the method.

    -//// - -//// tab | Without symbol type in headings -

    module

    -

    Docstring of the module.

    -

    attribute

    -

    Docstring of the module attribute.

    -

    function

    -

    Docstring of the function.

    -

    Class

    -

    Docstring of the class.

    -

    method

    -

    Docstring of the method.

    -//// -/// - -[](){#option-show_symbol_type_toc} -## `show_symbol_type_toc` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -Show the symbol type in the Table of Contents. - -This option will prefix items in the ToC with -, -, -, - or - types. -See also [`show_symbol_type_heading`][show_symbol_type_heading]. - -To customize symbols, see [Customizing symbol types](../customization.md/#symbol-types). - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_symbol_type_toc: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: package.module - options: - show_symbol_type_toc: false -``` - -/// admonition | Preview - type: preview - -//// tab | With symbol type in ToC -
      -
    • module
    • -
    • attribute
    • -
    • function
    • -
    • Class -
        -
      • method
      • -
      -
    • -
    -//// - -//// tab | Without symbol type in ToC -
      -
    • module
    • -
    • attribute
    • -
    • function
    • -
    • Class -
        -
      • method
      • -
      -
    • -
    -//// -/// - -[](){#option-toc_label} -## `toc_label` - -- **:octicons-package-24: Type [`str`][] :material-equal: `""`{ title="default value" }** - - -A custom string to use as the label in the Table of Contents for the root object (i.e. the one specified directly after the identifier `:::`). This will override the default label generated by the plugin. See also the [`heading` option][option-heading]. - -WARNING: **Not advised to be used as a global configuration option.** This option is not advised to be used as a global configuration option, as it will override the default label for all objects. It is recommended to use it only in specific cases where you want to override the label for a specific object. - -NOTE: **Use with/without `heading`.** If you use this option without specifying a custom `heading`, the default heading will be used in the page, but the label in the Table of Contents will be the one you specified. By providing both an option for `heading` and `toc_label`, we leave the customization entirely up to you. - -```md title="in docs/some_page.md (local configuration)" -::: path.to.module - options: - heading: "My fancy module" - toc_label: "My fancy module" -``` - -[](){#option-type_parameter_headings} -## `type_parameter_headings` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - -Whether to render headings for generic class, function/method and type alias -type parameters. - -With this option enabled, each type parameter of a generic object (including -type parameters of `__init__` methods merged in their parent class with the -[`merge_init_into_class`][] option) gets a permalink, an entry in the Table of -Contents, and an entry in the generated objects inventory. The permalink and -inventory entry allow cross-references from internal and external pages. - - - -Enabling this option along with [`signature_crossrefs`][] will automatically -render cross-references to type parameters in class/function/method/type alias -signatures. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - type_parameter_headings: false -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - type_parameter_headings: true -``` - -/// admonition | Preview: Cross-references - type: preview - -```md exec="on" -::: package.generics - options: - show_root_heading: false - heading_level: 3 - docstring_section_style: list - show_bases: true - summary: false - separate_signature: true - show_signature_type_parameters: true - show_inheritance_diagram: false - type_parameter_headings: true -``` - -/// - -/// admonition | Preview: Type parameter sections - type: preview - -//// tab | Table style -```md exec="on" -::: package.generics.MagicBag - options: - members: false - heading_level: 3 - show_root_heading: false - show_root_toc_entry: false - parameter_headings: true - docstring_section_style: table - show_docstring_description: false - show_docstring_parameters: false - show_docstring_returns: false - show_inheritance_diagram: false -``` -//// - -//// tab | List style -```md exec="on" -::: package.generics.MagicBag - options: - members: false - heading_level: 3 - show_root_heading: false - show_root_toc_entry: false - parameter_headings: true - docstring_section_style: list - show_docstring_description: false - show_docstring_parameters: false - show_docstring_returns: false - show_inheritance_diagram: false -``` -//// - -//// tab | Spacy style -```md exec="on" -::: package.generics.MagicBag - options: - members: false - heading_level: 3 - show_root_heading: false - show_root_toc_entry: false - parameter_headings: true - docstring_section_style: spacy - show_docstring_description: false - show_docstring_parameters: false - show_docstring_returns: false - show_inheritance_diagram: false -``` -//// -/// - -/// admonition | Preview: Table of contents (with symbol types) - type: preview - - mutate
    - U - -To customize symbols, see [Customizing symbol types](../customization.md/#symbol-types). - -/// diff --git a/docs/usage/configuration/members.md b/docs/usage/configuration/members.md deleted file mode 100644 index 53d955fa..00000000 --- a/docs/usage/configuration/members.md +++ /dev/null @@ -1,711 +0,0 @@ -# Members options - -[](){#option-members} -## `members` - -- **:octicons-package-24: Type list[str] | - bool | None :material-equal: `None`{ title="default value" }** - - -An explicit list of members to render. - -Only members declared in this list will be rendered. -A member without a docstring will still be rendered, -even if [`show_if_no_docstring`][] is set to false. - -The members will be rendered in the specified order, -regardless of the value of [`members_order`][]. -**Note that members will still be grouped by category, -according to the [`group_by_category`][] option.** - -Passing a falsy value (`no`, `false` in YAML) or an empty list (`[]`) -will tell the Python handler not to render any member. -Passing a truthy value (`yes`, `true` in YAML) -will tell the Python handler to render every member. - -Any given value, except for an explicit `None` (`null` in YAML) -will tell the handler to ignore [`filters`][] for the object's members. -Filters will still be applied to the next layers of members (grand-children). - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - members: - - hello # (1) -``` - -1. :warning: Most of the time it won't make sense to use this option at the global level. - -```md title="or in docs/some_page.md (local configuration)" -::: package.module - options: - members: - - ThisClass - - this_function -``` - -```python title="package/module.py" -"""Module docstring.""" - - -def this_function(): - """Function docstring.""" - - -class ThisClass: - """Class docstring.""" - - def method(self): - """Method docstring.""" - - -this_attribute = 0 -"""Attribute docstring.""" -``` - -/// admonition | Preview - type: preview - -//// tab | With `members: true` -

    Module docstring.

    -

    this_function

    -

    Function docstring.

    -

    ThisClass

    -

    Class docstring.

    -

    method

    -

    Method docstring.

    -

    this_attribute

    -

    Attribute docstring.

    -//// - -//// tab | With `members: false` or `members: []` -

    Module docstring.

    -//// - -//// tab | With `members: [ThisClass]` -

    Module docstring.

    -

    ThisClass

    -

    Class docstring.

    -

    method

    -

    Method docstring.

    -//// -/// - -INFO: **The default behavior (with unspecified `members` or `members: null`) is to use [`filters`][].** - -[](){#option-inherited_members} -## `inherited_members` - -- **:octicons-package-24: Type list[str] | - bool :material-equal: `False`{ title="default value" }** - - -An explicit list of inherited members (for classes) to render. - -Inherited members are always fetched from classes that are in the same package -as the currently rendered class. To fetch members inherited from base classes, -themselves coming from external packages, use the [`preload_modules`][preload_modules] option. -For example, if your class inherits from Pydantic's `BaseModel`, and you want to render -`BaseModel`'s methods in your class, use `preload_modules: [pydantic]`. -The `pydantic` package must be available in the current environment. - -Passing a falsy value (`no`, `false` in YAML) or an empty list (`[]`) -will tell the Python handler not to render any inherited member. -Passing a truthy value (`yes`, `true` in YAML) -will tell the Python handler to render every inherited member. - -When all inherited members are selected with `inherited_members: true`, -it is possible to specify both members and inherited members in the `members` list: - -```yaml -inherited_members: true -members: -- inherited_member_a -- inherited_member_b -- member_x -- member_y -``` - -The alternative is not supported: - -```yaml -inherited_members: -- inherited_member_a -- inherited_member_b -members: -- member_x -- member_y -``` - -...because it would make members ordering ambiguous/unspecified. - -You can render inherited members *only* by setting `inherited_members: true` -(or a list of inherited members) and setting `members: false`: - -```yaml -inherited_members: true -members: false -``` - -```yaml -inherited_members: -- inherited_member_a -- inherited_member_b -members: false -``` - -You can render *all declared members* and all or specific inherited members -by leaving `members` as null (default): - -```yaml -inherited_members: -- inherited_member_a -- inherited_member_b -# members: null # (1) -``` - -1. In this case, only declared members will be subject -to further filtering with [`filters`][filters] and [`docstrings`][show_if_no_docstring]. - -```yaml -inherited_members: true # (1) -# members: null -``` - -1. In this case, both declared and inherited members will be subject -to further filtering with [`filters`][filters] and [`docstrings`][show_if_no_docstring]. - -You can render *all declared members* and all or specific inherited members, -avoiding further filtering with [`filters`][filters] and [`docstrings`][show_if_no_docstring] -by setting `members: true`: - -```yaml -inherited_members: true -members: true -``` - -```yaml -inherited_members: -- inherited_member_a -- inherited_member_b -members: true -``` - -The general rule is that declared or inherited members specified in lists -are never filtered out. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - inherited_members: false -``` - -```md title="or in docs/some_page.md (local configuration)" -::: package.module - options: - inherited_members: true -``` - -```python title="package/module.py" -"""Module docstring.""" - - -class Base: - """Base class.""" - - def base(self): - """Base method.""" - - -class Main(Base): - """Main class.""" - - def main(self): - """Main method.""" -``` - -/// admonition | Preview - type: preview - -//// tab | With inherited members -

    Module docstring.

    -

    Base

    -

    Base class.

    -

    base

    -

    Base method.

    -

    Main

    -

    Main class.

    -

    base

    -

    Base method.

    -

    main

    -

    Main method.

    -//// - -//// tab | Without inherited members -

    Module docstring.

    -

    Base

    -

    Base class.

    -

    base

    -

    Base method.

    -

    Main

    -

    Main class.

    -

    main

    -

    Main method.

    -//// - -/// - -[](){#option-members_order} -## `members_order` - -- **:octicons-package-24: Type `str | list[str]` :material-equal: `"alphabetical"`{ title="default value" }** - - -The members ordering to use. Possible values: - -- `__all__`: Order according to `__all__` attributes. Since classes do not define `__all__` attributes, you can specify a second ordering method by using a list. -- `alphabetical`: Order by the members names. -- `source`: Order members as they appear in the source file. - -The order applies for all members, recursively. -The order will be ignored for members that are explicitely sorted using the [`members`][] option. -**Note that members will still be grouped by category, -according to the [`group_by_category`][] option.** - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - members_order: alphabetical -``` - -```md title="or in docs/some_page.md (local configuration)" -::: package.module - options: - members_order: source -``` - -```md title="or in docs/some_page.md (local configuration)" -::: package.module - options: - members_order: [__all__, source] -``` - -```python title="package/module.py" -"""Module docstring.""" - - -def function_b(): - """Function a.""" - - -def function_a(): - """Function b.""" - - -def function_c(): - """Function c.""" -``` - -/// admonition | Preview - type: preview - -//// tab | With alphabetical order -

    Module docstring.

    -

    function_a

    -

    Function a.

    -

    function_b

    -

    Function b.

    -

    function_c

    -

    Function c.

    -//// - -//// tab | With source order -

    Module docstring.

    -

    function_b

    -

    Function b.

    -

    function_a

    -

    Function a.

    -

    function_c

    -

    Function c.

    -//// -/// - -[](){#option-filters} -## `filters` - -- **:octicons-package-24: Type list[str] | Literal["public"] | None :material-equal: `["!^_[^_]"]`{ title="default value" }** - - -A list of filters, or `"public"`. - -**Filtering methods** - -[](){#option-filters-public} - -The `public` filtering method will include only public objects: those added to the `__all__` attribute of modules, or not starting with a single underscore. Special methods and attributes ("dunder" methods/attributes, starting and ending with two underscores), like `__init__`, `__call__`, `__mult__`, etc., are always considered public. - -**List of filters** - -Filters are regular expressions. These regular expressions are evaluated by Python -and so must match the syntax supported by the [`re`][] module. -A filter starting with `!` (negative filter) will exclude matching objects instead of including them. - -The default value (`["!^_[^_]"]`) means: *render every object, except those -starting with one underscore, unless they start with two underscores*. -It means that an object whose name is `hello`, `__hello`, or `__hello__` -will be rendered, but not one whose name is `_hello`. - -Each filter takes precedence over the previous one. This allows for fine-grain -selection of objects by adding more specific filters. For example, you can -start by unselecting objects that start with `_`, and add a second filter -that re-select objects that start with `__`. The default filters can -therefore be rewritten like this: - -```yaml -filters: -- "!^_" -- "^__" -``` - -If there are no negative filters, the handler considers that everything -is **unselected** first, and then selects things based on your positive filters. -If there is at least one negative filter, the handler considers that everything -is **selected** first, and then re-selects/unselects things based on your other filters. -In short, `filters: ["a"]` means *"keep ***nothing*** except names containing `a`"*, while -`filters: ["!a"]` means *"keep ***everything*** except names containing `a`"*. - -An empty list of filters tells the Python handler to render every object. -The [`members`][] option takes precedence over filters -(filters will still be applied recursively to lower members in the hierarchy). - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - filters: - - "!^_[^_]" -``` - -```md title="or in docs/some_page.md (local configuration)" -::: package.module - options: - filters: public -``` - -```python title="package/module.py" -def hello(): - ... - - -def _world(): - ... -``` - -/// admonition | Preview - type: preview - -//// tab | With `filters: []` -

    Module docstring.

    -

    hello

    -

    Function docstring.

    -

    _world

    -

    Function docstring.

    -//// - -//// tab | With `filters: ["hello"]` -

    Module docstring.

    -

    hello

    -

    Function docstring.

    -//// - -//// tab | With `filters: ["!hello"]` -

    Module docstring.

    -

    _world

    -

    Function docstring.

    -//// -/// - -/// admonition | Common filters - type: tip - -Here are some common filters that you might to want to use. - -- `["!^_"]`: exclude all private/protected/special objects -- `["!^_", "^__init__$"]`: same as above, but keep `__init__` methods -- `["!^_[^_]"]`: exclude all private/protected objects, keep special ones (default filters) -/// - -[](){#option-group_by_category} -## `group_by_category` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Group the object members by categories: attributes, classes, functions, and modules. - -Members within a same category will be ordered according to the [`members_order`][] option. -You can use the [`show_category_heading`][] option to also render a heading for each category. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - group_by_category: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: package.module - options: - group_by_category: false -``` - -```python title="package/module.py" -def function_a(): - ... - - -class ClassB: - ... - - -attribute_C = 0 - - -def function_d(): - ... -``` - -/// admonition | Preview - type: preview - -//// tab | With category grouping -

    Module docstring.

    -

    attribute_c

    -

    Attribute docstring.

    -

    ClassB

    -

    Class docstring.

    -

    function_a

    -

    Function docstring.

    -

    function_d

    -

    Function docstring.

    -//// - -//// tab | Without category grouping -

    Module docstring.

    -

    function_a

    -

    Function docstring.

    -

    ClassB

    -

    Class docstring.

    -

    attribute_c

    -

    Attribute docstring.

    -

    function_d

    -

    Function docstring.

    -//// -/// - -[](){#option-show_submodules} -## `show_submodules` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -When rendering a module, show its submodules recursively. - -This is false by default, because most of the time we render only one module per page, -and when rendering a package (a tree of modules and their members) on a single page, -we quickly run out of [heading levels][heading_level]. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_submodules: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: package.subpackage - options: - show_submodules: false -``` - -```tree title="package" -package - __init__.py - subpackage - __init__.py - submodule.py -``` - -/// admonition | Preview - type: preview - -//// tab | With submodules -

    Subpackage docstring.

    -

    subpackage_member

    -

    Member docstring.

    -

    submodule

    -

    Submodule docstring.

    -

    submodule_member

    -

    Member docstring.

    -//// - -//// tab | Without submodules -

    Subpackage docstring.

    -

    subpackage_member

    -

    Member docstring.

    -//// -/// - -[](){#option-summary} -## `summary` - -- **:octicons-package-24: Type bool | dict[str, bool] :material-equal: `False`{ title="default value" }** - - -Whether to render summaries of modules, classes, functions (methods) and attributes. - -This option accepts a boolean (`yes`, `true`, `no`, `false` in YAML) -or a dictionary with one or more of the following keys: `attributes`, `functions`, `classes`, `modules`, `type_aliases`, -with booleans as values. Class methods summary is (de)activated with the `functions` key. -By default, `summary` is false, and by extension all values are false. - -Examples: - -```yaml -summary: true -``` - -```yaml -summary: false -``` - -```yaml -summary: - attributes: false - functions: true - modules: false -``` - -Summaries will be rendered as the corresponding docstring sections. -For example, the summary for attributes will be rendered as an Attributes docstring section. -The section will be rendered in accordance with the [`docstring_section_style`][] option. -If the objects appearing in the summary are also rendered on the page -(or somewhere else on the site), their name will automatically link to their rendered documentation. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - summary: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - summary: false -``` - -/// admonition | Preview - type: preview - -//// tab | With all summaries -``` -::: path.to.module.MyClass - options: - summary: true -``` -

    MyClass

    -

    Class docstring.

    -

    Methods:

    -
      -
    • my_method1: Summary of the method (first docstring line).
    • -
    • my_method2: Summary of the method (first docstring line).
    • -
    -

    Attributes:

    -
      -
    • attr1: Summary of the attribute (first docstring line).
    • -
    • attr2: Summary of the attribute (first docstring line).
    • -
    -//// - -//// tab | With methods summary only -``` -::: path.to.module.MyClass - options: - summary: - functions: true -``` - -

    MyClass

    -

    Class docstring.

    -

    Methods:

    -
      -
    • my_method1: Summary of the method (first docstring line).
    • -
    • my_method2: Summary of the method (first docstring line).
    • -
    -//// -/// - -[](){#option-show_labels} -## `show_labels` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Whether to show labels of the members. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_labels: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: package.module - options: - show_labels: false -``` - -```python title="package/module.py" -class SomeClass: - some_attr: int -``` - -/// admonition | Preview - type: preview - -//// tab | With labels - - some_attr: - int - -instance-attribute -//// - -//// tab | Without labels - - some_attr: - int - -//// -/// diff --git a/docs/usage/configuration/signatures.md b/docs/usage/configuration/signatures.md deleted file mode 100644 index 109362e3..00000000 --- a/docs/usage/configuration/signatures.md +++ /dev/null @@ -1,701 +0,0 @@ -# Signatures options - -[](){#option-annotations_path} -## `annotations_path` - -- **:octicons-package-24: Type [`str`][] :material-equal: `"brief"`{ title="default value" }** - - -The verbosity for annotations path. - -Possible values: - -- `brief` (recommended): render only the last component of each type path, not their full paths. - For example, it will render `Sequence[Path]` and not `typing.Sequence[pathlib.Path]`. - Brief annotations will cross-reference the right object anyway, - and show the full path in a tooltip when hovering them. -- `source`: render annotations as written in the source. For example if you imported `typing` as `t`, - it will render `typing.Sequence` as `t.Sequence`. Each part will cross-reference the relevant object: - `t` will link to the `typing` module and `Sequence` will link to the `Sequence` type. -- `full`: render annotations with their full path (the opposite of brief). - For example if you import `Sequence` and `Pattern` from `typing` and annoate something using - `Sequence[Pattern]`, it will render as `typing.Sequence[typing.Pattern]`, with each part - cross-referencing the corresponding object. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - annotations_path: brief -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - annotations_path: source -``` - - -/// admonition | Preview - type: preview - -//// tab | Brief annotations -```python -import markdown -import markupsafe - - -def convert(text: str, md: markdown.Markdown) -> markupsafe.Markup: - """Convert text to Markdown. - - Parameters: - text: The text to convert. - md: A Markdown instance. - - Returns: - Converted markup. - """ - return markupsafe.Markup(md.convert(text)) -``` - -

    convert(text, md)

    -

    Convert text to Markdown.

    -

    Parameters:

    - -**Type** | **Description** | **Default** ----------- | ------------------------ | ----------- -[`str`][] | The text to convert. | *required* -[`Markdown`](#ref-to-markdown){ .external title="markdown.Markdown" } | A Markdown instance. | *required* - -

    Returns:

    - -**Type** | **Name** | **Description** ----------- | ----------- | --------------- -[`Markup`](#ref-to-markup){ .external title="markupsafe.Markup" } | `text` | Converted markup. -//// - -//// tab | Source annotations -```python -import markdown -from markupsafe import Markup - - -def convert(text: str, md: markdown.Markdown) -> Markup: - """Convert text to Markdown. - - Parameters: - text: The text to convert. - md: A Markdown instance. - - Returns: - Converted markup. - """ - return Markup(md.convert(text)) -``` - -

    convert(text, md)

    -

    Convert text to Markdown.

    -

    Parameters:

    - -**Type** | **Description** | **Default** ----------- | ------------------------ | ----------- -[`str`][] | The text to convert. | *required* -markdown.Markdown | A Markdown instance. | *required* - -

    Returns:

    - -**Type** | **Name** | **Description** ----------- | ----------- | --------------- -[`Markup`](#ref-to-markup){ .external title="markupsafe.Markup" } | `text` | Converted markup. -//// - -//// tab | Full annotations -```python -from markdown import Markdown -from markupsafe import Markup - - -def convert(text: str, md: Markdown) -> Markup: - """Convert text to Markdown. - - Parameters: - text: The text to convert. - md: A Markdown instance. - - Returns: - Converted markup. - """ - return Markup(md.convert(text)) -``` - -

    convert(text, md)

    -

    Convert text to Markdown.

    -

    Parameters:

    - -**Type** | **Description** | **Default** ----------- | ------------------------ | ----------- -[`str`][] | The text to convert. | *required* -markdown.Markdown | A Markdown instance. | *required* - -

    Returns:

    - -**Type** | **Name** | **Description** ----------- | ----------- | --------------- -markupsafe.Markup | `text` | Converted markup. -//// -/// - -[](){#option-line_length} -## `line_length` - -- **:octicons-package-24: Type [`int`][] :material-equal: `60`{ title="default value" }** - - -Maximum line length when formatting code/signatures. - -When separating signatures from headings with the [`separate_signature`][] option, -the Python handler will try to format the signatures using a formatter and -the specified line length. - -The handler will automatically try to format using : - -1. [Black] -2. [Ruff] - -If a formatter is not found, the handler issues an INFO log once. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - separate_signature: true - line_length: 60 -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - separate_signature: true - line_length: 80 -``` - -/// admonition | Preview - type: preview - -//// tab | Line length 60 -

    long_function_name

    -
    long_function_name(
    -    long_parameter_1="hello",
    -    long_parameter_2="world",
    -)
    -//// - -//// tab | Line length 80 -

    long_function_name

    -
    long_function_name(long_parameter_1="hello", long_parameter_2="world")
    -//// -/// - -[](){#option-modernize_annotations} -## `modernize_annotations` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -Modernize annotations with latest features and PEPs of the Python language. - -The Python language keeps evolving, and often library developers -must continue to support a few minor versions of Python. -Therefore they cannot use some features that were introduced -in the latest versions. - -Yet this doesn't mean they can't enjoy latest features in their docs: -Griffe allows to "modernize" expressions, for example -by replacing `typing.Union` with [PEP 604][pep-604] type unions `|`. -Thanks to this, mkdocstrings' Python handler -can automatically transform type annotations into their modern equivalent. -This improves consistency in your docs, and shows users -how to use your code with the latest features of the language. - -[pep-604]: https://peps.python.org/pep-0604/ - -Modernizations applied: - -- `typing.Dict[A, B]` becomes `dict[A, B]` -- `typing.List[A]` becomes `list[A]` -- `typing.Set[A]` becomes `set[A]` -- `typing.Tuple[A]` becomes `tuple[A]` -- `typing.Union[A, B]` becomes `A | B` -- `typing.Optional[A]` becomes `A | None` - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - modernize_annotations: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.object - options: - modernize_annotations: false -``` - -/// admonition | Preview - type: preview - -```python ---8<-- "docs/snippets/package/modern.py" -``` - -//// tab | Unchanged annotations - -```md exec="on" -::: package.modern.example - options: - modernize_annotations: false - show_symbol_type_heading: false - show_labels: false -``` - -//// - -//// tab | Modernized annotations - -```md exec="on" -::: package.modern.example - options: - modernize_annotations: true - show_symbol_type_heading: false - show_labels: false -``` - -//// - -/// - -[](){#option-overloads_only} -## `overloads_only` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - -Whether to hide the implementation signature if the overloads are shown with [`show_overloads`][]. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - overloads_only: false -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - overloads_only: true -``` - -/// admonition | Preview - type: preview -//// tab | With overloads only -

    function

    - -```python -@overload -function(param1: int): ... -@overload -function(param1: str): ... -``` -Function docstring. - -//// -//// tab | Without overloads only -

    function

    - -```python -@overload -function(param1: int): ... -@overload -function(param1: str): ... -function(param1: str | int) -``` -Function docstring. - -//// - -/// - -[](){#option-show_signature} -## `show_signature` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Show methods and functions signatures. - -Without it, just the function/method name is rendered. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_signature: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - show_signature: false -``` - -/// admonition | Preview - type: preview - -//// tab | With signature -

    function(param1, param2=None)

    -

    Function docstring.

    -//// - -//// tab | Without signature -

    function

    -

    Function docstring.

    -//// -/// - -[](){#option-show_signature_annotations} -## `show_signature_annotations` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -Show the type annotations in methods and functions signatures. - -Since the heading can become quite long when annotations are rendered, -it is usually best to [separate the signature][separate_signature] from the heading. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - separate_signature: true - show_signature_annotations: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - separate_signature: true - show_signature_annotations: false -``` - -/// admonition | Preview - type: preview - -//// tab | With signature annotations -

    function

    - -```python -function( - param1: list[int | float], - param2: bool | None = None, -) -> float -``` - -

    Function docstring.

    -//// - -//// tab | Without signature annotations -

    function

    - -```python -function(param1, param2=None) -``` - -

    Function docstring.

    -//// -/// - -[](){#option-show_signature_type_parameters} -## `show_signature_type_parameters` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -Show the type parameters in generic classes, methods, functions and type aliases -signatures. - -Since the heading can become quite long when type parameters are rendered, it is -usually best to [separate the signature][separate_signature] from the heading. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - separate_signature: true - show_signature_annotations: true - show_signature_type_parameters: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - separate_signature: true - show_signature_annotations: true - show_signature_type_parameters: false -``` - -/// admonition | Preview - type: preview - -//// tab | With signature type parameters -

    function

    - -```python -function[T, *R](param: T) -> tuple[*R] -``` - -

    Function docstring.

    -//// - -//// tab | Without signature type parameters -

    function

    - -```python -function(param: T) -> tuple[*R] -``` - -

    Function docstring.

    -//// -/// - -[](){#option-separate_signature} -## `separate_signature` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -Whether to put the whole signature in a code block below the heading. - -When separating signatures from headings, -the Python handler will try to format the signatures using a formatter and -the specified [line length][line_length]. - -The handler will automatically try to format using : - -1. [Black] -2. [Ruff] - -If a formatter is not found, the handler issues an INFO log once. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - separate_signature: false -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - separate_signature: true -``` - -/// admonition | Preview - type: preview - -//// tab | With separate signature -

    function

    - -```python -function(param1, param2=None) -``` - -

    Function docstring.

    -//// - -//// tab | Without separate signature -

    function(param1, param2=None)

    -

    Function docstring.

    -//// -/// - -[](){#option-show_attribute_values} -## `show_attribute_values` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - - -Show initial values of attributes in classes. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_attribute_values: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.object - options: - show_attribute_values: true -``` - -```python title="package/module.py" -class SomeClass: - def __init__(self): - self.some_attr = 1 -``` - -/// admonition | Preview - type: preview - -//// tab | With attribute values visible -

    SomeClass

    -

    some_attr = 1

    -//// - -//// tab | With attribute values hidden -

    SomeClass

    -

    some_attr

    -//// -/// - -[](){#option-show_overloads} -## `show_overloads` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** - -Whether to render function / method overloads. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - show_overloads: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - show_overloads: false -``` - -/// admonition | Preview - type: preview -//// tab | With overloads -

    function

    - - -```python -@overload -function(param1: int): ... - -@overload -function(param1: str): ... - -function(param1: str | int) -``` -Function docstring. - -//// -//// tab | Without overloads -

    function

    - -```python -function(param1: str | int) -``` -Function docstring. - -//// -/// - -[](){#option-signature_crossrefs} -## `signature_crossrefs` - -Whether to render cross-references for type annotations in signatures. - -When signatures are separated from headings with the [`separate_signature`][] option -and type annotations are shown with the [`show_signature_annotations`][] option, -this option will render a cross-reference (link) for each type annotation in the signature. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - separate_signature: true - show_signature_annotations: true - signature_crossrefs: false -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - separate_signature: true - show_signature_annotations: true - signature_crossrefs: true -``` - -/// admonition | Preview - type: preview - -//// tab | With signature cross-references -

    do_format_code

    -
    do_format_code(code: str, line_length: int) -> str
    -
    -

    Function docstring.

    -//// - -//// tab | Without signature cross-references -

    do_format_code

    -
    do_format_code(code: str, line_length: int) -> str
    -
    -

    Function docstring.

    -//// -/// - -[](){#option-unwrap_annotated} -## `unwrap_annotated` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -Whether to unwrap [`Annotated`](https://docs.python.org/3/library/typing.html#typing.Annotated){ .external } -types to show only the type without the annotations. - -For example, unwrapping `Annotated[int, Gt(10)]` will render `int`. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - unwrap_annotated: false -``` - -```md title="or in docs/some_page.md (local configuration)" -::: path.to.module - options: - unwrap_annotated: true -``` diff --git a/docs/usage/customization.md b/docs/usage/customization.md deleted file mode 100644 index d1e66b31..00000000 --- a/docs/usage/customization.md +++ /dev/null @@ -1,496 +0,0 @@ -# Customization - -It is possible to customize the output of the generated documentation with CSS -and/or by overriding templates. - -## CSS classes - -Our templates add [CSS](https://www.w3schools.com/Css/) classes to many HTML elements -to make it possible for users to customize the resulting look and feel. - -To add CSS rules and style mkdocstrings' output, -put them in a CSS file in your docs folder, for example in `docs/css/mkdocstrings.css`, -and reference this file in [MkDocs' `extra_css` configuration option](https://www.mkdocs.org/user-guide/configuration/#extra_css): - -```yaml title="mkdocs.yml" -extra_css: -- css/mkdocstrings.css -``` - -Example: - -```css title="docs/css/mkdocstrings.css" -.doc-section-title { - font-weight: bold; -} -``` - -The following CSS classes are used in the generated HTML: - -- `doc`: on all the following elements -- `doc-children`: on `div`s containing the children of an object -- `doc-object`: on `div`s containing an object - - `doc-attribute`: on `div`s containing an attribute - - `doc-class`: on `div`s containing a class - - `doc-function`: on `div`s containing a function - - `doc-module`: on `div`s containing a module - - `doc-type_alias`: on `div`s containing a type alias -- `doc-heading`: on objects headings - - `doc-object-name`: on `span`s wrapping objects names/paths in the heading - - `doc-KIND-name`: as above, specific to the kind of object (module, class, function, attribute, type_alias) -- `doc-contents`: on `div`s wrapping the docstring then the children (if any) - - `first`: same, but only on the root object's contents `div` -- `doc-labels`: on `span`s wrapping the object's labels - - `doc-label`: on `small` elements containing a label - - `doc-label-LABEL`: same, where `LABEL` is replaced by the actual label -- `doc-section-title`: on section titles (depend on the [selected style for section rendering][docstring_style]) -- `doc-section-item`: on section items (depend on the [selected style for section rendering][docstring_style]) -- `doc-md-description`: on `div`s containing HTML descriptions converted from Markdown docstrings -- `doc-symbol`: on `code` tags of symbol types - - `doc-symbol-heading`: on symbol types in headings - - `doc-symbol-toc`: on symbol types in the ToC - - `doc-symbol-KIND`: specific to the kind of object (`module`, `class`, `function`, `method`, `attribute`, `type_alias`) - -/// admonition | Example with colorful labels - type: example - -//// tab | CSS -```css -.doc-label { border-radius: 15px; padding: 2px 8px; font-weight: bold; } -.doc-label-special { background-color: #3330E4; color: white; } -.doc-label-private { background-color: #F637EC; color: white; } -.doc-label-property { background-color: #FBB454; color: black; } -.doc-label-read-only { background-color: #FAEA48; color: black; } -``` -//// - -//// tab | Result - -

    -

    - special - private - property - read-only -

    -

    -//// - -/// - -## Symbol types - -### Colors - -You can customize the colors of the symbol types -(see [`show_symbol_type_heading`][show_symbol_type_heading] and [`show_symbol_type_toc`][show_symbol_type_toc]) -by overriding the values of our CSS variables, for example: - -```css title="docs/css/mkdocstrings.css" -[data-md-color-scheme="default"] { - --doc-symbol-parameter-fg-color: #df50af; - --doc-symbol-type_parameter-fg-color: #df50af; - --doc-symbol-attribute-fg-color: #0079ff; - --doc-symbol-function-fg-color: #00dfa2; - --doc-symbol-method-fg-color: #00dfa2; - --doc-symbol-class-fg-color: #d1b619; - --doc-symbol-type_alias-fg-color: #d1b619; - --doc-symbol-module-fg-color: #ff0060; - - --doc-symbol-parameter-bg-color: #df50af1a; - --doc-symbol-type_parameter-bg-color: #df50af1a; - --doc-symbol-attribute-bg-color: #0079ff1a; - --doc-symbol-function-bg-color: #00dfa21a; - --doc-symbol-method-bg-color: #00dfa21a; - --doc-symbol-class-bg-color: #d1b6191a; - --doc-symbol-type_alias-bg-color: #d1b6191a; - --doc-symbol-module-bg-color: #ff00601a; -} - -[data-md-color-scheme="slate"] { - --doc-symbol-parameter-fg-color: #ffa8cc; - --doc-symbol-type_parameter-fg-color: #ffa8cc; - --doc-symbol-attribute-fg-color: #963fb8; - --doc-symbol-function-fg-color: #6d67e4; - --doc-symbol-method-fg-color: #6d67e4; - --doc-symbol-class-fg-color: #46c2cb; - --doc-symbol-type_alias-fg-color: #46c2cb; - --doc-symbol-module-fg-color: #f2f7a1; - - --doc-symbol-parameter-bg-color: #ffa8cc1a; - --doc-symbol-type_parameter-bg-color: #ffa8cc1a; - --doc-symbol-attribute-bg-color: #963fb81a; - --doc-symbol-function-bg-color: #6d67e41a; - --doc-symbol-method-bg-color: #6d67e41a; - --doc-symbol-class-bg-color: #46c2cb1a; - --doc-symbol-type_alias-bg-color: #46c2cb1a; - --doc-symbol-module-bg-color: #f2f7a11a; -} -``` - -The `[data-md-color-scheme="*"]` selectors work with the [Material for MkDocs] theme. -If you are using another theme, adapt the selectors to this theme -if it supports light and dark themes, -otherwise just override the variables at root level: - -```css title="docs/css/mkdocstrings.css" -:root { - --doc-symbol-parameter-fg-color: #df50af; - --doc-symbol-type_parameter-fg-color: #df50af; - --doc-symbol-attribute-fg-color: #0079ff; - --doc-symbol-function-fg-color: #00dfa2; - --doc-symbol-method-fg-color: #00dfa2; - --doc-symbol-class-fg-color: #d1b619; - --doc-symbol-type_alias-fg-color: #d1b619; - --doc-symbol-module-fg-color: #ff0060; - - --doc-symbol-parameter-bg-color: #df50af1a; - --doc-symbol-type_parameter-bg-color: #df50af1a; - --doc-symbol-attribute-bg-color: #0079ff1a; - --doc-symbol-function-bg-color: #00dfa21a; - --doc-symbol-method-bg-color: #00dfa21a; - --doc-symbol-class-bg-color: #d1b6191a; - --doc-symbol-type_alias-bg-color: #d1b6191a; - --doc-symbol-module-bg-color: #ff00601a; -} -``` - -/// admonition | Preview - type: preview - -
    - -

    - Try cycling through the themes to see the colors for each theme: - - - - - - -

    -
    - -/// - -### Names - -You can also change the actual symbol names. -For example, to use single letters instead of truncated types: - -```css title="docs/css/mkdocstrings.css" -.doc-symbol-parameter::after { - content: "P"; -} - -.doc-symbol-type_parameter::after { - content: "P"; -} - -.doc-symbol-attribute::after { - content: "A"; -} - -.doc-symbol-function::after { - content: "F"; -} - -.doc-symbol-method::after { - content: "M"; -} - -.doc-symbol-class::after { - content: "C"; -} - -.doc-symbol-type_alias::after { - content: "T"; -} - -.doc-symbol-module::after { - content: "M"; -} -``` - -/// admonition | Preview - type: preview - -
    - -
      -
    • Parameter:
    • -
    • Type Parameter:
    • -
    • Attribute:
    • -
    • Function:
    • -
    • Method:
    • -
    • Class:
    • -
    • Type Alias:
    • -
    • Module:
    • -
    -
    - -/// - -## Templates - -Templates are organized into the following tree: - -```python exec="1" result="tree" -from pathlib import Path - -basedir = "src/mkdocstrings_handlers/python/templates/material" -print("theme/") -for filepath in sorted(path for path in Path(basedir).rglob("*") if "_base" not in str(path) and path.suffix != ".css"): - print( - " " * (len(filepath.relative_to(basedir).parent.parts) + 1) - + filepath.name - + ("/" if filepath.is_dir() else "") - ) -``` - -See them [in the repository](https://github.com/mkdocstrings/python/tree/main/src/mkdocstrings_handlers/python/templates/). -See the general *mkdocstrings* documentation to learn how to override them: https://mkdocstrings.github.io/theming/#templates. - -Each one of these templates extends a base version in `theme/_base`. Example: - -```html+jinja title="theme/class.html" -{% extends "_base/class.html" %} -``` - -Some of these templates define [Jinja blocks](https://jinja.palletsprojects.com/en/3.0.x/templates/#template-inheritance). -allowing to customize only *parts* of a template -without having to fully copy-paste it into your project: - -```jinja title="templates/theme/class.html" -{% extends "_base/class.html" %} -{% block contents %} - {{ block.super }} - Additional contents -{% endblock contents %} -``` - -### Available blocks - -Only the templates for the **Material for MkDocs** provide Jinja blocks. -The following tables show the block names, description, -and the Jinja context available in their scope. - -#### `module.html` - -- `heading`: The module heading. -- `labels`: The module labels. -- `contents`: The module contents: docstring and children blocks. -- `docstring`: The module docstring. -- `summary`: The automatic summaries of members. -- `children`: The module children. - -Available context: - -- `config`: The handler configuration (dictionary). -- `module`: The [Module][griffe.Module] instance. - -#### `type_alias.html` - -- `heading`: The class heading. -- `labels`: The class labels. -- `signature`: The class signature. -- `contents`: The class contents: bases, docstring, source and children blocks. -- `docstring`: The class docstring. - -Available context: - -- `config`: The handler configuration (dictionary). -- `type_alias`: The [TypeAlias][griffe.TypeAlias] instance. - -#### `class.html` - -- `heading`: The class heading. -- `labels`: The class labels. -- `signature`: The class signature. -- `contents`: The class contents: bases, docstring, source and children blocks. -- `bases`: The class bases. -- `docstring`: The class docstring. -- `summary`: The automatic summaries of members. -- `source`: The class source code. -- `children`: The class children. - -Available context: - -- `config`: The handler configuration (dictionary). -- `class`: The [Class][griffe.Class] instance. - -#### `function.html` - -- `heading`: The function heading. -- `labels`: The function labels. -- `signature`: The function signature. -- `contents`: The function contents: docstring and source blocks. -- `docstring`: The function docstring. -- `source`: The function source code. - -Available context: - -- `config`: The handler configuration (dictionary). -- `function`: The [Function][griffe.Function] instance. - -#### `attribute.html` - -- `heading`: The attribute heading. -- `labels`: The attribute labels. -- `signature`: The attribute signature. -- `contents`: The attribute contents: docstring block. -- `docstring`: The attribute docstring. - -Available context: - -- `config`: The handler configuration (dictionary). -- `attribute`: The [Attribute][griffe.Attribute] instance. - -#### Docstring sections - -In `docstring/attributes.html`, -`docstring/functions.html`, -`docstring/classes.html`, -`docstring/modules.html`, -`docstring/other_parameters.html`, -`docstring/parameters.html`, -`docstring/raises.html`, -`docstring/receives.html`, -`docstring/returns.html`, -`docstring/type_aliases.html`, -`docstring/type_parameters.html`, -`docstring/warns.html`, -and `docstring/yields.html`: - -- `table_style`: The section as a table. -- `list_style`: The section as a list. -- `spacy_style`: The section as a Spacy table. - -Available context: - -- `section`: The [DocstringSection][griffe.DocstringSection] instance (see `DocstringSection*` subclasses). - -### Syntax highlight in signatures - -You can customize the colors in syntax highlighted signatures. -If you are using the [Material for MkDocs] theme, -here are some customization examples: - -```css -/* Fancier color for operators such as * and |. */ -.doc-signature .o { - color: var(--md-code-hl-special-color); -} - -/* Fancier color for constants such as None, True, and False. */ -.doc-signature .kc { - color: var(--md-code-hl-constant-color); -} - -/* Fancier color for built-in types (only useful when cross-references are used). */ -.doc-signature .n > a[href^="https://docs.python.org/"][href*="/functions.html#"], -.doc-signature .n > a[href^="https://docs.python.org/"][href*="/stdtypes.html#"] { - color: var(--md-code-hl-constant-color); -} -``` - -For other themes, use their own CSS variables, -or use plain colors such as `violet` or `#2987f2`. - -## Style recommendations - -[](){#recommended-style-material} -### Material - -Here are some CSS rules for the [Material for MkDocs] theme: - -```css ---8<-- "docs/css/mkdocstrings.css" -``` - -[](){#recommended-style-readthedocs} -### ReadTheDocs - -Here are some CSS rules for the built-in ReadTheDocs theme: - -```css -/* Indentation. */ -div.doc-contents:not(.first) { - padding-left: 25px; - border-left: .05rem solid rgba(200, 200, 200, 0.2); -} -``` diff --git a/docs/usage/docstrings/google.md b/docs/usage/docstrings/google.md deleted file mode 100644 index 1c843a3b..00000000 --- a/docs/usage/docstrings/google.md +++ /dev/null @@ -1,28 +0,0 @@ -# Google style - -## :warning: Work in Progress! - -### Google-style admonitions - -With Google-style docstrings, any section that is not recognized will be transformed into its admonition equivalent. -For example: - -=== "Docstring" - ```python - """ - Note: - It looks like a section, but it will be rendered as an admonition. - - Tip: You can even choose a title. - This admonition has a custom title! - """ - ``` - -=== "Result" - NOTE: It looks like a section, but it will be rendered as an admonition. - - TIP: **You can even choose a title.** - This admonition has a custom title! - -See [Napoleon's documentation](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html). -See the supported docstring sections on [Griffe's documentation](https://mkdocstrings.github.io/griffe/docstrings/). diff --git a/docs/usage/docstrings/numpy.md b/docs/usage/docstrings/numpy.md deleted file mode 100644 index 524bfbfe..00000000 --- a/docs/usage/docstrings/numpy.md +++ /dev/null @@ -1,11 +0,0 @@ -# Numpydoc style - -## :warning: Work in Progress! - -NOTE: As Numpy-style is partially supported by the underlying parser, -you may experience problems in the building process if your docstring -has a `Methods` section in the class docstring -(see [#366](https://github.com/mkdocstrings/mkdocstrings/issues/366)). - -See [Numpydoc's documentation](https://numpydoc.readthedocs.io/en/latest/format.html). -See the supported docstring sections on [Griffe's documentation](https://mkdocstrings.github.io/griffe/docstrings/). diff --git a/docs/usage/docstrings/sphinx.md b/docs/usage/docstrings/sphinx.md deleted file mode 100644 index bf88c19b..00000000 --- a/docs/usage/docstrings/sphinx.md +++ /dev/null @@ -1,6 +0,0 @@ -# Sphinx style - -## :warning: Work in Progress! - -See [Sphinx's documentation](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html). -See the supported docstring sections on [Griffe's documentation](https://mkdocstrings.github.io/griffe/docstrings/). diff --git a/docs/usage/extensions.md b/docs/usage/extensions.md deleted file mode 100644 index 4f6b96b3..00000000 --- a/docs/usage/extensions.md +++ /dev/null @@ -1,17 +0,0 @@ -# Extensions - -## :warning: Work in Progress! - -The Python handler supports extensions through -[*mkdocstrings*' handler extensions](https://mkdocstrings.github.io/usage/handlers/#handler-extensions). - -Specifically, additional templates can be added to the handler, -and Griffe extensions can instruct the handler to use a particular template -for a particular object by setting a value in the Griffe object's `extra` dictionary: - -```python title="griffe_extension.py" -obj = ... # get a reference to a Griffe object -if "mkdocstrings" not in obj.extra: - obj.extra["mkdocstrings"] = {} -obj.extra["mkdocstrings"]["template"] = "template_name.html" -``` diff --git a/docs/usage/index.md b/docs/usage/index.md deleted file mode 100644 index 3348a627..00000000 --- a/docs/usage/index.md +++ /dev/null @@ -1,486 +0,0 @@ -# Usage - -TIP: **This is the documentation for the NEW Python handler.** -To read the documentation for the LEGACY handler, -go to the [legacy handler documentation](https://mkdocstrings.github.io/python-legacy). - -## Installation - -You can install this handler as a *mkdocstrings* extra: - -```toml title="pyproject.toml" -# PEP 621 dependencies declaration -# adapt to your dependencies manager -[project] -dependencies = [ - "mkdocstrings[python]>=0.18", -] -``` - -You can also explicitly depend on the handler: - -```toml title="pyproject.toml" -# PEP 621 dependencies declaration -# adapt to your dependencies manager -[project] -dependencies = [ - "mkdocstrings-python", -] -``` - -The Python handler is the default *mkdocstrings* handler. -You can change the default handler, -or explicitely set the Python handler as default by defining the `default_handler` -configuration option of `mkdocstrings` in `mkdocs.yml`: - -```yaml title="mkdocs.yml" -plugins: -- mkdocstrings: - default_handler: python -``` - -## Injecting documentation - -With the Python handler installed and configured as default handler, -you can inject documentation for a module, class, function, or any other Python object -with *mkdocstrings*' [autodoc syntax], in your Markdown pages: - -```md -::: path.to.object -``` - -If another handler was defined as default handler, -you can explicitely ask for the Python handler to be used when injecting documentation -with the `handler` option: - -```md -::: path.to.object - handler: python -``` - -## Configuration - -When installed, the Python handler becomes the default *mkdocstrings* handler. -You can configure it in `mkdocs.yml`: - -```yaml title="mkdocs.yml" -plugins: -- mkdocstrings: - handlers: - python: - ... # the Python handler configuration -``` - -### Global-only options - -Some options are **global only**, and go directly under the handler's name. - -[](){#setting-inventories} -#### `inventories` - -This option is used to load Sphinx-compatible objects inventories from other -documentation sites. For example, you can load the standard library -objects inventory like this: - -```yaml title="mkdocs.yml" -plugins: -- mkdocstrings: - handlers: - python: - inventories: - - https://docs.python.org/3/objects.inv -``` - -When loading an inventory, you enable automatic cross-references -to other documentation sites like the standard library docs -or any third-party package docs. Typically, you want to load -the inventories of your project's dependencies, at least those -that are used in the public API. - -See [*mkdocstrings*' documentation on inventories][inventories] -for more details. - - [inventories]: https://mkdocstrings.github.io/usage/#cross-references-to-other-projects-inventories - -Additionally, the Python handler accepts a `domains` option in the inventory options, -which allows to select the inventory domains to load. -By default the Python handler only selects the `py` domain (for Python objects). -You might find useful to also enable the [`std` domain][std domain]: - - [std domain]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-standard-domain - -```yaml title="mkdocs.yml" -plugins: -- mkdocstrings: - handlers: - python: - inventories: - - url: https://docs.python-requests.org/en/master/objects.inv - domains: [std, py] -``` - -[](){#setting-load_external_modules} -#### `load_external_modules` - -This option allows resolving aliases (imports) to any external module. -Modules are considered external when they are not part -of the package your are injecting documentation for. -Setting this option to `True` will tell the handler to resolve aliases recursively -when they are made public through the [`__all__`][__all__] variable. -By default, the handler will only resolve aliases when they point at a private sibling -of the source package, for example aliases going from `ast` to `_ast`. -Set `load_external_modules` to `False` to prevent even that. - -WARNING: **Use with caution** -This can load a *lot* of modules through [Griffe], -slowing down your build or triggering errors that Griffe does not yet handle. -**We recommend using the [`preload_modules`][] option instead**, -which acts as an include-list rather than as include-all. - -Example: - -```yaml title="mkdocs.yml" -plugins: -- mkdocstrings: - handlers: - python: - load_external_modules: true -``` - - [__all__]: https://docs.python.org/3/tutorial/modules.html#importing-from-a-package - -[](){#setting-locale} -#### ~~`locale`~~ - -**Deprecated.** Use mkdocstrings' own `locale` setting. - -~~The locale to use when translating template strings.~~ - -[](){#setting-paths} -#### `paths` - -This option is used to provide filesystem paths in which to search for Python modules. -Non-absolute paths are computed as relative to MkDocs configuration file. Example: - -```yaml title="mkdocs.yml" -plugins: -- mkdocstrings: - handlers: - python: - paths: [src] # search packages in the src folder -``` - -More details at [Finding modules](#finding-modules). - -[](){#setting-options} -### Global/local options - -The other options can be used both globally *and* locally, under the `options` key. -For example, globally: - -```yaml title="mkdocs.yml" -plugins: -- mkdocstrings: - handlers: - python: - options: - do_something: true -``` - -...and locally, overriding the global configuration: - -```md title="docs/some_page.md" -::: package.module.class - options: - do_something: false -``` - -These options affect how the documentation is collected from sources and rendered. -See the following tables summarizing the options, and get more details for each option -in the following pages: - -- [General options](configuration/general.md): various options that do not fit in the other categories -- [Headings options](configuration/headings.md): options related to headings and the table of contents - (or sidebar, depending on the theme used) -- [Members options](configuration/members.md): options related to filtering or ordering members - in the generated documentation -- [Docstrings options](configuration/docstrings.md): options related to docstrings (parsing and rendering) -- [Signature options](configuration/signatures.md): options related to signatures and type annotations - -## Finding modules - -There are multiple ways to tell the handler where to find your packages/modules. - -**The recommended method is to use the `paths` option, as it's the only one -that works with the `-f` option of MkDocs, allowing to build the documentation -from any location on the file system.** Indeed, the paths provided with the -`paths` option are computed as relative to the configuration file (mkdocs.yml), -so that the current working directory has no impact on the build process: -*you can build the docs from any location on your filesystem*. - -### Using the `paths` option - -TIP: **This is the recommended method.** - -1. mkdocs.yml in root, package in root - ```tree - root/ - mkdocs.yml - package/ - ``` - - ```yaml title="mkdocs.yml" - plugins: - - mkdocstrings: - handlers: - python: - paths: [.] # actually not needed, default - ``` - -1. mkdocs.yml in root, package in subfolder - ```tree - root/ - mkdocs.yml - src/ - package/ - ``` - - ```yaml title="mkdocs.yml" - plugins: - - mkdocstrings: - handlers: - python: - paths: [src] - ``` - -1. mkdocs.yml in subfolder, package in root - ```tree - root/ - docs/ - mkdocs.yml - package/ - ``` - - ```yaml title="mkdocs.yml" - plugins: - - mkdocstrings: - handlers: - python: - paths: [..] - ``` - -1. mkdocs.yml in subfolder, package in subfolder - ```tree - root/ - docs/ - mkdocs.yml - src/ - package/ - ``` - - ```yaml title="mkdocs.yml" - plugins: - - mkdocstrings: - handlers: - python: - paths: [../src] - ``` - -Except for case 1, which is supported by default, **we strongly recommend -setting the path to your packages using this option, even if it works without it** -(for example because your project manager automatically adds `src` to PYTHONPATH), -to make sure anyone can build your docs from any location on their filesystem. - -### Using the PYTHONPATH environment variable - -WARNING: **This method has limitations.** -This method might work for you, with your current setup, -but not for others trying your build your docs with their own setup/environment. -We recommend using the [`paths` method](#using-the-paths-option) instead. - -You can take advantage of the usual Python loading mechanisms. -In Bash and other shells, you can run your command like this -(note the prepended `PYTHONPATH=...`): - -1. mkdocs.yml in root, package in root - ```tree - root/ - mkdocs.yml - package/ - ``` - - ```bash - PYTHONPATH=. mkdocs build # actually not needed, default - ``` - -1. mkdocs.yml in root, package in subfolder - ```tree - root/ - mkdocs.yml - src/ - package/ - ``` - - ```bash - PYTHONPATH=src mkdocs build - ``` - -1. mkdocs.yml in subfolder, package in root - ```tree - root/ - docs/ - mkdocs.yml - package/ - ``` - - ```bash - PYTHONPATH=. mkdocs build -f docs/mkdocs.yml - ``` - -1. mkdocs.yml in subfolder, package in subfolder - ```tree - root/ - docs/ - mkdocs.yml - src/ - package/ - ``` - - ```bash - PYTHONPATH=src mkdocs build -f docs/mkdocs.yml - ``` - -### Installing your package in the current Python environment - -WARNING: **This method has limitations.** -This method might work for you, with your current setup, -but not for others trying your build your docs with their own setup/environment. -We recommend using the [`paths` method](#using-the-paths-option) instead. - -Install your package in the current environment, and run MkDocs: - -/// tab | pip -```bash -. venv/bin/activate -pip install -e . -mkdocs build -``` -/// - -/// tab | PDM -```bash -pdm install -pdm run mkdocs build -``` -/// - -/// tab | Poetry -```bash -poetry install -poetry run mkdocs build -``` -/// - -## Recommended settings - -If you're in a hurry, here is the configuration we recommend for the Python handler. - -```yaml -- mkdocstrings: - handlers: - python: - - # Where to find your sources, see "Finding modules". - paths: [src] - - # Load object inventories to enable cross-references to other projects. - inventories: - - https://docs.python.org/3/objects.inv - # Also load inventories of your dependencies, generally served at - # https://docs-url-for-your-dependency/objects.inv. - - options: - - # DOCSTRINGS ------------------------------------------------------------- - docstring_options: - # Discard first line of `__init__` method docstrings, - # useful when merging such docstrings into their parent class'. - ignore_init_summary: true - - # Tables are generally too large, lists will fix this. - docstring_section_style: list - - # CROSS-REFERENCES ------------------------------------------------------- - # Enable relative crossrefs and scoped crossrefs, see Docstrings options. - relative_crossrefs: true # Sponsors only! - scoped_crossrefs: true # Sponsors only! - - # Enable cross-references in signatures. - signature_crossrefs: true - - # Unwrap actual types from `Annotated` type annotations. - unwrap_annotated: true - - # MEMBERS ---------------------------------------------------------------- - # Only render pulic symbols. - filters: public # Sponsors only! - # Comment the option otherwise to get the default filters. - - # Show class inherited members. - inherited_members: true - - # Render auto-generated summaries of attributes, functions, etc. - # at the start of each symbol's documentation. - summary: true - - # HEADINGS --------------------------------------------------------------- - # For auto-generated pages, one module per page, - # make the module heading be the H1 heading of the page. - heading_level: 1 - - # Render headings for parameters, making them linkable. - parameter_headings: true - - # Render headings for type parameters too. - type_parameter_headings: true - - # Always show the heading for the symbol you render with `::: id`. - show_root_heading: true - - # Only show the name of the symbols you inject render `::: id`. - show_root_full_path: false - - # Show the type of symbol (class, function, etc.) in the heading. - show_symbol_type_heading: true - - # Show the type of symbol (class, function, etc.) in the table of contents. - show_symbol_type_toc: true - - # SIGNATURES ------------------------------------------------------------- - # Format code to 80 + 10% margin (Black and Ruff defaults) - # in signatures and attribute value code blocks. - # Needs Black/Ruff installed. - line_length: 88 - - # Merge signature and docstring of `__init__` methods - # into their parent class signature and docstring. - merge_init_into_class: true - - # Render signatures and attribute values in a separate code block, - # below the symbol heading. - separate_signature: true - - # Show type annotations in signatures. - show_signature_annotations: true - - # Show type parameters in signatures. - show_signature_type_parameters: true - - # OTHER ------------------------------------------------------------------ - # Show backlinks to other documentation sections within each symbol. - backlinks: tree # Sponsors only! - - # Show base classes OR inheritance diagram. - show_bases: false - show_inheritance_diagram: true # Sponsors only! -``` diff --git a/duties.py b/duties.py deleted file mode 100644 index 3aa9b662..00000000 --- a/duties.py +++ /dev/null @@ -1,200 +0,0 @@ -"""Development tasks.""" - -from __future__ import annotations - -import os -import re -import sys -from pathlib import Path -from typing import TYPE_CHECKING - -from duty import duty, tools - -if TYPE_CHECKING: - from duty.context import Context - - -PY_SRC_PATHS = (Path(_) for _ in ("src", "tests", "duties.py", "scripts")) -PY_SRC_LIST = tuple(str(_) for _ in PY_SRC_PATHS) -PY_SRC = " ".join(PY_SRC_LIST) -CI = os.environ.get("CI", "0") in {"1", "true", "yes", ""} -WINDOWS = os.name == "nt" -PTY = not WINDOWS and not CI -MULTIRUN = os.environ.get("MULTIRUN", "0") == "1" -PY_VERSION = f"{sys.version_info.major}{sys.version_info.minor}" -PY_DEV = "314" - - -def pyprefix(title: str) -> str: - if MULTIRUN: - prefix = f"(python{sys.version_info.major}.{sys.version_info.minor})" - return f"{prefix:14}{title}" - return title - - -def _get_changelog_version() -> str: - changelog_version_re = re.compile(r"^## \[(\d+\.\d+\.\d+)\].*$") - with Path(__file__).parent.joinpath("CHANGELOG.md").open("r", encoding="utf8") as file: - return next(filter(bool, map(changelog_version_re.match, file))).group(1) # type: ignore[union-attr] - - -@duty -def changelog(ctx: Context, bump: str = "") -> None: - """Update the changelog in-place with latest commits. - - Parameters: - bump: Bump option passed to git-changelog. - """ - ctx.run(tools.git_changelog(bump=bump or None), title="Updating changelog") - ctx.run(tools.yore.check(bump=bump or _get_changelog_version()), title="Checking legacy code") - - -@duty(pre=["check-quality", "check-types", "check-docs", "check-api"]) -def check(ctx: Context) -> None: - """Check it all!""" - - -@duty(nofail=PY_VERSION == PY_DEV) -def check_quality(ctx: Context) -> None: - """Check the code quality.""" - ctx.run( - tools.ruff.check(*PY_SRC_LIST, config="config/ruff.toml"), - title=pyprefix("Checking code quality"), - ) - - -@duty( - nofail=PY_VERSION == PY_DEV, - skip_if=sys.version_info < (3, 13), - skip_reason=pyprefix("Skipped: docs require modern generics syntax"), -) -def check_docs(ctx: Context) -> None: - """Check if the documentation builds correctly.""" - Path("htmlcov").mkdir(parents=True, exist_ok=True) - Path("htmlcov/index.html").touch(exist_ok=True) - ctx.run( - tools.mkdocs.build(strict=True, verbose=True), - title=pyprefix("Building documentation"), - ) - - -@duty(nofail=PY_VERSION == PY_DEV) -def check_types(ctx: Context) -> None: - """Check that the code is correctly typed.""" - os.environ["MYPYPATH"] = "src" - os.environ["FORCE_COLOR"] = "1" - ctx.run( - tools.mypy(*PY_SRC_LIST, config_file="config/mypy.ini"), - title=pyprefix("Type-checking"), - # TODO: Update when Pydantic supports 3.14. - nofail=sys.version_info >= (3, 14), - ) - - -@duty(nofail=PY_VERSION == PY_DEV) -def check_api(ctx: Context, *cli_args: str) -> None: - """Check for API breaking changes.""" - ctx.run( - tools.griffe.check("mkdocstrings_handlers.python", search=["src"], color=True).add_args(*cli_args), - title="Checking for API breaking changes", - nofail=True, - ) - - -@duty(skip_if=sys.version_info < (3, 13), skip_reason=pyprefix("Skipped: docs require modern generics syntax")) -def docs(ctx: Context, *cli_args: str, host: str = "127.0.0.1", port: int = 8000) -> None: - """Serve the documentation (localhost:8000). - - Parameters: - host: The host to serve the docs from. - port: The port to serve the docs on. - """ - ctx.run( - tools.mkdocs.serve(dev_addr=f"{host}:{port}").add_args(*cli_args), - title="Serving documentation", - capture=False, - ) - - -@duty(skip_if=sys.version_info < (3, 13), skip_reason=pyprefix("Skipped: docs require modern generics syntax")) -def docs_deploy(ctx: Context) -> None: - """Deploy the documentation to GitHub pages.""" - os.environ["DEPLOY"] = "true" - ctx.run(tools.mkdocs.gh_deploy(force=True), title="Deploying documentation") - - -@duty -def format(ctx: Context) -> None: - """Run formatting tools on the code.""" - ctx.run( - tools.ruff.check(*PY_SRC_LIST, config="config/ruff.toml", fix_only=True, exit_zero=True), - title="Auto-fixing code", - ) - ctx.run(tools.ruff.format(*PY_SRC_LIST, config="config/ruff.toml"), title="Formatting code") - - -@duty -def build(ctx: Context) -> None: - """Build source and wheel distributions.""" - ctx.run( - tools.build(), - title="Building source and wheel distributions", - pty=PTY, - ) - - -@duty -def publish(ctx: Context) -> None: - """Publish source and wheel distributions to PyPI.""" - if not Path("dist").exists(): - ctx.run("false", title="No distribution files found") - dists = [str(dist) for dist in Path("dist").iterdir()] - ctx.run( - tools.twine.upload(*dists, skip_existing=True), - title="Publishing source and wheel distributions to PyPI", - pty=PTY, - ) - - -@duty(post=["build", "publish", "docs-deploy"]) -def release(ctx: Context, version: str = "") -> None: - """Release a new Python package. - - Parameters: - version: The new version number to use. - """ - if not (version := (version or input("> Version to release: ")).strip()): - ctx.run("false", title="A version must be provided") - ctx.run("git add pyproject.toml CHANGELOG.md", title="Staging files", pty=PTY) - ctx.run(["git", "commit", "-m", f"chore: Prepare release {version}"], title="Committing changes", pty=PTY) - ctx.run(f"git tag -m '' -a {version}", title="Tagging commit", pty=PTY) - ctx.run("git push", title="Pushing commits", pty=False) - ctx.run("git push --tags", title="Pushing tags", pty=False) - - -@duty(silent=True, aliases=["cov"]) -def coverage(ctx: Context) -> None: - """Report coverage as text and HTML.""" - ctx.run(tools.coverage.combine(), nofail=True) - ctx.run(tools.coverage.report(rcfile="config/coverage.ini"), capture=False) - ctx.run(tools.coverage.html(rcfile="config/coverage.ini")) - - -@duty(nofail=PY_VERSION == PY_DEV) -def test(ctx: Context, *cli_args: str, snapshot: str = "report") -> None: # noqa: PT028 - """Run the test suite.""" - os.environ["COVERAGE_FILE"] = f".coverage.{PY_VERSION}" - os.environ["PYTHONWARNDEFAULTENCODING"] = "1" - args = list(cli_args) - if snapshot == "disable" or not snapshot: - args = ["-n", "auto", "--inline-snapshot=disable"] - else: - args = [f"--inline-snapshot={snapshot}"] - ctx.run( - tools.pytest( - "tests", - config_file="config/pytest.ini", - color="yes", - ).add_args(*args), - title=pyprefix("Running tests"), - ) diff --git a/index.html b/index.html new file mode 100644 index 00000000..03e790cc --- /dev/null +++ b/index.html @@ -0,0 +1,47 @@ + Overview - mkdocstrings-python

    mkdocstrings-python

    A Python handler for mkdocstrings.

    ci documentation pypi version gitter


    The Python handler uses Griffe to collect documentation from Python source code. The word "griffe" can sometimes be used instead of "signature" in French. Griffe is able to visit the Abstract Syntax Tree (AST) of the source code to extract useful information. It is also able to execute the code (by importing it) and introspect objects in memory when source code is not available. Finally, it can parse docstrings following different styles.

    Installation¤

    You can install this handler as a mkdocstrings extra:

    pyproject.toml
    # PEP 621 dependencies declaration
    +# adapt to your dependencies manager
    +[project]
    +dependencies = [
    +    "mkdocstrings[python]>=0.18",
    +]
    +

    You can also explicitly depend on the handler:

    pyproject.toml
    # PEP 621 dependencies declaration
    +# adapt to your dependencies manager
    +[project]
    +dependencies = [
    +    "mkdocstrings-python",
    +]
    +

    Preview¤

    mkdocstrings_python_gif

    Features¤

    • Data collection from source code: collection of the object-tree and the docstrings is done thanks to Griffe.

    • Support for type annotations: Griffe collects your type annotations and mkdocstrings uses them to display parameter types or return types. It is even able to automatically add cross-references to other objects from your API, from the standard library or third-party libraries! See how to load inventories to enable it.

    • Recursive documentation of Python objects: just use the module dotted-path as an identifier, and you get the full module docs. You don't need to inject documentation for each class, function, etc.

    • Support for documented attributes: attributes (variables) followed by a docstring (triple-quoted string) will be recognized by Griffe in modules, classes and even in __init__ methods.

    • Multiple docstring-styles support: common support for Google-style, Numpydoc-style, and Sphinx-style docstrings. See Griffe's documentation on docstrings support.

    • Admonition support in Google docstrings: blocks like Note: or Warning: will be transformed to their admonition equivalent. We do not support nested admonitions in docstrings!

    • Every object has a TOC entry: we render a heading for each object, meaning MkDocs picks them into the Table of Contents, which is nicely displayed by the Material theme. Thanks to mkdocstrings cross-reference ability, you can reference other objects within your docstrings, with the classic Markdown syntax: [this object][package.module.object] or directly with [package.module.object][]

    • Source code display: mkdocstrings can add a collapsible div containing the highlighted source code of the Python object.

    Sponsors¤

    Silver sponsors

    FastAPI

    Bronze sponsors

    Nixtla


    ofek samuelcolvin tlambert03 ssbarnea femtomc cmarqu kolenaIO ramnes machow BenHammersley trevorWieland MarcoGorelli analog-cbarber OdinManiac rstudio-sponsorship schlich butterlyn livingbio NemetschekAllplan EricJayHartman 15r10nk activeloopai roboflow cmclaughlin blaisep RapidataAI rodolphebarbanneau theSymbolSyndicate blakeNaccarato ChargeStorm Alphadelta14 Cusp-AI

    And 7 more private sponsor(s).

    \ No newline at end of file diff --git a/index.md b/index.md new file mode 100644 index 00000000..7c95dfc6 --- /dev/null +++ b/index.md @@ -0,0 +1,58 @@ +# mkdocstrings-python + +A Python handler for [*mkdocstrings*](https://github.com/mkdocstrings/mkdocstrings). + +______________________________________________________________________ + +The Python handler uses [Griffe](https://mkdocstrings.github.io/griffe) to collect documentation from Python source code. The word "griffe" can sometimes be used instead of "signature" in French. Griffe is able to visit the Abstract Syntax Tree (AST) of the source code to extract useful information. It is also able to execute the code (by importing it) and introspect objects in memory when source code is not available. Finally, it can parse docstrings following different styles. + +## Installation + +You can install this handler as a *mkdocstrings* extra: + +pyproject.toml + +```toml +# PEP 621 dependencies declaration +# adapt to your dependencies manager +[project] +dependencies = [ + "mkdocstrings[python]>=0.18", +] +``` + +You can also explicitly depend on the handler: + +pyproject.toml + +```toml +# PEP 621 dependencies declaration +# adapt to your dependencies manager +[project] +dependencies = [ + "mkdocstrings-python", +] +``` + +## Preview + +## Features + +- **Data collection from source code**: collection of the object-tree and the docstrings is done thanks to [Griffe](https://github.com/mkdocstrings/griffe). +- **Support for type annotations:** Griffe collects your type annotations and *mkdocstrings* uses them to display parameter types or return types. It is even able to automatically add cross-references to other objects from your API, from the standard library or third-party libraries! See [how to load inventories](https://mkdocstrings.github.io/usage/#cross-references-to-other-projects-inventories) to enable it. +- **Recursive documentation of Python objects:** just use the module dotted-path as an identifier, and you get the full module docs. You don't need to inject documentation for each class, function, etc. +- **Support for documented attributes:** attributes (variables) followed by a docstring (triple-quoted string) will be recognized by Griffe in modules, classes and even in `__init__` methods. +- **Multiple docstring-styles support:** common support for Google-style, Numpydoc-style, and Sphinx-style docstrings. See [Griffe's documentation](https://mkdocstrings.github.io/griffe/docstrings/) on docstrings support. +- **Admonition support in Google docstrings:** blocks like `Note:` or `Warning:` will be transformed to their [admonition](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) equivalent. *We do not support nested admonitions in docstrings!* +- **Every object has a TOC entry:** we render a heading for each object, meaning *MkDocs* picks them into the Table of Contents, which is nicely displayed by the Material theme. Thanks to *mkdocstrings* cross-reference ability, you can reference other objects within your docstrings, with the classic Markdown syntax: `[this object][package.module.object]` or directly with `[package.module.object][]` +- **Source code display:** *mkdocstrings* can add a collapsible div containing the highlighted source code of the Python object. + +## Sponsors + +**Silver sponsors** + +**Bronze sponsors** + +______________________________________________________________________ + +*And 7 more private sponsor(s).* diff --git a/docs/js/feedback.js b/js/feedback.js similarity index 100% rename from docs/js/feedback.js rename to js/feedback.js diff --git a/js/timeago.min.js b/js/timeago.min.js new file mode 100644 index 00000000..a6d756e2 --- /dev/null +++ b/js/timeago.min.js @@ -0,0 +1,2 @@ +/* Taken from https://cdnjs.cloudflare.com/ajax/libs/timeago.js/4.0.2/timeago.min.js */ +!function(s,n){"object"==typeof exports&&"undefined"!=typeof module?n(exports):"function"==typeof define&&define.amd?define(["exports"],n):n((s=s||self).timeago={})}(this,function(s){"use strict";var a=["second","minute","hour","day","week","month","year"];function n(s,n){if(0===n)return["just now","right now"];var e=a[Math.floor(n/2)];return 1=m[t]&&t=m[e]&&e 0) { + var locale = getLocale(nodes[0]); + timeago.render(nodes, locale); + } + }) +} else { + var nodes = document.querySelectorAll('.timeago'); + if (nodes.length > 0) { + var locale = getLocale(nodes[0]); + timeago.render(nodes, locale); + } +} diff --git a/license/index.html b/license/index.html new file mode 100644 index 00000000..b4573d4d --- /dev/null +++ b/license/index.html @@ -0,0 +1,50 @@ + License - mkdocstrings-python

    License¤

    ISC License
    +
    +Copyright (c) 2021, Timothée Mazzucotelli
    +
    +Permission to use, copy, modify, and/or distribute this software for any
    +purpose with or without fee is hereby granted, provided that the above
    +copyright notice and this permission notice appear in all copies.
    +
    +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
    +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
    +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
    +
    \ No newline at end of file diff --git a/llms-full.txt b/llms-full.txt new file mode 100644 index 00000000..d2449233 --- /dev/null +++ b/llms-full.txt @@ -0,0 +1,4679 @@ +# mkdocstrings-python + +> A Python handler for mkdocstrings. + +# Usage + +# mkdocstrings-python + +A Python handler for [*mkdocstrings*](https://github.com/mkdocstrings/mkdocstrings). + +______________________________________________________________________ + +The Python handler uses [Griffe](https://mkdocstrings.github.io/griffe) to collect documentation from Python source code. The word "griffe" can sometimes be used instead of "signature" in French. Griffe is able to visit the Abstract Syntax Tree (AST) of the source code to extract useful information. It is also able to execute the code (by importing it) and introspect objects in memory when source code is not available. Finally, it can parse docstrings following different styles. + +## Installation + +You can install this handler as a *mkdocstrings* extra: + +pyproject.toml + +```toml +# PEP 621 dependencies declaration +# adapt to your dependencies manager +[project] +dependencies = [ + "mkdocstrings[python]>=0.18", +] +``` + +You can also explicitly depend on the handler: + +pyproject.toml + +```toml +# PEP 621 dependencies declaration +# adapt to your dependencies manager +[project] +dependencies = [ + "mkdocstrings-python", +] +``` + +## Preview + +## Features + +- **Data collection from source code**: collection of the object-tree and the docstrings is done thanks to [Griffe](https://github.com/mkdocstrings/griffe). +- **Support for type annotations:** Griffe collects your type annotations and *mkdocstrings* uses them to display parameter types or return types. It is even able to automatically add cross-references to other objects from your API, from the standard library or third-party libraries! See [how to load inventories](https://mkdocstrings.github.io/usage/#cross-references-to-other-projects-inventories) to enable it. +- **Recursive documentation of Python objects:** just use the module dotted-path as an identifier, and you get the full module docs. You don't need to inject documentation for each class, function, etc. +- **Support for documented attributes:** attributes (variables) followed by a docstring (triple-quoted string) will be recognized by Griffe in modules, classes and even in `__init__` methods. +- **Multiple docstring-styles support:** common support for Google-style, Numpydoc-style, and Sphinx-style docstrings. See [Griffe's documentation](https://mkdocstrings.github.io/griffe/docstrings/) on docstrings support. +- **Admonition support in Google docstrings:** blocks like `Note:` or `Warning:` will be transformed to their [admonition](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) equivalent. *We do not support nested admonitions in docstrings!* +- **Every object has a TOC entry:** we render a heading for each object, meaning *MkDocs* picks them into the Table of Contents, which is nicely displayed by the Material theme. Thanks to *mkdocstrings* cross-reference ability, you can reference other objects within your docstrings, with the classic Markdown syntax: `[this object][package.module.object]` or directly with `[package.module.object][]` +- **Source code display:** *mkdocstrings* can add a collapsible div containing the highlighted source code of the Python object. + +## Sponsors + +**Silver sponsors** + +**Bronze sponsors** + +______________________________________________________________________ + +*And 7 more private sponsor(s).* +# API + +# python + +Python handler for mkdocstrings. + +Classes: + +- **`AutoStyleOptions`** – Auto style docstring options. +- **`AutorefsHook`** – Autorefs hook. +- **`GoogleStyleOptions`** – Google style docstring options. +- **`Inventory`** – An inventory. +- **`NumpyStyleOptions`** – Numpy style docstring options. +- **`PerStyleOptions`** – Per style options. +- **`PythonConfig`** – Python handler configuration. +- **`PythonHandler`** – The Python handler class. +- **`PythonInputConfig`** – Python handler configuration. +- **`PythonInputOptions`** – Accepted input options. +- **`PythonOptions`** – Final options passed as template context. +- **`SphinxStyleOptions`** – Sphinx style docstring options. +- **`SummaryOption`** – Summary option. + +Functions: + +- **`do_as_attributes_section`** – Build an attributes section from a list of attributes. +- **`do_as_classes_section`** – Build a classes section from a list of classes. +- **`do_as_functions_section`** – Build a functions section from a list of functions. +- **`do_as_modules_section`** – Build a modules section from a list of modules. +- **`do_as_type_aliases_section`** – Build a type aliases section from a list of type aliases. +- **`do_backlink_tree`** – Build a tree of backlinks. +- **`do_filter_objects`** – Filter a dictionary of objects based on their docstrings. +- **`do_format_attribute`** – Format an attribute. +- **`do_format_code`** – Format code. +- **`do_format_signature`** – Format a signature. +- **`do_format_type_alias`** – Format a type alias. +- **`do_get_template`** – Get the template name used to render an object. +- **`do_order_members`** – Order members given an ordering method. +- **`do_split_path`** – Split object paths for building cross-references. +- **`get_handler`** – Return an instance of PythonHandler. + +Attributes: + +- **`Order`** – Ordering methods. +- **`Tree`** – A tree type. Each node holds a tuple of items. +- **`do_stash_crossref`** – Filter to stash cross-references (and restore them after formatting and highlighting). + +## Order + +```python +Order = Literal['__all__', 'alphabetical', 'source'] +``` + +Ordering methods. + +- `__all__`: order members according to `__all__` module attributes, if declared; +- `alphabetical`: order members alphabetically; +- `source`: order members as they appear in the source file. + +## Tree + +```python +Tree = dict[tuple[_T, ...], 'Tree'] +``` + +A tree type. Each node holds a tuple of items. + +## do_stash_crossref + +```python +do_stash_crossref = _StashCrossRefFilter() +``` + +Filter to stash cross-references (and restore them after formatting and highlighting). + +## AutoStyleOptions + +```python +AutoStyleOptions( + *, + method: Literal["heuristics", "max_sections"] = "heuristics", + style_order: list[str] = (lambda: ["sphinx", "google", "numpy"])(), + default: str | None = None, + per_style_options: PerStyleOptions = PerStyleOptions() +) +``` + +Auto style docstring options. + +Methods: + +- **`from_data`** – Create an instance from a dictionary. + +Attributes: + +- **`default`** (`str | None`) – The default docstring style to use if no other style is detected. +- **`method`** (`Literal['heuristics', 'max_sections']`) – The method to use to determine the docstring style. +- **`per_style_options`** (`PerStyleOptions`) – Per-style options. +- **`style_order`** (`list[str]`) – The order of the docstring styles to try. + +### default + +```python +default: str | None = None +``` + +The default docstring style to use if no other style is detected. + +### method + +```python +method: Literal['heuristics', 'max_sections'] = 'heuristics' +``` + +The method to use to determine the docstring style. + +### per_style_options + +```python +per_style_options: PerStyleOptions = field(default_factory=PerStyleOptions) +``` + +Per-style options. + +### style_order + +```python +style_order: list[str] = field(default_factory=lambda: ['sphinx', 'google', 'numpy']) +``` + +The order of the docstring styles to try. + +### from_data + +```python +from_data(**data: Any) -> Self +``` + +Create an instance from a dictionary. + +Source code in `src/mkdocstrings_handlers/python/_internal/config.py` + +```python +@classmethod +def from_data(cls, **data: Any) -> Self: + """Create an instance from a dictionary.""" + if "per_style_options" in data: + data["per_style_options"] = PerStyleOptions.from_data(**data["per_style_options"]) + return cls(**data) +``` + +## AutorefsHook + +```python +AutorefsHook(current_object: Object | Alias, config: dict[str, Any]) +``` + +``` + flowchart TD + mkdocstrings_handlers.python.AutorefsHook[AutorefsHook] + + + + click mkdocstrings_handlers.python.AutorefsHook href "" "mkdocstrings_handlers.python.AutorefsHook" +``` + +Autorefs hook. + +With this hook, we're able to add context to autorefs (cross-references), such as originating file path and line number, to improve error reporting. + +Parameters: + +- ### **`current_object`** + + (`Object | Alias`) – The object being rendered. + +- ### **`config`** + + (`dict[str, Any]`) – The configuration dictionary. + +Methods: + +- **`expand_identifier`** – Expand an identifier. +- **`get_context`** – Get the context for the current object. + +Attributes: + +- **`config`** – The configuration options. +- **`current_object`** – The current object being rendered. + +Source code in `src/mkdocstrings_handlers/python/_internal/rendering.py` + +```python +def __init__(self, current_object: Object | Alias, config: dict[str, Any]) -> None: + """Initialize the hook. + + Parameters: + current_object: The object being rendered. + config: The configuration dictionary. + """ + self.current_object = current_object + """The current object being rendered.""" + self.config = config + """The configuration options.""" +``` + +### config + +```python +config = config +``` + +The configuration options. + +### current_object + +```python +current_object = current_object +``` + +The current object being rendered. + +### expand_identifier + +```python +expand_identifier(identifier: str) -> str +``` + +Expand an identifier. + +Parameters: + +- #### **`identifier`** + + (`str`) – The identifier to expand. + +Returns: + +- `str` – The expanded identifier. + +Source code in `src/mkdocstrings_handlers/python/_internal/rendering.py` + +```python +def expand_identifier(self, identifier: str) -> str: + """Expand an identifier. + + Parameters: + identifier: The identifier to expand. + + Returns: + The expanded identifier. + """ + # Handle leading dots in the identifier: + # - `.name` is a reference to the current object's `name` member. + # - `..name` is a reference to the parent object's `name` member. + # - etc. + # TODO: We should update the protocol to allow modifying the title too. + # In this case it would likely be better to strip dots from the title, + # when it's not explicitly specified. + if self.config.relative_crossrefs and identifier.startswith("."): # type: ignore[attr-defined] + identifier = identifier[1:] + obj = self.current_object + while identifier and identifier[0] == ".": + identifier = identifier[1:] + obj = obj.parent + identifier = f"{obj.path}.{identifier}" if identifier else obj.path + + # We resolve the identifier to its full path. + # For this we take out the first name, resolve it, and then append the rest. + if self.config.scoped_crossrefs: # type: ignore[attr-defined] + if "." in identifier: + identifier, remaining = identifier.split(".", 1) + else: + remaining = "" + with suppress(Exception): + identifier = self.current_object.resolve(identifier) + if remaining: + identifier = f"{identifier}.{remaining}" + + return identifier +``` + +### get_context + +```python +get_context() -> Context +``` + +Get the context for the current object. + +Returns: + +- `Context` – The context. + +Source code in `src/mkdocstrings_handlers/python/_internal/rendering.py` + +```python +def get_context(self) -> AutorefsHookInterface.Context: + """Get the context for the current object. + + Returns: + The context. + """ + role = { + "attribute": "data" if self.current_object.parent and self.current_object.parent.is_module else "attr", + "class": "class", + "function": "meth" if self.current_object.parent and self.current_object.parent.is_class else "func", + "module": "mod", + }.get(self.current_object.kind.value.lower(), "obj") + origin = self.current_object.path + try: + filepath = self.current_object.docstring.parent.filepath + lineno = self.current_object.docstring.lineno or 0 + except AttributeError: + filepath = self.current_object.filepath + lineno = 0 + + return AutorefsHookInterface.Context( + domain="py", + role=role, + origin=origin, + filepath=str(filepath), + lineno=lineno, + ) +``` + +## GoogleStyleOptions + +```python +GoogleStyleOptions( + *, + ignore_init_summary: bool = False, + returns_multiple_items: bool = True, + returns_named_value: bool = True, + returns_type_in_property_summary: bool = False, + receives_multiple_items: bool = True, + receives_named_value: bool = True, + trim_doctest_flags: bool = True, + warn_unknown_params: bool = True, + warn_missing_types: bool = True, + warnings: bool = True +) +``` + +Google style docstring options. + +Attributes: + +- **`ignore_init_summary`** (`bool`) – Whether to ignore the summary in __init__ methods' docstrings. +- **`receives_multiple_items`** (`bool`) – Whether to parse multiple items in Receives sections. +- **`receives_named_value`** (`bool`) – Whether to parse Receives section items as name and description, rather than type and description. +- **`returns_multiple_items`** (`bool`) – Whether to parse multiple items in Yields and Returns sections. +- **`returns_named_value`** (`bool`) – Whether to parse Yields and Returns section items as name and description, rather than type and description. +- **`returns_type_in_property_summary`** (`bool`) – Whether to parse the return type of properties at the beginning of their summary: str: Summary of the property. +- **`trim_doctest_flags`** (`bool`) – Whether to remove doctest flags from Python example blocks. +- **`warn_missing_types`** (`bool`) – Warn about missing type/annotation for parameters, return values, etc. +- **`warn_unknown_params`** (`bool`) – Warn about documented parameters not appearing in the signature. +- **`warnings`** (`bool`) – Generally enable/disable warnings when parsing docstrings. + +### ignore_init_summary + +```python +ignore_init_summary: bool = False +``` + +Whether to ignore the summary in `__init__` methods' docstrings. + +### receives_multiple_items + +```python +receives_multiple_items: bool = True +``` + +Whether to parse multiple items in `Receives` sections. + +When true, each item's continuation lines must be indented. When false (single item), no further indentation is required. + +### receives_named_value + +```python +receives_named_value: bool = True +``` + +Whether to parse `Receives` section items as name and description, rather than type and description. + +When true, type must be wrapped in parentheses: `(int): Description.`. Names are optional: `name (int): Description.`. When false, parentheses are optional but the items cannot be named: `int: Description`. + +### returns_multiple_items + +```python +returns_multiple_items: bool = True +``` + +Whether to parse multiple items in `Yields` and `Returns` sections. + +When true, each item's continuation lines must be indented. When false (single item), no further indentation is required. + +### returns_named_value + +```python +returns_named_value: bool = True +``` + +Whether to parse `Yields` and `Returns` section items as name and description, rather than type and description. + +When true, type must be wrapped in parentheses: `(int): Description.`. Names are optional: `name (int): Description.`. When false, parentheses are optional but the items cannot be named: `int: Description`. + +### returns_type_in_property_summary + +```python +returns_type_in_property_summary: bool = False +``` + +Whether to parse the return type of properties at the beginning of their summary: `str: Summary of the property`. + +### trim_doctest_flags + +```python +trim_doctest_flags: bool = True +``` + +Whether to remove doctest flags from Python example blocks. + +### warn_missing_types + +```python +warn_missing_types: bool = True +``` + +Warn about missing type/annotation for parameters, return values, etc. + +### warn_unknown_params + +```python +warn_unknown_params: bool = True +``` + +Warn about documented parameters not appearing in the signature. + +### warnings + +```python +warnings: bool = True +``` + +Generally enable/disable warnings when parsing docstrings. + +## Inventory + +```python +Inventory( + *, url: str, base_url: str | None = None, domains: list[str] = (lambda: ["py"])() +) +``` + +An inventory. + +Attributes: + +- **`base_url`** (`str | None`) – The base URL of the inventory. +- **`domains`** (`list[str]`) – The domains to load from the inventory. +- **`url`** (`str`) – The URL of the inventory. + +### base_url + +```python +base_url: str | None = None +``` + +The base URL of the inventory. + +### domains + +```python +domains: list[str] = field(default_factory=lambda: ['py']) +``` + +The domains to load from the inventory. + +### url + +```python +url: str +``` + +The URL of the inventory. + +## NumpyStyleOptions + +```python +NumpyStyleOptions( + *, + ignore_init_summary: bool = False, + trim_doctest_flags: bool = True, + warn_unknown_params: bool = True, + warn_missing_types: bool = True, + warnings: bool = True +) +``` + +Numpy style docstring options. + +Attributes: + +- **`ignore_init_summary`** (`bool`) – Whether to ignore the summary in __init__ methods' docstrings. +- **`trim_doctest_flags`** (`bool`) – Whether to remove doctest flags from Python example blocks. +- **`warn_missing_types`** (`bool`) – Warn about missing type/annotation for parameters, return values, etc. +- **`warn_unknown_params`** (`bool`) – Warn about documented parameters not appearing in the signature. +- **`warnings`** (`bool`) – Generally enable/disable warnings when parsing docstrings. + +### ignore_init_summary + +```python +ignore_init_summary: bool = False +``` + +Whether to ignore the summary in `__init__` methods' docstrings. + +### trim_doctest_flags + +```python +trim_doctest_flags: bool = True +``` + +Whether to remove doctest flags from Python example blocks. + +### warn_missing_types + +```python +warn_missing_types: bool = True +``` + +Warn about missing type/annotation for parameters, return values, etc. + +### warn_unknown_params + +```python +warn_unknown_params: bool = True +``` + +Warn about documented parameters not appearing in the signature. + +### warnings + +```python +warnings: bool = True +``` + +Generally enable/disable warnings when parsing docstrings. + +## PerStyleOptions + +```python +PerStyleOptions( + *, + google: GoogleStyleOptions = GoogleStyleOptions(), + numpy: NumpyStyleOptions = NumpyStyleOptions(), + sphinx: SphinxStyleOptions = SphinxStyleOptions() +) +``` + +Per style options. + +Methods: + +- **`from_data`** – Create an instance from a dictionary. + +Attributes: + +- **`google`** (`GoogleStyleOptions`) – Google-style options. +- **`numpy`** (`NumpyStyleOptions`) – Numpydoc-style options. +- **`sphinx`** (`SphinxStyleOptions`) – Sphinx-style options. + +### google + +```python +google: GoogleStyleOptions = field(default_factory=GoogleStyleOptions) +``` + +Google-style options. + +### numpy + +```python +numpy: NumpyStyleOptions = field(default_factory=NumpyStyleOptions) +``` + +Numpydoc-style options. + +### sphinx + +```python +sphinx: SphinxStyleOptions = field(default_factory=SphinxStyleOptions) +``` + +Sphinx-style options. + +### from_data + +```python +from_data(**data: Any) -> Self +``` + +Create an instance from a dictionary. + +Source code in `src/mkdocstrings_handlers/python/_internal/config.py` + +```python +@classmethod +def from_data(cls, **data: Any) -> Self: + """Create an instance from a dictionary.""" + if "google" in data: + data["google"] = GoogleStyleOptions(**data["google"]) + if "numpy" in data: + data["numpy"] = NumpyStyleOptions(**data["numpy"]) + if "sphinx" in data: + data["sphinx"] = SphinxStyleOptions(**data["sphinx"]) + return cls(**data) +``` + +## PythonConfig + +```python +PythonConfig( + *, + inventories: list[Inventory] = list(), + paths: list[str] = (lambda: ["."])(), + load_external_modules: bool | None = None, + options: dict[str, Any] = dict(), + locale: str | None = None +) +``` + +``` + flowchart TD + mkdocstrings_handlers.python.PythonConfig[PythonConfig] + mkdocstrings_handlers.python._internal.config.PythonInputConfig[PythonInputConfig] + + mkdocstrings_handlers.python._internal.config.PythonInputConfig --> mkdocstrings_handlers.python.PythonConfig + + + + click mkdocstrings_handlers.python.PythonConfig href "" "mkdocstrings_handlers.python.PythonConfig" + click mkdocstrings_handlers.python._internal.config.PythonInputConfig href "" "mkdocstrings_handlers.python._internal.config.PythonInputConfig" +``` + +Python handler configuration. + +Methods: + +- **`coerce`** – Coerce data. +- **`from_data`** – Create an instance from a dictionary. + +Attributes: + +- **`inventories`** (`list[Inventory]`) – The object inventories to load. +- **`load_external_modules`** (`bool | None`) – Whether to always load external modules/packages. +- **`locale`** (`str | None`) – Deprecated. Use mkdocstrings' own locale setting instead. The locale to use when translating template strings. +- **`options`** (`dict[str, Any]`) – Configuration options for collecting and rendering objects. +- **`paths`** (`list[str]`) – The paths in which to search for Python packages. + +### inventories + +```python +inventories: list[Inventory] = field(default_factory=list) +``` + +The object inventories to load. + +### load_external_modules + +```python +load_external_modules: bool | None = None +``` + +Whether to always load external modules/packages. + +### locale + +```python +locale: str | None = None +``` + +Deprecated. Use mkdocstrings' own `locale` setting instead. The locale to use when translating template strings. + +### options + +```python +options: dict[str, Any] = field(default_factory=dict) +``` + +Configuration options for collecting and rendering objects. + +### paths + +```python +paths: list[str] = field(default_factory=lambda: ['.']) +``` + +The paths in which to search for Python packages. + +### coerce + +```python +coerce(**data: Any) -> MutableMapping[str, Any] +``` + +Coerce data. + +Source code in `src/mkdocstrings_handlers/python/_internal/config.py` + +```python +@classmethod +def coerce(cls, **data: Any) -> MutableMapping[str, Any]: + """Coerce data.""" + if "inventories" in data: + data["inventories"] = [ + Inventory(url=inv) if isinstance(inv, str) else Inventory(**inv) for inv in data["inventories"] + ] + return data +``` + +### from_data + +```python +from_data(**data: Any) -> Self +``` + +Create an instance from a dictionary. + +Source code in `src/mkdocstrings_handlers/python/_internal/config.py` + +```python +@classmethod +def from_data(cls, **data: Any) -> Self: + """Create an instance from a dictionary.""" + return cls(**cls.coerce(**data)) +``` + +## PythonHandler + +```python +PythonHandler(config: PythonConfig, base_dir: Path, **kwargs: Any) +``` + +``` + flowchart TD + mkdocstrings_handlers.python.PythonHandler[PythonHandler] + mkdocstrings._internal.handlers.base.BaseHandler[BaseHandler] + + mkdocstrings._internal.handlers.base.BaseHandler --> mkdocstrings_handlers.python.PythonHandler + + + + click mkdocstrings_handlers.python.PythonHandler href "" "mkdocstrings_handlers.python.PythonHandler" + click mkdocstrings._internal.handlers.base.BaseHandler href "" "mkdocstrings._internal.handlers.base.BaseHandler" +``` + +The Python handler class. + +Parameters: + +- ### **`config`** + + (`PythonConfig`) – The handler configuration. + +- ### **`base_dir`** + + (`Path`) – The base directory of the project. + +- ### **`**kwargs`** + + (`Any`, default: `{}` ) – Arguments passed to the parent constructor. + +Methods: + +- **`collect`** – Collect the documentation for the given identifier. +- **`do_convert_markdown`** – Render Markdown text; for use inside templates. +- **`do_heading`** – Render an HTML heading and register it for the table of contents. For use inside templates. +- **`get_aliases`** – Get the aliases for the given identifier. +- **`get_extended_templates_dirs`** – Load template extensions for the given handler, return their templates directories. +- **`get_headings`** – Return and clear the headings gathered so far. +- **`get_inventory_urls`** – Return the URLs of the inventory files to download. +- **`get_options`** – Get combined default, global and local options. +- **`get_templates_dir`** – Return the path to the handler's templates directory. +- **`load_inventory`** – Yield items and their URLs from an inventory file streamed from in_file. +- **`normalize_extension_paths`** – Resolve extension paths relative to config file. +- **`render`** – Render the collected data. +- **`render_backlinks`** – Render the backlinks. +- **`teardown`** – Teardown the handler. +- **`update_env`** – Update the Jinja environment with custom filters and tests. + +Attributes: + +- **`base_dir`** – The base directory of the project. +- **`config`** – The handler configuration. +- **`custom_templates`** – The path to custom templates. +- **`domain`** (`str`) – The cross-documentation domain/language for this handler. +- **`enable_inventory`** (`bool`) – Whether this handler is interested in enabling the creation of the objects.inv Sphinx inventory file. +- **`env`** – The Jinja environment. +- **`extra_css`** (`str`) – Extra CSS. +- **`fallback_theme`** (`str`) – The fallback theme. +- **`global_options`** – The global configuration options (in mkdocs.yml). +- **`md`** (`Markdown`) – The Markdown instance. +- **`mdx`** – The Markdown extensions to use. +- **`mdx_config`** – The configuration for the Markdown extensions. +- **`name`** (`str`) – The handler's name. +- **`outer_layer`** (`bool`) – Whether we're in the outer Markdown conversion layer. +- **`theme`** – The selected theme. + +Source code in `src/mkdocstrings_handlers/python/_internal/handler.py` + +```python +def __init__(self, config: PythonConfig, base_dir: Path, **kwargs: Any) -> None: + """Initialize the handler. + + Parameters: + config: The handler configuration. + base_dir: The base directory of the project. + **kwargs: Arguments passed to the parent constructor. + """ + super().__init__(**kwargs) + + self.config = config + """The handler configuration.""" + self.base_dir = base_dir + """The base directory of the project.""" + + self.global_options = config.options + """The global configuration options (in `mkdocs.yml`).""" + + # Warn if user overrides base templates. + if self.custom_templates: + for theme_dir in base_dir.joinpath(self.custom_templates, "python").iterdir(): + if theme_dir.joinpath("_base").is_dir(): + _logger.warning( + f"Overriding base template '{theme_dir.name}/_base/