mkdocstrings-github 0.2.0__tar.gz → 0.2.2__tar.gz

{mkdocstrings_github-0.2.0 → mkdocstrings_github-0.2.2}/.github/workflows/docs.yaml

@@ -61,7 +61,7 @@ jobs:
         shell: bash
         env:
           PUSH_DEPLOY: ${{ fromJson(inputs.push) && '--push' || '' }}
-          GITHUB_TOKEN: ${{ github.token }}
+          GH_TOKEN: ${{ github.token }}
           VERSION: ${{ inputs.version }}
         run: |
           if [[ $VERSION =~ ^v([0-9]+)\.([0-9]+)\.([0-9]+)$ ]]; then

{mkdocstrings_github-0.2.0 → mkdocstrings_github-0.2.2}/.github/workflows/release.yaml

@@ -109,7 +109,7 @@ jobs:
       env:
         GH_TOKEN: ${{ steps.app-token.outputs.token }}
       run: |
-        uv run semantic-release -v version --commit --tag --push --changelog --vcs-release --skip-build
+        uv run semantic-release -v version --commit --tag --push --changelog --vcs-release
 
   deploy: 
     name: Deploy package distributions

{mkdocstrings_github-0.2.0 → mkdocstrings_github-0.2.2}/PKG-INFO

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

{mkdocstrings_github-0.2.0 → mkdocstrings_github-0.2.2}/docs/usage/general.md

@@ -1,6 +1,6 @@
 # General options
 
-??? info "Example yaml files"
+??? info "Example action/workflow"
 
     ??? preview "compsite action `action.yaml`"
 

{mkdocstrings_github-0.2.0 → mkdocstrings_github-0.2.2}/docs/usage/headings.md

@@ -1,6 +1,6 @@
 # Headings options
 
-??? info "Example yaml files"
+??? info "Example action/workflow"
 
     ??? preview "compsite action `action.yaml`"
 

{mkdocstrings_github-0.2.0 → mkdocstrings_github-0.2.2}/docs/usage/index.md

@@ -1,6 +1,6 @@
 # Usage 
 
-!!! info "Example yaml files"
+!!! info "Example action/workflow"
 
     Throughout the next pages, we will use a composite action `action.yaml` and a reusable workflow `.github/workflows/example_workflow.yml` as examples.
 
@@ -18,7 +18,7 @@
 
 ## Installation
 
