mkdocstrings-github 0.2.3__tar.gz → 0.2.4__tar.gz

{mkdocstrings_github-0.2.3 → mkdocstrings_github-0.2.4}/.github/workflows/qualify.yaml

@@ -21,7 +21,6 @@ concurrency:
 
 jobs:
   docs:
-    if: contains(github.event.pull_request.labels.*.name, 'documentation')
     name: Test deploy documentation
     uses: ./.github/workflows/docs.yaml
     concurrency:
@@ -32,9 +31,9 @@ jobs:
     secrets: inherit
     with:
       version: ${{ format('pr-{0}', github.head_ref) || 'test' }}
-      alias: ""
+      alias: "test"
       set-default: false
-      push: true
+      push: ${{ contains(github.event.pull_request.labels.*.name, 'documentation') }}
 
   setup:
     runs-on: ubuntu-latest

{mkdocstrings_github-0.2.3 → mkdocstrings_github-0.2.4}/.github/workflows/release.yaml

@@ -180,6 +180,7 @@ jobs:
         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 

{mkdocstrings_github-0.2.3 → mkdocstrings_github-0.2.4}/PKG-INFO

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

mkdocstrings_github-0.2.4/docs/changelog.md

@@ -0,0 +1 @@
+# changelog

{mkdocstrings_github-0.2.3 → mkdocstrings_github-0.2.4}/docs/usage/index.md

@@ -100,6 +100,9 @@ plugins:
 
 Some options are **global only, and go directly under the handler's name.
 
+::: mkdocstrings_handlers.github.config.GitHubConfig.hostname
+    handler: python
+
 ::: mkdocstrings_handlers.github.config.GitHubConfig.repo
     handler: python
 
@@ -121,7 +124,6 @@ plugins:
 
 ...and locally, overriding the global configuration:
 
-
 ```markdown title="docs/some_page.md"
 ::: .github/workflows/reusable-workflow.yml
     handler: github
@@ -136,7 +138,6 @@ These options affect how the documentation is collected from sources and rendere
 - [Signature options](./signatures.md): options related to the shown call signature.
 - [Parameters options](./parameters.md): options related to the input (and output) parameters of the action or workflow.
 
-
 ::: mkdocstrings_handlers.github.config.GitHubOptions
     handler: python
     options:

{mkdocstrings_github-0.2.3 → mkdocstrings_github-0.2.4}/docs/usage/signatures.md

@@ -14,7 +14,6 @@
         --8<-- ".github/workflows/example_workflow.yml"
         ```
 
-
 ::: mkdocstrings_handlers.github.config.GitHubOptions.show_signature
     handler: python
 
