mkdocstrings-github 0.7.0__tar.gz → 0.7.1__tar.gz

mkdocstrings_github-0.7.1/.github/workflows/docs.yaml

@@ -0,0 +1,55 @@
+name: Docs
+
+# Controls when the workflow will run
+on:
+  workflow_call:
+    inputs:
+      ref:
+        description: >-
+          The ref to checkout and use to create docs
+        type: string
+        default: ""
+      push:
+        description: >-
+          Push the documentation to the remote branch
+        type: boolean
+        default: true
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/configure-pages@v5
+
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0 # Required to push to the documentation branch
+          ref: ${{ inputs.ref }} 
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: "latest"
+  
+      - name: Sync dependencies
+        run: |
+          uv sync --no-dev --group docs
+
+      - name: Build documentation
+        run: |
+          uv run zensical build --clean
+        
+      - uses: actions/upload-pages-artifact@v4
+        if: ${{ inputs.push }}
+        with:
+          path: site
+
+      - uses: actions/deploy-pages@v4
+        if: ${{ inputs.push }}
+        id: deployment

{mkdocstrings_github-0.7.0 → mkdocstrings_github-0.7.1}/.github/workflows/example_workflow.yml

@@ -71,7 +71,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
           
       - run: |
           echo "Validating version: ${{ inputs.version }}"

{mkdocstrings_github-0.7.0 → mkdocstrings_github-0.7.1}/.github/workflows/qualify.yaml

@@ -24,12 +24,11 @@ jobs:
     name: Test deploy documentation
     uses: ./.github/workflows/docs.yaml
     permissions: 
-      contents: write
+      contents: read
+      pages: write
+      id-token: write
     secrets: inherit
     with:
-      version: ${{ format('pr-{0}', github.head_ref) || 'test' }}
-      alias: "test"
-      set-default: false
       push: false
 
   setup:

{mkdocstrings_github-0.7.0 → mkdocstrings_github-0.7.1}/.github/workflows/release.yaml

@@ -153,11 +153,10 @@ jobs:
     if: github.event.pull_request.merged
     uses: ./.github/workflows/docs.yaml
     permissions:
-      contents: write
+      contents: read
+      pages: write
+      id-token: write
     secrets: inherit
     with:
-      version: ${{ needs.release.outputs.next-tag || needs.release.outputs.last-tag }}
-      alias: latest
-      set-default: true
       ref: ${{ needs.release.outputs.next-tag }}
       push: true

{mkdocstrings_github-0.7.0 → mkdocstrings_github-0.7.1}/.pre-commit-config.yaml

@@ -7,7 +7,7 @@ repos:
       - id: check-merge-conflict
 
   - repo: https://github.com/abravalheri/validate-pyproject
-    rev: v0.24.1
+    rev: v0.25
     hooks:
       - id: validate-pyproject
 

