mkdocstrings-github 0.4.5__tar.gz → 0.5.1__tar.gz

{mkdocstrings_github-0.4.5 → mkdocstrings_github-0.5.1}/.github/CONTRIBUTING.md

@@ -2,7 +2,18 @@
 
 Thank you for considering contributing! Please follow these steps to get started:
 
-## 1. Environment Setup
+## 1. Clone repository
+
+Clone the repository and setup its submodules. The [watermarkhu/mkdocstrings-github-fixture](https://github.com/watermarkhu/mkdocstrings-github-fixture) repository is used as a fixture repository. 
+
+```sh
+git clone https://github.com/watermarkhu/mkdocstrings-github
+cd mkdocstrings-github
+git submodule init
+git submodule update
+```
+
+## 2. Environment Setup
 
 Install all dependencies using [uv](https://github.com/astral-sh/uv):
 
@@ -12,7 +23,7 @@ uv sync --all-groups
 
 Learn more about uv: [uv documentation](https://github.com/astral-sh/uv)
 
-## 2. Pre-commit Hooks using prek
+## 3. Pre-commit Hooks using prek
 
 Set up [prek](https://github.com/j178/prek) hooks to ensure code quality:
 
@@ -22,7 +33,7 @@ uv run prek install
 
 See: [prek documentation](https://prek.j178.dev/)
 
-## 3. Running Tests
+## 4. Running Tests
 
 Run tests with [pytest](https://docs.pytest.org/en/stable/):
 
@@ -32,7 +43,7 @@ uv run pytest
 
 See: [pytest documentation](https://docs.pytest.org/en/stable/)
 
-## 4. Pull Request Guidelines
+## 5. Pull Request Guidelines
 
 - Pull requests should target the `main` branch.
 - Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages.

{mkdocstrings_github-0.4.5 → mkdocstrings_github-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-github
-Version: 0.4.5
+Version: 0.5.1
 Summary: A GitHub Action handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT
@@ -33,14 +33,26 @@ Description-Content-Type: text/markdown
 
 <p align="center">A GitHub Actions handler for <a href="https://github.com/mkdocstrings/mkdocstrings"><i>mkdocstrings</i></a>.</p>
 
-<p align="center"><img width=300px src="logo.png"></p>
+<!-- --8<-- [end:header] -->
+
+<p align="center"><img width=300px src="docs/img/logo.png"></p>
 
 [![Qualify](https://github.com/watermarkhu/mkdocstrings-github/actions/workflows/qualify.yaml/badge.svg?branch=main)](https://github.com/watermarkhu/mkdocstrings-github/actions/workflows/qualify.yaml)
 [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://watermarkhu.nl/mkdocstrings-github)
 [![pypi version](https://img.shields.io/pypi/v/mkdocstrings-github.svg)](https://pypi.org/project/mkdocstrings-github/)
 [![codecov](https://codecov.io/github/watermarkhu/mkdocstrings-github/graph/badge.svg?token=M6XW8UeURE)](https://codecov.io/github/watermarkhu/mkdocstrings-github)
 
-<!-- --8<-- [end:header] -->
+
+
+For example, the following page is generated from [actions/checkout](https://github.com/actions/checkout):
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="docs/img/example_dark.png">
+  <source media="(prefers-color-scheme: light)" srcset="docs/img/example_light.png">
+  <img alt="Fallback image description" src="docs/img/example_light.png">
+</picture>
+
+
 <!-- --8<-- [start:install] -->
 You can install the GitHub handler by specifying it as a dependency:
 
@@ -49,9 +61,17 @@ You can install the GitHub handler by specifying it as a dependency:
 # adapt to your dependencies manager
 [project]
 dependencies = [
-    "mkdocstrings-github>=0.X.Y",
+    "mkdocstrings-github",
 ]
 ```
+
+after which the generated documentation can be inserted in the markdown page with:
+
+```md
+::: <path-to-action-or-workflow>
+    handler: github
+```
+
 <!-- --8<-- [end:install] -->
 
 <!-- --8<-- [start:footer] -->

{mkdocstrings_github-0.4.5 → mkdocstrings_github-0.5.1}/README.md

@@ -4,14 +4,26 @@
 
 <p align="center">A GitHub Actions handler for <a href="https://github.com/mkdocstrings/mkdocstrings"><i>mkdocstrings</i></a>.</p>
 
-<p align="center"><img width=300px src="logo.png"></p>
+<!-- --8<-- [end:header] -->
+
+<p align="center"><img width=300px src="docs/img/logo.png"></p>
 
 [![Qualify](https://github.com/watermarkhu/mkdocstrings-github/actions/workflows/qualify.yaml/badge.svg?branch=main)](https://github.com/watermarkhu/mkdocstrings-github/actions/workflows/qualify.yaml)
 [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://watermarkhu.nl/mkdocstrings-github)
 [![pypi version](https://img.shields.io/pypi/v/mkdocstrings-github.svg)](https://pypi.org/project/mkdocstrings-github/)
 [![codecov](https://codecov.io/github/watermarkhu/mkdocstrings-github/graph/badge.svg?token=M6XW8UeURE)](https://codecov.io/github/watermarkhu/mkdocstrings-github)
 
-<!-- --8<-- [end:header] -->
+
+
+For example, the following page is generated from [actions/checkout](https://github.com/actions/checkout):
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="docs/img/example_dark.png">
+  <source media="(prefers-color-scheme: light)" srcset="docs/img/example_light.png">
+  <img alt="Fallback image description" src="docs/img/example_light.png">
+</picture>
+
+
 <!-- --8<-- [start:install] -->
 You can install the GitHub handler by specifying it as a dependency:
 
@@ -20,9 +32,17 @@ You can install the GitHub handler by specifying it as a dependency:
 # adapt to your dependencies manager
 [project]
 dependencies = [
-    "mkdocstrings-github>=0.X.Y",
+    "mkdocstrings-github",
 ]
 ```
+
+after which the generated documentation can be inserted in the markdown page with:
+
+```md
+::: <path-to-action-or-workflow>
+    handler: github
+```
+
 <!-- --8<-- [end:install] -->
 
 <!-- --8<-- [start:footer] -->

mkdocstrings_github-0.5.1/action.yaml

@@ -0,0 +1,114 @@
+name: 'Checkout'
+description: 'Checkout a Git repository at a particular version'
+
+branding:
+  icon: 'github'
+  color: 'blue'
+
+inputs:
+  repository:
+    description: 'Repository name with owner. For example, actions/checkout'
+    default: ${{ github.repository }}
+  ref:
+    description: >
+      The branch, tag or SHA to checkout. When checking out the repository that
+      triggered a workflow, this defaults to the reference or SHA for that
+      event.  Otherwise, uses the default branch.
+  token:
+    description: >
+      Personal access token (PAT) used to fetch the repository. The PAT is configured
+      with the local git config, which enables your scripts to run authenticated git
+      commands. The post-job step removes the PAT.
+
+
+      We recommend using a service account with the least permissions necessary.
+      Also when generating a new PAT, select the least scopes necessary.
+
+
+      [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
+    default: ${{ github.token }}
+  ssh-key:
+    description: >
+      SSH key used to fetch the repository. The SSH key is configured with the local
+      git config, which enables your scripts to run authenticated git commands.
+      The post-job step removes the SSH key.
+
+
+      We recommend using a service account with the least permissions necessary.
+
+
+      [Learn more about creating and using
+      encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
+  ssh-known-hosts:
+    description: >
+      Known hosts in addition to the user and global host key database. The public
+      SSH keys for a host may be obtained using the utility `ssh-keyscan`. For example,
+      `ssh-keyscan github.com`. The public key for github.com is always implicitly added.
+  ssh-strict:
+    description: >
+      Whether to perform strict host key checking. When true, adds the options `StrictHostKeyChecking=yes`
+      and `CheckHostIP=no` to the SSH command line. Use the input `ssh-known-hosts` to
+      configure additional hosts.
+    default: true
+  ssh-user:
+    description: >
+      The user to use when connecting to the remote SSH host. By default 'git' is used.
+    default: git
+  persist-credentials:
+    description: 'Whether to configure the token or SSH key with the local git config'
+    default: true
+  path:
+    description: 'Relative path under $GITHUB_WORKSPACE to place the repository'
+  clean:
+    description: 'Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching'
+    default: true
+  filter:
+    description: >
+      Partially clone against a given filter.
+      Overrides sparse-checkout if set.
+    default: null
+  sparse-checkout:
+    description: >
+      Do a sparse checkout on given patterns.
+      Each pattern should be separated with new lines.
+    default: null
+  sparse-checkout-cone-mode:
+    description: >
+      Specifies whether to use cone-mode when doing a sparse checkout.
+    default: true
+  fetch-depth:
+    description: 'Number of commits to fetch. 0 indicates all history for all branches and tags.'
+    default: 1
+  fetch-tags:
+    description: 'Whether to fetch tags, even if fetch-depth > 0.'
+    default: false
+  show-progress:
+    description: 'Whether to show progress status output when fetching.'
+    default: true
+  lfs:
+    description: 'Whether to download Git-LFS files'
+    default: false
+  submodules:
+    description: >
+      Whether to checkout submodules: `true` to checkout submodules or `recursive` to
+      recursively checkout submodules.
+
+
+      When the `ssh-key` input is not provided, SSH URLs beginning with `git@github.com:` are
+      converted to HTTPS.
+    default: false
+  set-safe-directory:
+    description: Add repository path as safe.directory for Git global config by running `git config --global --add safe.directory <path>`
+    default: true
+  github-server-url:
+    description: The base URL for the GitHub instance that you are trying to clone from, will use environment defaults to fetch from the same instance that the workflow is running from unless specified. Example URLs are https://github.com or https://my-ghes-server.example.com
+    required: false
+outputs:
+  ref:
+    description: 'The branch, tag or SHA that was checked out'
+  commit:
+    description: 'The commit SHA that was checked out'
+runs:
+  using: node24
+  main: dist/index.js
+  post: dist/index.js

mkdocstrings_github-0.5.1/docs/changelog.md

@@ -0,0 +1,227 @@
+# CHANGELOG
+
+<!-- version list -->
+
+## v0.5.1 (2025-10-14)
+
+### Bug Fixes
+
+- Do not validate signature_repository
+  ([#34](https://github.com/watermarkhu/mkdocstrings-github/pull/34),
+  [`3ead525`](https://github.com/watermarkhu/mkdocstrings-github/commit/3ead5253eb68e9a5fb5def55e807801afc1ef106))
+
+
+## v0.5.0 (2025-10-13)
+
+### Bug Fixes
+
+- Properly show read-all/write-all permissions
+  ([#33](https://github.com/watermarkhu/mkdocstrings-github/pull/33),
+  [`5f5e792`](https://github.com/watermarkhu/mkdocstrings-github/commit/5f5e7921fd326bbcdec903101107c6128dab5dbf))
+
+### Documentation
+
+- Better docs with actions/checkout example
+  ([#33](https://github.com/watermarkhu/mkdocstrings-github/pull/33),
+  [`5f5e792`](https://github.com/watermarkhu/mkdocstrings-github/commit/5f5e7921fd326bbcdec903101107c6128dab5dbf))
+
+### Features
+
+- Move signature repository name to local options
+  ([#33](https://github.com/watermarkhu/mkdocstrings-github/pull/33),
+  [`5f5e792`](https://github.com/watermarkhu/mkdocstrings-github/commit/5f5e7921fd326bbcdec903101107c6128dab5dbf))
+
+
+## v0.4.5 (2025-10-13)
+
+### Refactoring
+
+- Show annotation in stead of empty
+  ([#32](https://github.com/watermarkhu/mkdocstrings-github/pull/32),
+  [`46942af`](https://github.com/watermarkhu/mkdocstrings-github/commit/46942af6c6c2794830738749909edd39ea2ca204))
+
+- Show annotation instead of empty
+  ([#32](https://github.com/watermarkhu/mkdocstrings-github/pull/32),
+  [`46942af`](https://github.com/watermarkhu/mkdocstrings-github/commit/46942af6c6c2794830738749909edd39ea2ca204))
+
+
+## v0.4.4 (2025-10-13)
+
+### Bug Fixes
+
+- **templates**: Hide signature sections properly
+  ([#31](https://github.com/watermarkhu/mkdocstrings-github/pull/31),
+  [`86d9628`](https://github.com/watermarkhu/mkdocstrings-github/commit/86d9628770ab235280ffc65434009355946b7d0c))
+
+
+## v0.4.3 (2025-10-12)
+
+### Bug Fixes
+
+- Hide secrets and inputs from signature if there are none
+  ([#30](https://github.com/watermarkhu/mkdocstrings-github/pull/30),
+  [`f9831f6`](https://github.com/watermarkhu/mkdocstrings-github/commit/f9831f648b8eeed287f35843a1d15c7f845c1bb0))
+
+### Continuous Integration
+
+- More tests ([#30](https://github.com/watermarkhu/mkdocstrings-github/pull/30),
+  [`f9831f6`](https://github.com/watermarkhu/mkdocstrings-github/commit/f9831f648b8eeed287f35843a1d15c7f845c1bb0))
+
+### Performance Improvements
+
+- Use GITHUB_REPOSITORY env var in GitHub Actions
+  ([#30](https://github.com/watermarkhu/mkdocstrings-github/pull/30),
+  [`f9831f6`](https://github.com/watermarkhu/mkdocstrings-github/commit/f9831f648b8eeed287f35843a1d15c7f845c1bb0))
+
+
+## v0.4.2 (2025-10-08)
+
+### Bug Fixes
+
+- Better package tag ordering ([#28](https://github.com/watermarkhu/mkdocstrings-github/pull/28),
+  [`10dc87a`](https://github.com/watermarkhu/mkdocstrings-github/commit/10dc87a001908af6522320a5248ce4c988e441a3))
+
+
+## v0.4.1 (2025-10-08)
+
+### Bug Fixes
+
+- Tag ordering ([#27](https://github.com/watermarkhu/mkdocstrings-github/pull/27),
+  [`76256f5`](https://github.com/watermarkhu/mkdocstrings-github/commit/76256f52bbd53be825ba0a0576d7cb6a6da54d3a))
+
+### Documentation
+
+- Update docs ([#26](https://github.com/watermarkhu/mkdocstrings-github/pull/26),
+  [`96f650f`](https://github.com/watermarkhu/mkdocstrings-github/commit/96f650f1d4af5b5d6da4704e7b2184e4016f3a39))
+
+
+## v0.4.0 (2025-10-08)
+
+### Continuous Integration
+
+- **deps**: Update actions/checkout action to v5
+  ([#22](https://github.com/watermarkhu/mkdocstrings-github/pull/22),
+  [`fc56971`](https://github.com/watermarkhu/mkdocstrings-github/commit/fc569719b4387f11119de588d2f67f1daa09c233))
+
+- **deps**: Update astral-sh/setup-uv action to v7
+  ([#24](https://github.com/watermarkhu/mkdocstrings-github/pull/24),
+  [`a07de53`](https://github.com/watermarkhu/mkdocstrings-github/commit/a07de53b318859a365215730c2c09d0d5fdcf5b1))
+
+### Features
+
+- Get releases using tags ([#25](https://github.com/watermarkhu/mkdocstrings-github/pull/25),
+  [`25ea11d`](https://github.com/watermarkhu/mkdocstrings-github/commit/25ea11d8c0f92a1e49f8b35b60456259e4e0ec7b))
+
+
+## v0.3.0 (2025-10-07)
+
+### Bug Fixes
+
+- Prek configuration with local uv
+  ([#20](https://github.com/watermarkhu/mkdocstrings-github/pull/20),
+  [`0d53c40`](https://github.com/watermarkhu/mkdocstrings-github/commit/0d53c4029fc0f2e30f4f223b6d81221236254832))
+
+### Build System
+
+- **deps**: Update dependency ruff to ~=0.14.0
+  ([#21](https://github.com/watermarkhu/mkdocstrings-github/pull/21),
+  [`f87cf24`](https://github.com/watermarkhu/mkdocstrings-github/commit/f87cf2485121f4056279ce06ed721e02fc475f1b))
+
+### Continuous Integration
+
+- Add codecov ([#20](https://github.com/watermarkhu/mkdocstrings-github/pull/20),
+  [`0d53c40`](https://github.com/watermarkhu/mkdocstrings-github/commit/0d53c4029fc0f2e30f4f223b6d81221236254832))
+
+- **deps**: Update peter-evans/create-or-update-comment action to v5
+  ([#19](https://github.com/watermarkhu/mkdocstrings-github/pull/19),
+  [`8135a2b`](https://github.com/watermarkhu/mkdocstrings-github/commit/8135a2bff69a41bde0676b991145ff089563bf7b))
+
+### Features
+
+- Hide default and section if non are available
+  ([#20](https://github.com/watermarkhu/mkdocstrings-github/pull/20),
+  [`0d53c40`](https://github.com/watermarkhu/mkdocstrings-github/commit/0d53c4029fc0f2e30f4f223b6d81221236254832))
+
+- Hide default and section if non are available.
+  ([#20](https://github.com/watermarkhu/mkdocstrings-github/pull/20),
+  [`0d53c40`](https://github.com/watermarkhu/mkdocstrings-github/commit/0d53c4029fc0f2e30f4f223b6d81221236254832))
+
+
+## v0.2.6 (2025-10-02)
+
+### Bug Fixes
+
+- Empty workflow_call ([#18](https://github.com/watermarkhu/mkdocstrings-github/pull/18),
+  [`368b9b5`](https://github.com/watermarkhu/mkdocstrings-github/commit/368b9b5097d6d0c061cb9addbfc9fc721a16dea7))
+
+### Continuous Integration
+
+- **deps**: Update peter-evans/find-comment action to v4
+  ([#17](https://github.com/watermarkhu/mkdocstrings-github/pull/17),
+  [`8e2375d`](https://github.com/watermarkhu/mkdocstrings-github/commit/8e2375d1df0a9883c9a365dfc5b2563997fb1f70))
+
+
+## v0.2.5 (2025-09-29)
+
+### Bug Fixes
+
+- No repo set ([#16](https://github.com/watermarkhu/mkdocstrings-github/pull/16),
+  [`554d230`](https://github.com/watermarkhu/mkdocstrings-github/commit/554d230a3c8da0bee86a2c8b2805c873852d6bfd))
+
+### Documentation
+
+- Small fix ([#15](https://github.com/watermarkhu/mkdocstrings-github/pull/15),
+  [`22c6693`](https://github.com/watermarkhu/mkdocstrings-github/commit/22c669395cce94b315ab08434fdc4e7ba167f7a5))
+
+
+## v0.2.4 (2025-09-29)
+
+### Bug Fixes
+
+- Allow setting hostname ([#14](https://github.com/watermarkhu/mkdocstrings-github/pull/14),
+  [`4676e57`](https://github.com/watermarkhu/mkdocstrings-github/commit/4676e57cda03b8a52ae6facf4a28f3dde9adb365))
+
+- Set hostname ([#14](https://github.com/watermarkhu/mkdocstrings-github/pull/14),
+  [`4676e57`](https://github.com/watermarkhu/mkdocstrings-github/commit/4676e57cda03b8a52ae6facf4a28f3dde9adb365))
+
+
+## v0.2.3 (2025-09-29)
+
+### Bug Fixes
+
+- Default host ([#13](https://github.com/watermarkhu/mkdocstrings-github/pull/13),
+  [`8ac9b06`](https://github.com/watermarkhu/mkdocstrings-github/commit/8ac9b062e53b47e27cc1adad6c206087d8a7da1a))
+
+
+## v0.2.2 (2025-09-29)
+
+### Bug Fixes
+
+- Get GH_TOKEN ([#12](https://github.com/watermarkhu/mkdocstrings-github/pull/12),
+  [`3c449ea`](https://github.com/watermarkhu/mkdocstrings-github/commit/3c449ea0bfeaac96667d7d31b668d25921279bd6))
+
+
+## v0.2.1 (2025-09-29)
+
+### Bug Fixes
+
+- GitHub Enterprise with GH_HOST ([#11](https://github.com/watermarkhu/mkdocstrings-github/pull/11),
+  [`4f59dc0`](https://github.com/watermarkhu/mkdocstrings-github/commit/4f59dc07eb1f564d31431e4f3bf2e6fb1bcdfeb6))
+
+### Documentation
+
+- Update docs ([#10](https://github.com/watermarkhu/mkdocstrings-github/pull/10),
+  [`3be05f5`](https://github.com/watermarkhu/mkdocstrings-github/commit/3be05f57605fbf12ab9c1ea8583775e1e47b25f2))
+
+
+## v0.2.0 (2025-09-28)
+
+### Features
+
+- Cross-linking ([#9](https://github.com/watermarkhu/mkdocstrings-github/pull/9),
+  [`6bcf229`](https://github.com/watermarkhu/mkdocstrings-github/commit/6bcf229ad97702a44ba68ceb135ffd4b53208339))
+
+
+## v0.1.0 (2025-09-28)
+
+- Initial Release

{mkdocstrings_github-0.4.5 → mkdocstrings_github-0.5.1}/docs/index.md

@@ -5,8 +5,13 @@ hide:
 
 --8<-- "README.md:header"
 
+<p align="center"><img width=300px src="img/logo.png"></p>
+
 --8<-- "README.md:footer"
 
+!!! note
+
+    Currently, only the [Material for MkDocs](https://github.com/squidfunk/mkdocs-material) theme is supported.
 
 ???+ example
 
@@ -25,6 +30,7 @@ hide:
         options:
             show_outputs: true
             signature_version: string
-            signature_version_string: v1
+            signature_version_string: v5
+            signature_repository: actions/checkout
             show_source: false
     </div>

{mkdocstrings_github-0.4.5 → mkdocstrings_github-0.5.1}/docs/usage/index.md

@@ -100,9 +100,6 @@ plugins:
 
 Some options are **global only**, and go directly under the handler's name.
 
-::: mkdocstrings_handlers.github.config.GitHubConfig.repo
-    handler: python
-
 ::: mkdocstrings_handlers.github.config.GitHubConfig.feather_icons_source
     handler: python
 

{mkdocstrings_github-0.4.5 → mkdocstrings_github-0.5.1}/docs/usage/signatures.md

@@ -31,6 +31,28 @@
             options:
                 show_signature: false
 
+::: mkdocstrings_handlers.github.config.GitHubOptions.signature_repository
+    handler: python
+
+!!! tip 
+
+    By default the current repository name is automatically grabbed from either the GitHub Actions environment or the git remotes. 
+    This option only serves to *customize* the shown repository in the signature. 
+
+??? preview
+
+    === "`signature_repository: username/repo`"
+
+        ::: .github/workflows/example_workflow.yml
+            options:
+                signature_repository: 'username/repo'
+
+    === "`signature_repository: organization/repository`"
+        
+        ::: .github/workflows/example_workflow.yml
+            options:
+                signature_repository: organization/repository
+
 ::: mkdocstrings_handlers.github.config.GitHubOptions.signature_show_secrets
     handler: python
 

{mkdocstrings_github-0.4.5 → mkdocstrings_github-0.5.1}/mkdocs.yml

@@ -15,7 +15,6 @@ validation:
 nav:
 - Home:
   - Overview: index.md
-  - Changelog: changelog.md
   - Contributing: contributing.md
   - Credits: credits.md
   - License: license-page.md
@@ -31,7 +30,7 @@ nav:
 
 theme:
   name: material
-  logo: logo.png
+  logo: img/logo.png
   favicon: favicon.png
   custom_dir: docs/overrides
   features:
@@ -120,8 +119,8 @@ plugins:
     default_handler: github
     handlers:
       github:
-        repo: owner/repository
         options:
+          signature_repository: owner/repository
           show_toc_entry: false
           heading_level: 3
           parameters_anchors: false

{mkdocstrings_github-0.4.5 → mkdocstrings_github-0.5.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocstrings-github"
-version = "0.4.5"
+version = "0.5.1"
 description = "A GitHub Action handler for mkdocstrings"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }

{mkdocstrings_github-0.4.5 → mkdocstrings_github-0.5.1}/src/mkdocstrings_handlers/github/config.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 
-import re
 import sys
 from typing import Literal
 
@@ -92,6 +91,15 @@ class GitHubOptions(BaseModel):
         description="Whether to show the signature in the documentation.",
     )
 
+    signature_repository: str = Field(
+        default="",
+        description="""The GitHub repository in the format *owner/repo*.
+
+        By default, the repository is inferred from the current git repository using the default origin remote.
+        If it cannot be inferred, it must be set manually.
+        """,
+    )
+
     signature_show_secrets: bool = Field(
         default=False,
         description="Whether to show secrets in the signature.",
@@ -171,16 +179,6 @@ class GitHubOptions(BaseModel):
 class GitHubConfig(BaseModel):
     """Configuration options for the GitHub handler."""
 
-    repo: str = Field(
-        default="",
-        description="""The GitHub repository in the format *owner/repo*.
-
-        By default, the repository is inferred from the current git repository using the default origin remote.
-        If it cannot be inferred, it must be set manually.
-        """,
-        pattern=re.compile(r"^[\w.-]+/[\w.-]+$"),
-    )
-
     feather_icons_source: str = Field(
         default="https://cdn.jsdelivr.net/npm/feather-icons/dist/feather.min.js",
         description="""The source URL for Feather icons.