@@ -84,9 +83,9 @@
         mkdocs build 
     ```
 
-!!! info 
+!!! info
 
-    For GitHub Enterprise instances, you need to additionally set the `GH_HOST` environment variable to your GitHub hostname. 
+    For GitHub Enterprise instances, you can set either the [`hostname`][mkdocstrings_handlers.github.config.GitHubConfig.hostname] configuration option or the `GH_HOST` environment variable to your GitHub hostname.
 
 ??? preview
 

{mkdocstrings_github-0.2.3 → mkdocstrings_github-0.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocstrings-github"
-version = "0.2.3"
+version = "0.2.4"
 description = "A GitHub Action handler for mkdocstrings"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }
@@ -120,6 +120,9 @@ prerelease = false
 [tool.semantic_release.commit_parser_options]
 patch_tags = ["fix", "perf", "chore"]
 
+[tool.semantic_release.changelog]
+changelog_file = "docs/changelog.md"
+
 [tool.pytest.ini_options]
 pythonpath = [
     "test"

{mkdocstrings_github-0.2.3 → mkdocstrings_github-0.2.4}/src/mkdocstrings_handlers/github/config.py

@@ -171,6 +171,11 @@ class GitHubOptions(BaseModel):
 class GitHubConfig(BaseModel):
     """Configuration options for the GitHub handler."""
 
+    hostname: str = Field(
+        default="github.com",
+        description="The hostname of the GitHub instance to use.",
+    )
+
     repo: str = Field(
         default="",
         description="""The GitHub repository in the format *owner/repo*.

{mkdocstrings_github-0.2.3 → mkdocstrings_github-0.2.4}/src/mkdocstrings_handlers/github/handler.py

@@ -80,20 +80,47 @@ class GitHubHandler(BaseHandler):
         ) and "pytest" not in sys.modules:
             # Use PyGitHub to find last GitHub releases with tags matching vX.X.X and vX
 
-            GH_HOST = os.environ.get("GH_HOST", "https://api.github.com")
+            gh_host = os.environ.get("GH_HOST", config.hostname)
+            # Construct base_url for GitHub API.
+            #
+            # Expected formats for GH_HOST/config.hostname:
+            #   - Full API URL (e.g., 'https://github.company.com/api/v3') [RECOMMENDED for GitHub Enterprise]
+            #   - Hostname (e.g., 'github.com' or 'github.company.com')
+            #   - API subdomain (e.g., 'api.github.com')
+            #
+            # If a full URL is provided, it is used as-is.
+            # If the value contains '/api/', it is assumed to be a full API endpoint and used as-is (with protocol if missing).
+            # Otherwise, the code falls back to public GitHub conventions.
+            if gh_host.startswith(("http://", "https://")):
+                base_url = gh_host
+            elif "/api/" in gh_host:
+                # If protocol is missing, default to https
+                base_url = f"https://{gh_host}"
+            elif gh_host.startswith("api."):
+                base_url = f"https://{gh_host}"
+            else:
+                # Warn user about possible misconfiguration for GitHub Enterprise
+                _logger.warning(
+                    "The GH_HOST/config.hostname value '%s' does not appear to be a full API endpoint. "
+                    "For GitHub Enterprise, you may need to specify the full API URL (e.g., 'https://github.company.com/api/v3').",
+                    gh_host,
+                )
+                base_url = f"https://api.{gh_host}"
 
             if (token_key := "GH_TOKEN") in os.environ:
-                gh = Github(base_url=GH_HOST, auth=Auth.Token(os.environ[token_key]))
+                gh = Github(base_url=base_url, auth=Auth.Token(os.environ[token_key]))
             elif (token_key := "GITHUB_TOKEN") in os.environ:
-                gh = Github(base_url=GH_HOST, auth=Auth.Token(os.environ[token_key]))
+                gh = Github(base_url=base_url, auth=Auth.Token(os.environ[token_key]))
             else:
                 try:
-                    gh = Github(base_url=GH_HOST, auth=Auth.NetrcAuth())
+                    gh = Github(base_url=base_url, auth=Auth.NetrcAuth())
                 except RuntimeError:
                     try:
-                        token = subprocess.check_output(["gh", "auth", "token"], text=True).strip()
+                        token = subprocess.check_output(
+                            ["gh", "auth", "token"], text=True, env=os.environ
+                        ).strip()
                         if token:
-                            gh = Github(base_url=GH_HOST, auth=Auth.Token(token))
+                            gh = Github(base_url=base_url, auth=Auth.Token(token))
                         else:
                             raise RuntimeError("No token from gh auth token")
                     except Exception:
@@ -102,7 +129,7 @@ class GitHubHandler(BaseHandler):
                             "Consider setting .netrc, environment variable GH_TOKEN, "
                             "or using GitHub CLI (`gh auth login`) to get GitHub releases.",
                         )
-                        gh = Github(base_url=GH_HOST)
+                        gh = Github(base_url=base_url)
 
             owner, repo_name = self.config.repo.split("/", 1)
             gh_repo = gh.get_repo(f"{owner}/{repo_name}")

{mkdocstrings_github-0.2.3 → mkdocstrings_github-0.2.4}/uv.lock

@@ -788,7 +788,7 @@ wheels = [
 
 [[package]]
 name = "mkdocstrings-github"
-version = "0.2.3"
+version = "0.2.4"
 source = { editable = "." }
 dependencies = [
     { name = "gitpython" },

mkdocstrings_github-0.2.3/CHANGELOG.md

@@ -1 +0,0 @@
-# CHANGELOG

mkdocstrings_github-0.2.3/docs/changelog.md

@@ -1 +0,0 @@
---8<-- "CHANGELOG.md"