{mkdocstrings_github-0.7.0 → mkdocstrings_github-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-github
-Version: 0.7.0
+Version: 0.7.1
 Summary: A GitHub Action handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT

{mkdocstrings_github-0.7.0 → mkdocstrings_github-0.7.1}/docs/changelog.md

@@ -2,6 +2,35 @@
 
 <!-- version list -->
 
+## v0.7.1 (2026-02-03)
+
+### Bug Fixes
+
+- Build with zensical ([#51](https://github.com/watermarkhu/mkdocstrings-github/pull/51),
+  [`da116f2`](https://github.com/watermarkhu/mkdocstrings-github/commit/da116f20d0c7eaef694a863542450dd313ca85bd))
+
+### Build System
+
+- **deps**: Update dependency ruff to ~=0.15.0
+  ([#52](https://github.com/watermarkhu/mkdocstrings-github/pull/52),
+  [`7e20a99`](https://github.com/watermarkhu/mkdocstrings-github/commit/7e20a99bee878c598385d79b902bc9a9b59924cb))
+
+- **deps**: Update pre-commit hook abravalheri/validate-pyproject to v0.25
+  ([#50](https://github.com/watermarkhu/mkdocstrings-github/pull/50),
+  [`840303e`](https://github.com/watermarkhu/mkdocstrings-github/commit/840303e040c241645b0d86ebc9ed3668aba1ea6e))
+
+### Continuous Integration
+
+- **deps**: Update actions/checkout action to v6
+  ([#49](https://github.com/watermarkhu/mkdocstrings-github/pull/49),
+  [`60860d7`](https://github.com/watermarkhu/mkdocstrings-github/commit/60860d7c03ba10c75959219c96faf8e2906586d5))
+
+### Documentation
+
+- Build with zensical ([#51](https://github.com/watermarkhu/mkdocstrings-github/pull/51),
+  [`da116f2`](https://github.com/watermarkhu/mkdocstrings-github/commit/da116f20d0c7eaef694a863542450dd313ca85bd))
+
+
 ## v0.7.0 (2026-01-13)
 
 ### Features

{mkdocstrings_github-0.7.0 → mkdocstrings_github-0.7.1}/docs/usage/index.md

@@ -18,7 +18,7 @@
 
 ## Installation
 
-This package is extension package to [*mkdocstrings*](https://mkdocstrings.github.io/), a framework for auto-documentation for various languages. Language support is inserted into the framework by providing *handlers*. The *mkdocstrings-github* package provides a GitHub handler.
+This package is an extension for [*mkdocstrings*](https://mkdocstrings.github.io/), a framework for auto-documentation within [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) or [Zensical](https://zensical.org/about/). Language support is inserted into the framework by providing *handlers*. The *mkdocstrings-github* package provides a GitHub handler.
 
 --8<-- "README.md:install"
 

{mkdocstrings_github-0.7.0 → mkdocstrings_github-0.7.1}/mkdocs.yml

@@ -35,7 +35,6 @@ nav:
 - mkdocstrings: https://mkdocstrings.github.io/
 
 theme:
-  name: material
   logo: img/logo.png
   favicon: favicon.png
   custom_dir: docs/overrides
@@ -99,7 +98,7 @@ markdown_extensions:
     pygments_lang_class: true
 - pymdownx.magiclink
 - pymdownx.snippets:
-    base_path: [!relative $config_dir]
+    base_path: .
     check_paths: true
 - pymdownx.superfences:
     custom_fences:

{mkdocstrings_github-0.7.0 → mkdocstrings_github-0.7.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocstrings-github"
-version = "0.7.0"
+version = "0.7.1"
 description = "A GitHub Action handler for mkdocstrings"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }
@@ -36,7 +36,7 @@ dependencies = [
 [dependency-groups]
 dev = [
     "ty~=0.0.11",
-    "ruff~=0.14.0",
+    "ruff~=0.15.0",
     "prek>=0.2.1",
     "pydantic~=2.12",
     "pytest~=9.0.0",
@@ -46,15 +46,14 @@ dev = [
     "python-semantic-release~=10.5.0",
 ]
 docs = [
-    "mkdocs-material~=9.5",
     "mkdocs-callouts~=1.15",
     "mkdocs-git-revision-date-localized-plugin~=1.3",
     "mkdocs-minify-plugin~=0.8",
     "mkdocstrings-python~=2.0.0",
-    "mike~=2.1",
     "griffe-pydantic~=1.2.0",
     "mkdocs-mermaid2-plugin~=1.2.3",
     "mkdocs-panzoom-plugin~=0.5.2",
+    "zensical>=0.0.15",
 ]
 
 

{mkdocstrings_github-0.7.0 → mkdocstrings_github-0.7.1}/src/mkdocstrings_handlers/github/handler.py

@@ -236,11 +236,15 @@ def get_handler(
     Returns:
         GitHubHandler: An instance of GitHubHandler configured with the provided parameters.
     """
-    config_file = Path(tool_config.config_file_path)
-    repo = git.Repo(path=config_file.parent, search_parent_directories=True)
+    if tool_config.config_file_path is None:
+        root = Path.cwd()
+    else:
+        root = Path(tool_config.config_file_path).parent
+    repo = git.Repo(path=root, search_parent_directories=True)
+    config = GitHubConfig(**handler_config)
 
     return GitHubHandler(
-        config=GitHubConfig(**handler_config),
+        config=config,
         repo=repo,
         **kwargs,
     )

mkdocstrings_github-0.7.0/.github/workflows/docs.yaml

@@ -1,80 +0,0 @@
-name: Docs
-
-# Controls when the workflow will run
-on:
-  workflow_call:
-    inputs:
-      version:
-        description: >-
-          Version of the documentation to publish
-        type: string
-        required: true
-      alias:
-        description: >-
-          (Versioned) Alias to use when publishing the versioned documentation with mike
-        type: string
-        default: "latest"
-      set-default:
-        description: >-
-          Set the alias as the default version
-        type: boolean
-        default: true
-      ref:
-        description: >-
-          The ref to checkout and use to create docs
-        type: string
-        default: ""
-      push:
-        description: >-
-          Push the documentation to the remote branch
-        type: boolean
-        default: true
-
-permissions:
-  contents: write
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v6
-        with:
-          fetch-depth: 0 # Required to push to the documentation branch
-          ref: ${{ inputs.ref }} 
-
-      - name: Install the latest version of uv
-        uses: astral-sh/setup-uv@v7
-        with:
-          version: "latest"
-  
-      - name: Sync dependencies
-        run: |
-          uv sync --no-dev --group docs
-
-      - name: Configure Git Credentials
-        run: |
-          git config --global user.name github-actions[bot]
-          git config --global user.email 41898282+github-actions[bot]@users.noreply.github.com
-  
-      - name: Build documentation with mike
-        shell: bash
-        env:
-          VERSION: ${{ inputs.version }}
-        run: |
-          if [[ $VERSION =~ ^v([0-9]+)\.([0-9]+)\.([0-9]+)$ ]]; then
-            VERSION="v${BASH_REMATCH[1]}.${BASH_REMATCH[2]}.*"
-            echo "Patching version "${{ inputs.version}}" to $VERSION"
-          fi
-          uv run mike deploy ${{ fromJson(inputs.push) && '--push' || '' }} \
-            --update-aliases \
-            --branch gh-pages \
-            --alias-type symlink \
-            "${VERSION}" "${{ inputs.alias }}"
-      
-      - name: Set default alias for mike 
-        if: ${{ fromJson(inputs.set-default) }}
-        run: >
-          uv run mike set-default ${{ fromJson(inputs.push) && '--push' || '' }}
-          --branch gh-pages
-          ${{ inputs.alias }}