mkdocstrings-github 0.4.0__tar.gz → 0.4.2__tar.gz

{mkdocstrings_github-0.4.0 → mkdocstrings_github-0.4.2}/.github/workflows/docs.yaml

@@ -59,24 +59,20 @@ jobs:
   
       - name: Build documentation with mike
         shell: bash
-        env:
-          PUSH_DEPLOY: ${{ fromJson(inputs.push) && '--push' || '' }}
-          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 ${PUSH_DEPLOY} \
+          uv run mike deploy ${{ fromJson(inputs.push) && '--push' || '' }} \
             --update-aliases \
             --branch gh-pages \
             --alias-type symlink \
-            "$VERSION" "${{ inputs.alias }}"
+            "${{ inputs.version }}" "${{ inputs.alias }}"
       
       - name: Set default alias for mike 
         if: ${{ fromJson(inputs.set-default) }}
         run: >
-          uv run mike set-default
-          --branch gh-pages 
-          --push
+          uv run mike set-default ${{ fromJson(inputs.push) && '--push' || '' }}
+          --branch gh-pages
           ${{ inputs.alias }}

{mkdocstrings_github-0.4.0 → mkdocstrings_github-0.4.2}/.github/workflows/qualify.yaml

@@ -23,9 +23,6 @@ jobs:
   docs:
     name: Test deploy documentation
     uses: ./.github/workflows/docs.yaml
-    concurrency:
-      group: gh-pages
-      cancel-in-progress: false
     permissions: 
       contents: write
     secrets: inherit
@@ -33,7 +30,7 @@ jobs:
       version: ${{ format('pr-{0}', github.head_ref) || 'test' }}
       alias: "test"
       set-default: false
-      push: ${{ contains(github.event.pull_request.labels.*.name, 'documentation') }}
+      push: false
 
   setup:
     runs-on: ubuntu-latest

{mkdocstrings_github-0.4.0 → mkdocstrings_github-0.4.2}/.github/workflows/release.yaml

@@ -19,6 +19,7 @@ jobs:
     outputs:
       released: ${{ steps.get-version.outputs.released == 'true' }}
       next-tag: ${{ steps.get-version.outputs.next-tag }}
+      last-tag: ${{ steps.get-version.outputs.last-tag }}
 
     steps:
     - uses: actions/create-github-app-token@v2
