pax_global_header 0000666 0000000 0000000 00000000064 14754751525 0014531 g ustar 00root root 0000000 0000000 52 comment=e68c68815cffa46320f3ba42b867fc1175e804e1
griffe-typingdoc-0.2.8/ 0000775 0000000 0000000 00000000000 14754751525 0015000 5 ustar 00root root 0000000 0000000 griffe-typingdoc-0.2.8/.copier-answers.yml 0000664 0000000 0000000 00000001260 14754751525 0020541 0 ustar 00root root 0000000 0000000 # Changes here will be overwritten by Copier
_commit: 1.5.7
_src_path: gh:pawamoy/copier-uv
author_email: pawamoy@pm.me
author_fullname: Timothée Mazzucotelli
author_username: pawamoy
copyright_date: '2023'
copyright_holder: Timothée Mazzucotelli
copyright_holder_email: pawamoy@pm.me
copyright_license: ISC License
insiders: false
project_description: Griffe extension for PEP 727 – Documentation Metadata in Typing.
project_name: Griffe TypingDoc
python_package_command_line_name: ''
python_package_distribution_name: griffe-typingdoc
python_package_import_name: griffe_typingdoc
repository_name: griffe-typingdoc
repository_namespace: mkdocstrings
repository_provider: github.com
griffe-typingdoc-0.2.8/.envrc 0000664 0000000 0000000 00000000021 14754751525 0016107 0 ustar 00root root 0000000 0000000 PATH_add scripts
griffe-typingdoc-0.2.8/.github/ 0000775 0000000 0000000 00000000000 14754751525 0016340 5 ustar 00root root 0000000 0000000 griffe-typingdoc-0.2.8/.github/FUNDING.yml 0000664 0000000 0000000 00000000126 14754751525 0020154 0 ustar 00root root 0000000 0000000 github: pawamoy
ko_fi: pawamoy
polar: pawamoy
custom:
- https://www.paypal.me/pawamoy
griffe-typingdoc-0.2.8/.github/ISSUE_TEMPLATE/ 0000775 0000000 0000000 00000000000 14754751525 0020523 5 ustar 00root root 0000000 0000000 griffe-typingdoc-0.2.8/.github/ISSUE_TEMPLATE/1-bug.md 0000664 0000000 0000000 00000002714 14754751525 0021764 0 ustar 00root root 0000000 0000000 ---
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 griffe_typingdoc.debug # | xclip -selection clipboard
```
PASTE MARKDOWN OUTPUT HERE
### Additional context
griffe-typingdoc-0.2.8/.github/ISSUE_TEMPLATE/2-feature.md 0000664 0000000 0000000 00000001213 14754751525 0022634 0 ustar 00root root 0000000 0000000 ---
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
griffe-typingdoc-0.2.8/.github/ISSUE_TEMPLATE/3-docs.md 0000664 0000000 0000000 00000001131 14754751525 0022131 0 ustar 00root root 0000000 0000000 ---
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
griffe-typingdoc-0.2.8/.github/ISSUE_TEMPLATE/4-change.md 0000664 0000000 0000000 00000001126 14754751525 0022433 0 ustar 00root root 0000000 0000000 ---
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
griffe-typingdoc-0.2.8/.github/ISSUE_TEMPLATE/config.yml 0000664 0000000 0000000 00000000342 14754751525 0022512 0 ustar 00root root 0000000 0000000 blank_issues_enabled: false
contact_links:
- name: I have a question / I need help
url: https://github.com/mkdocstrings/griffe-typingdoc/discussions/new?category=q-a
about: Ask and answer questions in the Discussions tab.
griffe-typingdoc-0.2.8/.github/workflows/ 0000775 0000000 0000000 00000000000 14754751525 0020375 5 ustar 00root root 0000000 0000000 griffe-typingdoc-0.2.8/.github/workflows/ci.yml 0000664 0000000 0000000 00000004165 14754751525 0021521 0 ustar 00root root 0000000 0000000 name: ci
on:
push:
pull_request:
branches:
- main
defaults:
run:
shell: bash
env:
LANG: en_US.utf-8
LC_ALL: en_US.utf-8
PYTHONIOENCODING: UTF-8
PYTHON_VERSIONS: ""
jobs:
quality:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
fetch-tags: true
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Setup uv
uses: astral-sh/setup-uv@v3
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
tests:
strategy:
matrix:
os:
- ubuntu-latest
- macos-latest
- windows-latest
python-version:
- "3.9"
- "3.10"
- "3.11"
- "3.12"
- "3.13"
- "3.14"
resolution:
- highest
- lowest-direct
exclude:
- os: macos-latest
resolution: lowest-direct
- os: windows-latest
resolution: lowest-direct
runs-on: ${{ matrix.os }}
continue-on-error: ${{ matrix.python-version == '3.14' }}
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
fetch-tags: true
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
allow-prereleases: true
- name: Setup uv
uses: astral-sh/setup-uv@v3
with:
enable-cache: true
cache-dependency-glob: pyproject.toml
cache-suffix: py${{ matrix.python-version }}
- name: Install dependencies
env:
UV_RESOLUTION: ${{ matrix.resolution }}
run: make setup
- name: Run the test suite
run: make test
griffe-typingdoc-0.2.8/.github/workflows/release.yml 0000664 0000000 0000000 00000001214 14754751525 0022536 0 ustar 00root root 0000000 0000000 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@v5
with:
python-version: "3.12"
- name: Setup uv
uses: astral-sh/setup-uv@v3
- 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
griffe-typingdoc-0.2.8/.gitignore 0000664 0000000 0000000 00000000331 14754751525 0016765 0 ustar 00root root 0000000 0000000 # 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__/
griffe-typingdoc-0.2.8/CHANGELOG.md 0000664 0000000 0000000 00000015013 14754751525 0016611 0 ustar 00root root 0000000 0000000 # 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).
## [0.2.8](https://github.com/mkdocstrings/griffe-typingdoc/releases/tag/0.2.8) - 2025-02-18
[Compare with 0.2.7](https://github.com/mkdocstrings/griffe-typingdoc/compare/0.2.7...0.2.8)
### Code Refactoring
- Only add docstring sections when elements are annotated with `Doc` ([514467c](https://github.com/mkdocstrings/griffe-typingdoc/commit/514467c06f4381fca9c5f96a860c8abd87c1827b) by Timothée Mazzucotelli). [Issue-13](https://github.com/mkdocstrings/griffe-typingdoc/issues/13)
## [0.2.7](https://github.com/mkdocstrings/griffe-typingdoc/releases/tag/0.2.7) - 2024-09-10
[Compare with 0.2.6](https://github.com/mkdocstrings/griffe-typingdoc/compare/0.2.6...0.2.7)
### Bug Fixes
- Resolve names in `Unpack`, instead of naively trying to get them from the parent of the function being handled ([5e06b33](https://github.com/mkdocstrings/griffe-typingdoc/commit/5e06b33651f43b292059d27d3b232e2646a409d5) by Timothée Mazzucotelli). [Issue-11](https://github.com/mkdocstrings/griffe-typingdoc/issues/11)
## [0.2.6](https://github.com/mkdocstrings/griffe-typingdoc/releases/tag/0.2.6) - 2024-08-14
[Compare with 0.2.5](https://github.com/mkdocstrings/griffe-typingdoc/compare/0.2.5...0.2.6)
### Build
- Depend on Griffe 0.49 ([b6d7bd9](https://github.com/mkdocstrings/griffe-typingdoc/commit/b6d7bd9ce462a8dbd067464b3d14a9dd25865957) by Timothée Mazzucotelli).
## [0.2.5](https://github.com/mkdocstrings/griffe-typingdoc/releases/tag/0.2.5) - 2024-02-08
[Compare with 0.2.4](https://github.com/mkdocstrings/griffe-typingdoc/compare/0.2.4...0.2.5)
### Bug Fixes
- Support simple return annotations ([b4afabe](https://github.com/mkdocstrings/griffe-typingdoc/commit/b4afabed86e8b7c1905cbf672ab261be0d895e40) by Timothée Mazzucotelli). [Issue #9](https://github.com/mkdocstrings/griffe-typingdoc/issues/9)
## [0.2.4](https://github.com/mkdocstrings/griffe-typingdoc/releases/tag/0.2.4) - 2023-11-14
[Compare with 0.2.3](https://github.com/mkdocstrings/griffe-typingdoc/compare/0.2.3...0.2.4)
### Code Refactoring
- Run static analysis only after the whole package was loaded ([08be3d0](https://github.com/mkdocstrings/griffe-typingdoc/commit/08be3d0e735b03b9ba28b055895dfa2d01778fda) by Timothée Mazzucotelli). [Issue #7](https://github.com/mkdocstrings/griffe-typingdoc/issues/7), [PR #8](https://github.com/mkdocstrings/griffe-typingdoc/pull/8)
## [0.2.3](https://github.com/mkdocstrings/griffe-typingdoc/releases/tag/0.2.3) - 2023-10-23
[Compare with 0.2.2](https://github.com/mkdocstrings/griffe-typingdoc/compare/0.2.2...0.2.3)
### Bug Fixes
- Fix index error when trying to access the first parameter of functions ([92e27a3](https://github.com/mkdocstrings/griffe-typingdoc/commit/92e27a3bc5f81acfdb94c24fcd33e1992e3db503) by Timothée Mazzucotelli). [Issue #7](https://github.com/mkdocstrings/griffe-typingdoc/issues/7)
## [0.2.2](https://github.com/mkdocstrings/griffe-typingdoc/releases/tag/0.2.2) - 2023-10-16
[Compare with 0.2.1](https://github.com/mkdocstrings/griffe-typingdoc/compare/0.2.1...0.2.2)
### Bug Fixes
- Do not always add docstrings to attributes ([02d8cb6](https://github.com/mkdocstrings/griffe-typingdoc/commit/02d8cb6d70edc3869767561e42003b6ef97ac1cd) by Timothée Mazzucotelli).
## [0.2.1](https://github.com/mkdocstrings/griffe-typingdoc/releases/tag/0.2.1) - 2023-10-05
[Compare with 0.2.0](https://github.com/mkdocstrings/griffe-typingdoc/compare/0.2.0...0.2.1)
### Bug Fixes
- Fix casing of `deprecated`, only set metadata when annotated element is known ([98f3c2c](https://github.com/mkdocstrings/griffe-typingdoc/commit/98f3c2c296e946dee0fd30ae533515c1896022e1) by Sebastián Ramírez).
## [0.2.0](https://github.com/mkdocstrings/griffe-typingdoc/releases/tag/0.2.0) - 2023-09-14
[Compare with 0.1.0](https://github.com/mkdocstrings/griffe-typingdoc/compare/0.1.0...0.2.0)
### Dependencies
- Depend on Griffe ([cc15edc](https://github.com/mkdocstrings/griffe-typingdoc/commit/cc15edc3b170e891fa37ff69b58eb9fea7af8fa8) by Timothée Mazzucotelli).
### Features
- Support more experimental annotations (names, deprecations, warnings, exceptions) ([afa6dd9](https://github.com/mkdocstrings/griffe-typingdoc/commit/afa6dd96fe7dc90d16934b1b191484f891f56d92) by Timothée Mazzucotelli). [Issue #1](https://github.com/mkdocstrings/griffe-typingdoc/issues/1), [PR #3](https://github.com/mkdocstrings/griffe-typingdoc/pull/3)
### Code Refactoring
- Refactor implementation with latest version in `typing_extensions`, `Doc()`, and de-indent ([c7a61c6](https://github.com/mkdocstrings/griffe-typingdoc/commit/c7a61c68a39d6dbb4955037cd18f96be214f2d0d) by Sebastián Ramírez). [PR #2](https://github.com/mkdocstrings/griffe-typingdoc/pull/2)
## [0.1.0](https://github.com/mkdocstrings/griffe-typingdoc/releases/tag/0.1.0) - 2023-08-29
[Compare with first commit](https://github.com/mkdocstrings/griffe-typingdoc/compare/10139be2140f73617681a1f7ca2c4514ea9017e5...0.1.0)
### Dependencies
- Always depend on typing-extensions, use @tiangolo's fork to test ([33d242e](https://github.com/mkdocstrings/griffe-typingdoc/commit/33d242e22237fc4652b86d44c7b8655ded661342) by Timothée Mazzucotelli).
### Features
- Support Python 3.8 thanks to typing-extensions ([489aaac](https://github.com/mkdocstrings/griffe-typingdoc/commit/489aaacd8e2cea3c57dd6c2ce7f9635e4489e8b4) by Timothée Mazzucotelli).
- Implement extension ([5fccd06](https://github.com/mkdocstrings/griffe-typingdoc/commit/5fccd065f6717e195bd7fbc7c4f487ae6bd413b1) by Timothée Mazzucotelli).
- Generate project with copier-pdm ([10139be](https://github.com/mkdocstrings/griffe-typingdoc/commit/10139be2140f73617681a1f7ca2c4514ea9017e5) by Timothée Mazzucotelli).
### Code Refactoring
- Update to support new proposal (https://peps.python.org/pep-0727/) ([bd3eecd](https://github.com/mkdocstrings/griffe-typingdoc/commit/bd3eecdc96755dc4fa50a1cd5049e8366ab2ba72) by Timothée Mazzucotelli).
- Use newer Griffe extensions ([199609f](https://github.com/mkdocstrings/griffe-typingdoc/commit/199609f053c04b8d0c21e7026c5f2eb1ad268ead) by Timothée Mazzucotelli).
- Remove CLI setup ([48dea50](https://github.com/mkdocstrings/griffe-typingdoc/commit/48dea500a5543f389816eee5ef6e98f5541d090d) by Timothée Mazzucotelli).
griffe-typingdoc-0.2.8/CODE_OF_CONDUCT.md 0000664 0000000 0000000 00000012547 14754751525 0017610 0 ustar 00root root 0000000 0000000 # 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
pawamoy@pm.me.
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
griffe-typingdoc-0.2.8/CONTRIBUTING.md 0000664 0000000 0000000 00000010112 14754751525 0017224 0 ustar 00root root 0000000 0000000 # 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 griffe-typingdoc
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.
griffe-typingdoc-0.2.8/LICENSE 0000664 0000000 0000000 00000001362 14754751525 0016007 0 ustar 00root root 0000000 0000000 ISC License
Copyright (c) 2023, 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.
griffe-typingdoc-0.2.8/Makefile 0000664 0000000 0000000 00000000760 14754751525 0016443 0 ustar 00root root 0000000 0000000 # 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.
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 "$@"
griffe-typingdoc-0.2.8/README.md 0000664 0000000 0000000 00000001624 14754751525 0016262 0 ustar 00root root 0000000 0000000 # Griffe TypingDoc
[](https://github.com/mkdocstrings/griffe-typingdoc/actions?query=workflow%3Aci)
[](https://mkdocstrings.github.io/griffe-typingdoc/)
[](https://pypi.org/project/griffe-typingdoc/)
[](https://app.gitter.im/#/room/#griffe-typingdoc:gitter.im)
Griffe extension for [PEP 727 – Documentation Metadata in Typing](https://peps.python.org/pep-0727/).
## Installation
```bash
pip install griffe-typingdoc
```
To use the extension in a MkDocs project,
use this configuration:
```yaml
# mkdocs.yml
plugins:
- mkdocstrings:
handlers:
python:
options:
extensions:
- griffe_typingdoc
```
griffe-typingdoc-0.2.8/config/ 0000775 0000000 0000000 00000000000 14754751525 0016245 5 ustar 00root root 0000000 0000000 griffe-typingdoc-0.2.8/config/coverage.ini 0000664 0000000 0000000 00000000563 14754751525 0020545 0 ustar 00root root 0000000 0000000 [coverage:run]
branch = true
parallel = true
source =
src/
tests/
[coverage:paths]
equivalent =
src/
.venv/lib/*/site-packages/
.venvs/*/lib/*/site-packages/
[coverage:report]
precision = 2
omit =
src/*/__init__.py
src/*/__main__.py
tests/__init__.py
exclude_lines =
pragma: no cover
if TYPE_CHECKING
[coverage:json]
output = htmlcov/coverage.json
griffe-typingdoc-0.2.8/config/git-changelog.toml 0000664 0000000 0000000 00000000340 14754751525 0021647 0 ustar 00root root 0000000 0000000 bump = "auto"
convention = "angular"
in-place = true
output = "CHANGELOG.md"
parse-refs = false
parse-trailers = true
sections = ["build", "deps", "feat", "fix", "refactor"]
template = "keepachangelog"
versioning = "pep440"
griffe-typingdoc-0.2.8/config/mypy.ini 0000664 0000000 0000000 00000000162 14754751525 0017743 0 ustar 00root root 0000000 0000000 [mypy]
ignore_missing_imports = true
exclude = tests/fixtures/
warn_unused_ignores = true
show_error_codes = true
griffe-typingdoc-0.2.8/config/pytest.ini 0000664 0000000 0000000 00000000434 14754751525 0020277 0 ustar 00root root 0000000 0000000 [pytest]
python_files =
test_*.py
addopts =
--cov
--cov-config config/coverage.ini
testpaths =
tests
# action:message_regex:warning_class:module_regex:line
filterwarnings =
error
# TODO: remove once pytest-xdist 4 is released
ignore:.*rsyncdir:DeprecationWarning:xdist
griffe-typingdoc-0.2.8/config/ruff.toml 0000664 0000000 0000000 00000004124 14754751525 0020105 0 ustar 00root root 0000000 0000000 target-version = "py39"
line-length = 120
[lint]
exclude = [
"tests/fixtures/*.py",
]
select = [
"A", "ANN", "ARG",
"B", "BLE",
"C", "C4",
"COM",
"D", "DTZ",
"E", "ERA", "EXE",
"F", "FBT",
"G",
"I", "ICN", "INP", "ISC",
"N",
"PGH", "PIE", "PL", "PLC", "PLE", "PLR", "PLW", "PT", "PYI",
"Q",
"RUF", "RSE", "RET",
"S", "SIM", "SLF",
"T", "T10", "T20", "TCH", "TID", "TRY",
"UP",
"W",
"YTT",
]
ignore = [
"A001", # Variable is shadowing a Python builtin
"ANN101", # Missing type annotation for self
"ANN102", # Missing type annotation for cls
"ANN204", # Missing return type annotation for special method __str__
"ANN401", # Dynamically typed expressions (typing.Any) are disallowed
"ARG005", # Unused lambda argument
"C901", # Too complex
"D105", # Missing docstring in magic method
"D417", # Missing argument description in the docstring
"E501", # Line too long
"ERA001", # Commented out code
"G004", # Logging statement uses f-string
"PLR0911", # Too many return statements
"PLR0912", # Too many branches
"PLR0913", # Too many arguments to function call
"PLR0915", # Too many statements
"SLF001", # Private member accessed
"TRY003", # Avoid specifying long messages outside the exception class
]
[lint.per-file-ignores]
"src/*/cli.py" = [
"T201", # Print statement
]
"src/*/debug.py" = [
"T201", # Print statement
]
"scripts/*.py" = [
"INP001", # File is part of an implicit namespace package
"T201", # Print statement
]
"tests/*.py" = [
"ARG005", # Unused lambda argument
"FBT001", # Boolean positional arg in function definition
"PLR2004", # Magic value used in comparison
"S101", # Use of assert detected
]
[lint.flake8-quotes]
docstring-quotes = "double"
[lint.flake8-tidy-imports]
ban-relative-imports = "all"
[lint.isort]
known-first-party = ["griffe_typingdoc"]
[lint.pydocstyle]
convention = "google"
[format]
exclude = [
"tests/fixtures/*.py",
]
docstring-code-format = true
docstring-code-line-length = 80
griffe-typingdoc-0.2.8/config/vscode/ 0000775 0000000 0000000 00000000000 14754751525 0017530 5 ustar 00root root 0000000 0000000 griffe-typingdoc-0.2.8/config/vscode/launch.json 0000664 0000000 0000000 00000002177 14754751525 0021704 0 ustar 00root root 0000000 0000000 {
"version": "0.2.0",
"configurations": [
{
"name": "python (current file)",
"type": "debugpy",
"request": "launch",
"program": "${file}",
"console": "integratedTerminal",
"justMyCode": false
},
{
"name": "docs",
"type": "debugpy",
"request": "launch",
"module": "mkdocs",
"justMyCode": false,
"args": [
"serve",
"-v"
]
},
{
"name": "test",
"type": "debugpy",
"request": "launch",
"module": "pytest",
"justMyCode": false,
"args": [
"-c=config/pytest.ini",
"-vvv",
"--no-cov",
"--dist=no",
"tests",
"-k=${input:tests_selection}"
]
}
],
"inputs": [
{
"id": "tests_selection",
"type": "promptString",
"description": "Tests selection",
"default": ""
}
]
} griffe-typingdoc-0.2.8/config/vscode/settings.json 0000664 0000000 0000000 00000001704 14754751525 0022265 0 ustar 00root root 0000000 0000000 {
"files.watcherExclude": {
"**/.venv*/**": true,
"**/.venvs*/**": true,
"**/venv*/**": true
},
"mypy-type-checker.args": [
"--config-file=config/mypy.ini"
],
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true,
"python.testing.pytestArgs": [
"--config-file=config/pytest.ini"
],
"ruff.enable": true,
"ruff.format.args": [
"--config=config/ruff.toml"
],
"ruff.lint.args": [
"--config=config/ruff.toml"
],
"yaml.schemas": {
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
},
"yaml.customTags": [
"!ENV scalar",
"!ENV sequence",
"!relative scalar",
"tag:yaml.org,2002:python/name:materialx.emoji.to_svg",
"tag:yaml.org,2002:python/name:materialx.emoji.twemoji",
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
]
} griffe-typingdoc-0.2.8/config/vscode/tasks.json 0000664 0000000 0000000 00000004605 14754751525 0021555 0 ustar 00root root 0000000 0000000 {
"version": "2.0.0",
"tasks": [
{
"label": "changelog",
"type": "process",
"command": "scripts/make",
"args": ["changelog"]
},
{
"label": "check",
"type": "process",
"command": "scripts/make",
"args": ["check"]
},
{
"label": "check-quality",
"type": "process",
"command": "scripts/make",
"args": ["check-quality"]
},
{
"label": "check-types",
"type": "process",
"command": "scripts/make",
"args": ["check-types"]
},
{
"label": "check-docs",
"type": "process",
"command": "scripts/make",
"args": ["check-docs"]
},
{
"label": "check-api",
"type": "process",
"command": "scripts/make",
"args": ["check-api"]
},
{
"label": "clean",
"type": "process",
"command": "scripts/make",
"args": ["clean"]
},
{
"label": "docs",
"type": "process",
"command": "scripts/make",
"args": ["docs"]
},
{
"label": "docs-deploy",
"type": "process",
"command": "scripts/make",
"args": ["docs-deploy"]
},
{
"label": "format",
"type": "process",
"command": "scripts/make",
"args": ["format"]
},
{
"label": "release",
"type": "process",
"command": "scripts/make",
"args": ["release", "${input:version}"]
},
{
"label": "setup",
"type": "process",
"command": "scripts/make",
"args": ["setup"]
},
{
"label": "test",
"type": "process",
"command": "scripts/make",
"args": ["test", "coverage"],
"group": "test"
},
{
"label": "vscode",
"type": "process",
"command": "scripts/make",
"args": ["vscode"]
}
],
"inputs": [
{
"id": "version",
"type": "promptString",
"description": "Version"
}
]
} griffe-typingdoc-0.2.8/docs/ 0000775 0000000 0000000 00000000000 14754751525 0015730 5 ustar 00root root 0000000 0000000 griffe-typingdoc-0.2.8/docs/.overrides/ 0000775 0000000 0000000 00000000000 14754751525 0020010 5 ustar 00root root 0000000 0000000 griffe-typingdoc-0.2.8/docs/.overrides/main.html 0000664 0000000 0000000 00000000500 14754751525 0021615 0 ustar 00root root 0000000 0000000 {% extends "base.html" %}
{% block announce %}
Follow
@pawamoy on
{% include ".icons/fontawesome/brands/mastodon.svg" %}
Fosstodon
for updates
{% endblock %}
griffe-typingdoc-0.2.8/docs/.overrides/partials/ 0000775 0000000 0000000 00000000000 14754751525 0021627 5 ustar 00root root 0000000 0000000 griffe-typingdoc-0.2.8/docs/.overrides/partials/comments.html 0000664 0000000 0000000 00000004125 14754751525 0024344 0 ustar 00root root 0000000 0000000