-This package is extension package to [*mkdocstrings*](https://mkdocstrings.github.io/), which is a framework for auto-documentation for various languanges, which can plugin into the framework by providing *handlers*. The *mkdocstrings-github* package provides a GitHub hanlder.
+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.
 
 --8<-- "README.md:install"
 
@@ -80,6 +80,10 @@ For reusable workflows, which are workflows that include the [`workflow_call`](h
     ::: .github/workflows/myworkflow.yml
     ```
 
+## Linking
+
+For every documented action or workflow, HTML tags are inserted on the page to allow linking with the action/workflow path as the id. Additionally, linking to action and workflow parameters, and cross-linking to other parameters, is possible with the [`parameters_anchors`][mkdocstrings_handlers.github.config.GitHubOptions.parameters_anchors] option.
+
 ## Configuration
 
 When installed, the Github handler can be configured in `mkdocs.yml`

{mkdocstrings_github-0.2.0 → mkdocstrings_github-0.2.2}/docs/usage/parameters.md

@@ -1,6 +1,6 @@
 # Parameters options
 
-??? info "Example yaml files"
+??? info "Example action/workflow"
 
     ??? preview "compsite action `action.yaml`"
 
@@ -14,12 +14,6 @@
         --8<-- ".github/workflows/example_workflow.yml"
         ```
 
-!!! tip "Cross linking parameters"
-
-    It is possible to cross-link parameters within the yaml descriptions by a markdown link in the format `[text](#<domain>.<name>)`. 
-
-    E.g. the input `my_input` can be linked with `[text](#inputs.my_input)` the secret `MY_SECRET` is linked with `[text](#secrets.MY_SECRET)`.
-
 ::: mkdocstrings_handlers.github.config.GitHubOptions.show_inputs
     handler: python
 
@@ -142,6 +136,13 @@
 ::: mkdocstrings_handlers.github.config.GitHubOptions.parameters_anchors
     handler: python
 
+
+!!! tip "Cross linking parameters"
+
+    It is possible to cross-link parameters within the yaml descriptions by a markdown link in the format `[text](#<domain>.<name>)`. 
+
+    E.g. the input `my_input` can be linked with `[text](#inputs.my_input)` the secret `MY_SECRET` is linked with `[text](#secrets.MY_SECRET)`.
+
 ??? preview
 
     === "`parameters_anchors: true`"

{mkdocstrings_github-0.2.0 → mkdocstrings_github-0.2.2}/docs/usage/signatures.md

@@ -1,6 +1,6 @@
 # Signatures options
 
-??? info "Example yaml files"
+??? info "Example action/workflow"
 
     ??? preview "compsite action `action.yaml`"
 
@@ -71,20 +71,22 @@
 
 !!! info
 
-    To automatically grab the latest `major` or `semver` release, *mkdocstrings-github* needs to access GitHub to get the releases. Authentication is set by either the environment variable `GITHUB_TOKEN`, or via [`.netrc`](https://pygithub.readthedocs.io/en/stable/examples/Authentication.html#netrc-authentication). If both aren't available, a final attempt is made via the GitHub [`gh auth token`](https://cli.github.com/manual/gh_auth_token). 
+    To automatically grab the latest `major` or `semver` release, *mkdocstrings-github* needs to access GitHub to get the releases. Authentication is set by either the environment variable `GH_TOKEN`, or via [`.netrc`](https://pygithub.readthedocs.io/en/stable/examples/Authentication.html#netrc-authentication). If both aren't available, a final attempt is made via the GitHub CLI with [`gh auth token`](https://cli.github.com/manual/gh_auth_token). 
 
-    When building your documentation in GitHub Actions, make sure that the build step has the environment variable `GITHUB_TOKEN` set.
+    When building your documentation in GitHub Actions, make sure that the build step has the environment variable `GH_TOKEN` set.
 
     ```yaml title="Example build step"
     ...
     - name: build step
       env:
-        GITHUB_TOKEN: ${{ github.token }}
+        GH_TOKEN: ${{ github.token }}
       run: | 
         mkdocs build 
     ```
 
+!!! info 
 
+    For GitHub Enterprise instances, you need to additionally set the `GH_HOST` environment variable to your GitHub hostname. 
 
 ??? preview
 

{mkdocstrings_github-0.2.0 → mkdocstrings_github-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocstrings-github"
-version = "0.2.0"
+version = "0.2.2"
 description = "A GitHub Action handler for mkdocstrings"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }
@@ -32,9 +32,6 @@ dependencies = [
     "typing-extensions>=4.0; python_version < '3.11'",
 ]
 
-[tool.uv.sources]
-pygments = { git = "https://github.com/watermarkhu/pygments", branch = "matlab" }
-
 [dependency-groups]
 dev = [
     "ty~=0.0.1a19",
@@ -102,8 +99,10 @@ allow-direct-references = true
 packages = ["src/mkdocstrings_handlers"]
 
 [tool.semantic_release]
+build_command = "uv sync"
 commit_message = "{version}\n\nAutomatically generated by python-semantic-release"
 commit_parser = "conventional"
+commit_author = "github-actions <actions@github.com>"
 logging_use_named_masks = false
 major_on_zero = true
 allow_zero_version = true

{mkdocstrings_github-0.2.0 → mkdocstrings_github-0.2.2}/src/mkdocstrings_handlers/github/handler.py

@@ -80,11 +80,17 @@ class GitHubHandler(BaseHandler):
         ) and "pytest" not in sys.modules:
             # Use PyGitHub to find last GitHub releases with tags matching vX.X.X and vX
 
-            if "GITHUB_TOKEN" in os.environ:
-                gh = Github(auth=Auth.Token(os.environ["GITHUB_TOKEN"]))
+            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", ""))),
+                )
             else:
                 try:
-                    gh = Github(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()
@@ -94,8 +100,9 @@ class GitHubHandler(BaseHandler):
                             raise RuntimeError("No token from gh auth token")
                     except Exception:
                         _logger.warning(
-                            "Could not authenticate with GitHub to get releases."
-                            " Consider setting .netrc, environment variable GITHUB_TOKEN, or using GitHub CLI (`gh auth login`) to get GitHub releases.",
+                            "Could not authenticate with GitHub to get releases. "
+                            "Consider setting .netrc, environment variable GH_TOKEN, "
+                            "or using GitHub CLI (`gh auth login`) to get GitHub releases.",
                         )
                         gh = Github()
 

{mkdocstrings_github-0.2.0 → mkdocstrings_github-0.2.2}/uv.lock

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