mkdocstrings-github 0.2.2__py3-none-any.whl → 0.2.4__py3-none-any.whl

{mkdocstrings_github-0.2.2.dist-info → mkdocstrings_github-0.2.4.dist-info}/METADATA

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

{mkdocstrings_github-0.2.2.dist-info → mkdocstrings_github-0.2.4.dist-info}/RECORD

@@ -1,6 +1,6 @@
 mkdocstrings_handlers/github/__init__.py,sha256=0WdFUIq4Xu2ZFtlZNIYCQSoqcx3Ot9Wv41_X_dwbFww,248
-mkdocstrings_handlers/github/config.py,sha256=pSjA6gU-kC_mXQqNIIGOYEOhtX5VzZDT0H1hRFlGaj8,6089
-mkdocstrings_handlers/github/handler.py,sha256=uZ_B6ZNnVjJnloJOcYINROHBPYSaBcBKWSFlo4nuARI,9721
+mkdocstrings_handlers/github/config.py,sha256=b2sZiRehEtg27ZUbPmUld8SlsGUYE5f1qLFuq1cWjlU,6220
+mkdocstrings_handlers/github/handler.py,sha256=MD0XmG2vsvsslUpFl1qB6bpiW28jRUNjG2lGkrFNIxs,11251
 mkdocstrings_handlers/github/objects.py,sha256=qkRGcwwYCHsrc9JEmujnvIt00_B1y5cR0vGS5NRkuSg,7028
 mkdocstrings_handlers/github/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mkdocstrings_handlers/github/rendering.py,sha256=8h5Zn62b3od9Dj3MNvMtAGg_ZyyLfJKv2Z2qGdFaKG8,2329
@@ -11,7 +11,7 @@ mkdocstrings_handlers/github/templates/material/outputs.html.jinja,sha256=ePu1v8
 mkdocstrings_handlers/github/templates/material/secrets.html.jinja,sha256=92ynVoZinsLEp7_sFS3mL2E2ngOXPPAtXzGAuGFvhmY,2782
 mkdocstrings_handlers/github/templates/material/style.css,sha256=R2hh1RfHwJ6XNT4YQl_txNkNXcPBZJMCBZn5kQEMQ6M,962
 mkdocstrings_handlers/github/templates/material/workflow.html.jinja,sha256=E1VUi2w7_NDkpS9VNrWRV52hhyhQvnKUrjPbV_j0Qcg,3312
-mkdocstrings_github-0.2.2.dist-info/METADATA,sha256=A9BFF_0Cb7Zb2wz_ugJ2jUhtu1660D0BB4vZ-YFL3YE,3125
-mkdocstrings_github-0.2.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-mkdocstrings_github-0.2.2.dist-info/licenses/LICENSE,sha256=5enZtJ4zSp0Ps3jTqFQ4kadcx62BhgTaDNPrXWb3g3E,1069
-mkdocstrings_github-0.2.2.dist-info/RECORD,,
+mkdocstrings_github-0.2.4.dist-info/METADATA,sha256=1pzvDfDEgY43O-Itmcg-1OEae8vJNabUf5esgLT28II,3125
+mkdocstrings_github-0.2.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+mkdocstrings_github-0.2.4.dist-info/licenses/LICENSE,sha256=5enZtJ4zSp0Ps3jTqFQ4kadcx62BhgTaDNPrXWb3g3E,1069
+mkdocstrings_github-0.2.4.dist-info/RECORD,,

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_handlers/github/handler.py

@@ -80,22 +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://github.com")
-            base_url = f"{GH_HOST}/api/v3"
-
-            if "GH_TOKEN" in os.environ or "GITHUB_TOKEN" in os.environ:
-                gh = Github(
-                    base_url=base_url,
-                    auth=Auth.Token(os.environ.get("GH_TOKEN", os.environ.get("GITHUB_TOKEN", ""))),
+            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=base_url, auth=Auth.Token(os.environ[token_key]))
+            elif (token_key := "GITHUB_TOKEN") in os.environ:
+                gh = Github(base_url=base_url, auth=Auth.Token(os.environ[token_key]))
             else:
                 try:
                     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(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:
@@ -104,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()
+                        gh = Github(base_url=base_url)
 
             owner, repo_name = self.config.repo.split("/", 1)
             gh_repo = gh.get_repo(f"{owner}/{repo_name}")