@@ -146,61 +147,16 @@ jobs:
           dist/*.whl
           dist/*.tar.gz
 
-  delete-test-document:
-    name: Delete test documentation
-    runs-on: ubuntu-latest
-    if: contains(github.event.pull_request.labels.*.name, 'documentation') && (github.event.action == 'closed')
-    concurrency:
-      group: gh-pages
-      cancel-in-progress: false
-    permissions:
-      contents: write
-    steps:
-      - name: checkout repository
-        uses: actions/checkout@v5
-        with: 
-          fetch-depth: 0 # Required to push to the documentation branch
-
-      - 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
-          git fetch origin gh-pages:gh-pages
-  
-      - name: delete testing documentation
-        continue-on-error: true
-        env:
-          VERSION: ${{ format('pr-{0}', github.head_ref) || 'test' }}
-          GH_TOKEN: ${{ github.token }}
-        run: >
-          uv run mike delete 
-          --push --ignore-remote-status 
-          --config-file mkdocs.yml
-          --branch gh-pages
-          $VERSION
-
   document:
     name: Deploy documentation
     needs: [release]
     if: github.event.pull_request.merged
     uses: ./.github/workflows/docs.yaml
-    concurrency:
-      group: gh-pages
-      cancel-in-progress: false
     permissions:
       contents: write
     secrets: inherit
     with:
-      version: ${{ needs.release.outputs.next-tag }}
+      version: ${{ needs.release.outputs.next-tag || needs.release.outputs.last-tag }}
       alias: latest
       set-default: true
       ref: ${{ needs.release.outputs.next-tag }}

{mkdocstrings_github-0.4.0 → mkdocstrings_github-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-github
-Version: 0.4.0
+Version: 0.4.2
 Summary: A GitHub Action handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT
@@ -23,6 +23,7 @@ Classifier: Typing :: Typed
 Requires-Python: <3.15,>=3.10
 Requires-Dist: gitpython~=3.1.45
 Requires-Dist: mkdocstrings~=0.29
+Requires-Dist: packaging~=25.0
 Requires-Dist: typing-extensions>=4.0; python_version < '3.11'
 Description-Content-Type: text/markdown
 

{mkdocstrings_github-0.4.0 → mkdocstrings_github-0.4.2}/docs/usage/signatures.md

@@ -84,7 +84,6 @@
     - name: build step
       run: mkdocs build 
     ```
-    -  
 
 ??? preview
 

{mkdocstrings_github-0.4.0 → mkdocstrings_github-0.4.2}/mkdocs.yml

@@ -120,6 +120,7 @@ plugins:
     default_handler: github
     handlers:
       github:
+        repo: owner/repository
         options:
           show_toc_entry: false
           heading_level: 3

{mkdocstrings_github-0.4.0 → mkdocstrings_github-0.4.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocstrings-github"
-version = "0.4.0"
+version = "0.4.2"
 description = "A GitHub Action handler for mkdocstrings"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }
@@ -29,6 +29,7 @@ classifiers = [
 dependencies = [
     "gitpython~=3.1.45",
     "mkdocstrings~=0.29",
+    "packaging~=25.0",
     "typing-extensions>=4.0; python_version < '3.11'",
 ]
 

{mkdocstrings_github-0.4.0 → mkdocstrings_github-0.4.2}/src/mkdocstrings_handlers/github/handler.py

@@ -16,6 +16,7 @@ from mkdocstrings import (
     HandlerOptions,
     get_logger,
 )
+from packaging.version import InvalidVersion, Version
 
 from mkdocstrings_handlers.github import rendering
 from mkdocstrings_handlers.github.config import GitHubConfig, GitHubOptions
@@ -72,6 +73,29 @@ class GitHubHandler(BaseHandler):
         self.major: str = ""
         self.semver: str = ""
 
+        # Determine owner and repo name
+        if not self.config.repo:
+            # Try each remote to find a valid GitHub owner/repo
+            owner = None
+            repo_name = None
+            for remote in self.repo.remotes:
+                for url in remote.urls:
+                    match = re.search(
+                        r"(?P<host>[\w\.-]+)[/:](?P<owner>[^/]+)/(?P<repo>[^/.]+?)(?:\.git)?$",
+                        url,
+                    )
+                    if match:
+                        owner = match.group("owner")
+                        repo_name = match.group("repo")
+                        break
+                if owner and repo_name:
+                    break
+            if not (owner and repo_name):
+                raise PluginError(
+                    f"Could not determine GitHub repository owner/name from config.repo='{self.config.repo}' or any git remote URL."
+                )
+            self.config.repo = f"{owner}/{repo_name}"
+
         # Only run GitHub releases code if required and not in testing
         not_testing = "pytest" not in sys.modules
         no_custom_tags = (
@@ -113,29 +137,43 @@ class GitHubHandler(BaseHandler):
             _logger.warning(f"Could not get git tags from repository: {e}")
             return
 
-        # Find matching tags
+        # Separate semver, major, and other tags
+        semver_tags = []
+        major_tags = []
+        other_tags = []
         for tag in tags:
-            if not self.semver and SEMVER_PATTERN.match(tag):
-                _logger.info(f"Using git tag '{tag}' for semver.")
-                self.semver = tag
-            if not self.major and MAJOR_PATTERN.match(tag):
-                _logger.info(f"Using git tag '{tag}' for major.")
-                self.major = tag
-            if self.semver and self.major:
-                break
-
-        if not self.semver or not self.major:
-            if not self.semver and not self.major:
-                messages = ("'vX.X.X' and 'vX'", "'semver and major'")
-            elif not self.semver:
-                messages = ("'vX.X.X'", "'semver'")
-            else:  # not self.major
-                messages = ("'vX'", "'major'")
-            _logger.warning(
-                f"Could not find suitable git tags in repository. "
-                f"Make sure there are tags matching {messages[0]}, "
-                f"if you wish to use option signature_version {messages[1]}.",
-            )
+            if SEMVER_PATTERN.match(tag):
+                semver_tags.append(tag)
+            elif MAJOR_PATTERN.match(tag):
+                major_tags.append(tag)
+            else:
+                other_tags.append(tag)
+
+        # Sort tags using packaging.version.Version
+        def version_key(tag):
+            try:
+                return Version(tag.lstrip("v"))
+            except InvalidVersion:
+                return Version("0.0.0")
+
+        semver_tags_sorted = sorted(semver_tags, key=version_key, reverse=True)
+        major_tags_sorted = sorted(major_tags, key=version_key, reverse=True)
+        other_tags_sorted = sorted(other_tags, reverse=True)
+
+        if semver_tags_sorted:
+            self.semver = semver_tags_sorted[0]
+            _logger.info(f"Using git tag '{self.semver}' for semver.")
+        else:
+            _logger.warning("No semver tags found in repository.")
+
+        if major_tags_sorted:
+            self.major = major_tags_sorted[0]
+            _logger.info(f"Using git tag '{self.major}' for major.")
+        else:
+            _logger.warning("No major tags found in repository.")
+
+        if other_tags_sorted:
+            _logger.debug(f"Other git tags found: {', '.join(other_tags_sorted)}")
 
     def get_options(self, local_options: Mapping[str, Any]) -> HandlerOptions:
         """Get combined default, global and local options.

{mkdocstrings_github-0.4.0 → mkdocstrings_github-0.4.2}/uv.lock

@@ -716,11 +716,12 @@ wheels = [
 
 [[package]]
 name = "mkdocstrings-github"
-version = "0.4.0"
+version = "0.4.2"
 source = { editable = "." }
 dependencies = [
     { name = "gitpython" },
     { name = "mkdocstrings" },
+    { name = "packaging" },
     { name = "typing-extensions", marker = "python_full_version < '3.11'" },
 ]
 
@@ -750,6 +751,7 @@ docs = [
 requires-dist = [
     { name = "gitpython", specifier = "~=3.1.45" },
     { name = "mkdocstrings", specifier = "~=0.29" },
+    { name = "packaging", specifier = "~=25.0" },
     { name = "typing-extensions", marker = "python_full_version < '3.11'", specifier = ">=4.0" },
 ]
 

{mkdocstrings_github-0.4.0 → mkdocstrings_github-0.4.2}/test/snapshots/__init__.py

@@ -4,6 +4,13 @@ register_format_alias(".html", ".txt")
 
 workflow_show = snapshot(
     {
+        (
+            ("show_signature", True),
+            ("signature_version", "major"),
+            ("signature_version_string", ""),
+            ("signature_show_secrets", True),
+            ("signature_show_permissions", True),
+        ): external("hash:d2e25cb02f37*.html"),
         (("show_description", True), ("description", ""), ("show_source", True)): external(
             "hash:78f74a133e98*.html"
         ),
@@ -36,13 +43,6 @@ workflow_show = snapshot(
             ("show_toc_entry", True),
             ("toc_label", ""),
         ): external("hash:1322d6390dbc*.html"),
-        (
-            ("show_signature", True),
-            ("signature_version", "major"),
-            ("signature_version_string", ""),
-            ("signature_show_secrets", True),
-            ("signature_show_permissions", True),
-        ): external("hash:d2e25cb02f37*.html"),
         (
             ("show_signature", True),
             ("signature_version", "semver"),
@@ -176,6 +176,76 @@ action_show = snapshot(
         (("show_description", False), ("description", ""), ("show_source", False)): external(
             "hash:5a2f11e94bc0*.html"
         ),
+        (
+            ("show_heading", True),
+            ("heading", ""),
+            ("heading_level", 1),
+            ("show_branding", False),
+            ("branding_icon", ""),
+            ("branding_icon_color", ""),
+            ("show_toc_entry", False),
+            ("toc_label", ""),
+        ): external("hash:2eb63f18b2d0*.html"),
+        (
+            ("show_heading", True),
+            ("heading", "Custom heading"),
+            ("heading_level", 2),
+            ("show_branding", False),
+            ("branding_icon", ""),
+            ("branding_icon_color", ""),
+            ("show_toc_entry", False),
+            ("toc_label", "Custom toc label"),
+        ): external("hash:856a4ff20ee1*.html"),
+        (
+            ("show_heading", True),
+            ("heading", ""),
+            ("heading_level", 1),
+            ("show_branding", True),
+            ("branding_icon", ""),
+            ("branding_icon_color", ""),
+            ("show_toc_entry", False),
+            ("toc_label", ""),
+        ): external("hash:0a37a4286738*.html"),
+        (
+            ("show_heading", True),
+            ("heading", ""),
+            ("heading_level", 2),
+            ("show_branding", True),
+            ("branding_icon", "green"),
+            ("branding_icon_color", ""),
+            ("show_toc_entry", False),
+            ("toc_label", ""),
+        ): external("hash:3cb099624d88*.html"),
+        (
+            ("show_heading", True),
+            ("heading", ""),
+            ("heading_level", 3),
+            ("show_branding", True),
+            ("branding_icon", ""),
+            ("branding_icon_color", "github"),
+            ("show_toc_entry", False),
+            ("toc_label", ""),
+        ): external("hash:c50b7f91aaff*.html"),
+        (
+            ("show_heading", False),
+            ("heading", ""),
+            ("heading_level", 1),
+            ("show_branding", False),
+            ("branding_icon", ""),
+            ("branding_icon_color", ""),
+            ("show_toc_entry", True),
+            ("toc_label", ""),
+        ): external("hash:c8c895c400f0*.html"),
+        (
+            ("show_heading", False),
+            ("heading", ""),
+            ("heading_level", 1),
+            ("show_branding", False),
+            ("branding_icon", ""),
+            ("branding_icon_color", ""),
+            ("show_toc_entry", False),
+            ("toc_label", ""),
+        ): external("hash:36d559797138*.html"),
         (
             ("show_signature", True),
             ("signature_version", "major"),
@@ -280,75 +350,5 @@ action_show = snapshot(
             ("parameters_order", "source"),
             ("parameters_section_style", "list"),
         ): external("hash:cdad9a8909ec*.html"),
-        (
-            ("show_heading", True),
-            ("heading", ""),
-            ("heading_level", 1),
-            ("show_branding", False),
-            ("branding_icon", ""),
-            ("branding_icon_color", ""),
-            ("show_toc_entry", False),
-            ("toc_label", ""),
-        ): external("hash:2eb63f18b2d0*.html"),
-        (
-            ("show_heading", True),
-            ("heading", "Custom heading"),
-            ("heading_level", 2),
-            ("show_branding", False),
-            ("branding_icon", ""),
-            ("branding_icon_color", ""),
-            ("show_toc_entry", False),
-            ("toc_label", "Custom toc label"),
-        ): external("hash:856a4ff20ee1*.html"),
-        (
-            ("show_heading", True),
-            ("heading", ""),
-            ("heading_level", 1),
-            ("show_branding", True),
-            ("branding_icon", ""),
-            ("branding_icon_color", ""),
-            ("show_toc_entry", False),
-            ("toc_label", ""),
-        ): external("hash:0a37a4286738*.html"),
-        (
-            ("show_heading", True),
-            ("heading", ""),
-            ("heading_level", 2),
-            ("show_branding", True),
-            ("branding_icon", "green"),
-            ("branding_icon_color", ""),
-            ("show_toc_entry", False),
-            ("toc_label", ""),
-        ): external("hash:3cb099624d88*.html"),
-        (
-            ("show_heading", True),
-            ("heading", ""),
-            ("heading_level", 3),
-            ("show_branding", True),
-            ("branding_icon", ""),
-            ("branding_icon_color", "github"),
-            ("show_toc_entry", False),
-            ("toc_label", ""),
-        ): external("hash:c50b7f91aaff*.html"),
-        (
-            ("show_heading", False),
-            ("heading", ""),
-            ("heading_level", 1),
-            ("show_branding", False),
-            ("branding_icon", ""),
-            ("branding_icon_color", ""),
-            ("show_toc_entry", True),
-            ("toc_label", ""),
-        ): external("hash:c8c895c400f0*.html"),
-        (
-            ("show_heading", False),
-            ("heading", ""),
-            ("heading_level", 1),
-            ("show_branding", False),
-            ("branding_icon", ""),
-            ("branding_icon_color", ""),
-            ("show_toc_entry", False),
-            ("toc_label", ""),
-        ): external("hash:36d559797138*.html"),
     }
 )