mkdocstrings-matlab 0.8.0__tar.gz → 0.8.2__tar.gz

{mkdocstrings_matlab-0.8.0 → mkdocstrings_matlab-0.8.2}/.github/workflows/qualify.yaml

@@ -23,12 +23,15 @@ jobs:
     if: github.event.pull_request.draft == false
     name: Test deploy documentation
     uses: ./.github/workflows/docs.yaml
+    concurrency:
+      group: gh-pages
+      cancel-in-progress: false
     secrets: inherit
     with:
-      version: __test__
+      version: ${{ format('pr-{0}', github.head_ref) || 'test' }}
       alias: ""
       set-default: false
-      push: false
+      push: true
 
   check-semantic-version:
     name: Check semantic version

{mkdocstrings_matlab-0.8.0 → mkdocstrings_matlab-0.8.2}/.github/workflows/release.yaml

@@ -86,9 +86,49 @@ jobs:
         github_token: ${{ steps.app-token.outputs.token }}
         tag: ${{ steps.semantic-release.outputs.tag }}
 
+  delete-test-document:
+    name: Delete test documentation
+    needs: publish
+    runs-on: ubuntu-latest
+    concurrency:
+      group: gh-pages
+      cancel-in-progress: false
+
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v4
+        with: 
+          fetch-depth: 0 # Required to push to the documentation branch
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v5
+        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' }}
+        run: >
+          uv run mike delete 
+          --push --ignore-remote-status 
+          --config-file mkdocs.yml
+          --branch gh-pages
+          $VERSION
+
   mkdocs:
     name: Deploy documentation
-    needs: [publish]
+    needs: [publish, delete-test-document]
     uses: ./.github/workflows/docs.yaml
     secrets: inherit
     with:

{mkdocstrings_matlab-0.8.0 → mkdocstrings_matlab-0.8.2}/CHANGELOG.md

@@ -1,6 +1,23 @@
 # CHANGELOG
 
 
+## v0.8.2 (2025-01-14)
+
+### Bug Fixes
+
+- Allow mkdocs.yml in subdir ([#50](https://github.com/watermarkhu/mkdocstrings-matlab/pull/50),
+  [`8889349`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/88893497c7e12fdc0bb6c00798d7ed3357a881f9))
+
+
+## v0.8.1 (2025-01-14)
+
+### Bug Fixes
+
+- Names of folder and namespace entities
+  ([#49](https://github.com/watermarkhu/mkdocstrings-matlab/pull/49),
+  [`248d389`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/248d3893b9fad1b1e9818c7b48959ca01c6f9cdf))
+
+
 ## v0.8.0 (2025-01-13)
 
 ### Features

{mkdocstrings_matlab-0.8.0 → mkdocstrings_matlab-0.8.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-matlab
-Version: 0.8.0
+Version: 0.8.2
 Summary: A MATLAB handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT

{mkdocstrings_matlab-0.8.0 → mkdocstrings_matlab-0.8.2}/docs/usage/configuration/headings.md

@@ -530,7 +530,6 @@ See also [`show_symbol_type_toc`][show_symbol_type_toc].
 
 ```yaml title="in mkdocs.yml (global configuration)"
 plugins:
-- mkdocs-material-matlab # (1)
 - mkdocstrings:
     handlers:
       matlab:
@@ -538,8 +537,6 @@ plugins:
           show_symbol_type_heading: true
 ```
 
-1. :warning: When using material theme, make sure to also enable the plugin `mkdocs-material-matlab` such that the right heading types are displayed. Otherwise, <code class="doc-symbol doc-symbol-attribute"></code> will be shown as `attr` and <code class="doc-symbol doc-symbol-module"></code> will be shown as `mod`, as the mkdocstrings-matlab plugin is reusing assets from mkdocstrings-python. 
-
 ```md title="or in docs/some_page.md (local configuration)"
 ::: matlab_callable
     options:
@@ -604,7 +601,6 @@ See also [`show_symbol_type_heading`][show_symbol_type_heading].
 
 ```yaml title="in mkdocs.yml (global configuration)"
 plugins:
-- mkdocs-material-matlab # (1)
 - mkdocstrings:
     handlers:
       matlab:
@@ -612,9 +608,6 @@ plugins:
           show_symbol_type_toc: true
 ```
 
-1. :warning: When using material theme, make sure to also enable the plugin `mkdocs-material-matlab` such that the right heading types are displayed. 
-
-
 ```md title="or in docs/some_page.md (local configuration)"
 ::: matlab_callable
     options:

{mkdocstrings_matlab-0.8.0 → mkdocstrings_matlab-0.8.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocstrings-matlab"
-version = "0.8.0"
+version = "0.8.2"
 description = "A MATLAB handler for mkdocstrings"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }

{mkdocstrings_matlab-0.8.0 → mkdocstrings_matlab-0.8.2}/scripts/copy_and_update_python_templates.py

@@ -40,12 +40,17 @@ def copy_template(
 copy_template(
     "_base/module.html.jinja",
     "folder.html.jinja",
-    {"doc-symbol-module": "doc-symbol-folder"},
+    {
+        "doc-symbol-module": "doc-symbol-folder",
+    },
 )
 copy_template(
     "_base/module.html.jinja",
     "namespace.html.jinja",
-    {"doc-symbol-module": "doc-symbol-namespace"},
+    {
+        "doc-symbol-module": "doc-symbol-namespace",
+        "{% set module_name = module.path if show_full_path else module.name %}": '{% set module_name = module.path + ".*" if show_full_path else module.name + ".*" %}',
+    },
 )
 
 # Copy the property template
@@ -115,7 +120,7 @@ copy_template(
         "Attributes": "Properties",
         "-modules": "-namespaces",
         "Modules": "Modules",
-        "{% if config.show_submodules %}": "{% if config.show_submodules or obj.is_folder %}",
-        "{% elif child.is_module and config.show_submodules %}": "{% elif (child.is_namespace and config.show_submodules) or obj.is_folder %}",
+        "{% if config.show_submodules %}": "{% if config.show_subnamespaces or obj.is_folder %}",
+        "{% elif child.is_module and config.show_submodules %}": "{% elif (child.is_namespace and config.show_subnamespaces) or obj.is_folder %}",
     },
 )

{mkdocstrings_matlab-0.8.0 → mkdocstrings_matlab-0.8.2}/src/mkdocstrings_handlers/matlab/collect.py

@@ -152,7 +152,7 @@ class PathCollection(ModulesCollection):
         self._mapping: dict[str, deque[Path]] = defaultdict(deque)
         self._models: dict[Path, LazyModel] = {}
         self._members: dict[Path, list[tuple[str, Path]]] = defaultdict(list)
-        self._folders: dict[str, LazyModel] = {}
+        self._folders: dict[Path, LazyModel] = {}
         self._config_path = config_path
 
         self.config = config
@@ -198,12 +198,12 @@ class PathCollection(ModulesCollection):
         elif self._config_path is not None and "/" in identifier:
             absolute_path = (self._config_path / Path(identifier)).resolve()
             if absolute_path.exists():
-                path = absolute_path.relative_to(self._config_path)
-                if path.suffix:
-                    path, member = path.parent, path.stem
+ 
+                if absolute_path.suffix:
+                    path, member = absolute_path.parent, absolute_path.stem
                 else:
-                    member = None
-                lazymodel = self._folders.get(str(path), None)
+                    path, member = absolute_path, None
+                lazymodel = self._folders.get(path, None)
 
                 if lazymodel is not None:
                     model = lazymodel.model()
@@ -548,9 +548,8 @@ class PathCollection(ModulesCollection):
                 "@",
             ]:
                 if member.parent.is_relative_to(self._config_path):
-                    relative_path = member.parent.relative_to(self._config_path)
                     if member.parent not in self._folders:
-                        self._folders[str(relative_path)] = LazyModel(
+                        self._folders[member.parent] = LazyModel(
                             member.parent, self
                         )
                 else:
@@ -771,7 +770,7 @@ class LazyModel:
 
     def _collect_folder(self, path: Path) -> Folder:
         name = path.stem
-        model = Folder(name, filepath=path, path_collection=self._path_collection)
+        model = Folder("/" + name, filepath=path, path_collection=self._path_collection)
         return self._collect_directory(path, model)
 
     def _collect_readme_md(self, path, parent: PathMixin) -> Docstring | None:

{mkdocstrings_matlab-0.8.0 → mkdocstrings_matlab-0.8.2}/src/mkdocstrings_handlers/matlab/models.py

@@ -193,8 +193,8 @@ class PathMixin(Object):
     """
 
     def __init__(self, *args: Any, filepath: Path | None = None, **kwargs: Any) -> None:
-        self._filepath: Path | None = filepath
         super().__init__(*args, **kwargs)
+        self._filepath: Path | None = filepath
 
     @property
     def filepath(self) -> Path | None:
@@ -212,9 +212,9 @@ class MatlabMixin(Object):
         docstring: Docstring | None = None,
         **kwargs: Any,
     ):
+        super().__init__(*args, **kwargs)
         self._parent: "Class | Classfolder | Namespace | _ParentGrabber | None" = parent
         self._docstring: Docstring | None = docstring
-        super().__init__(*args, **kwargs)
 
     @property
     def parent(self) -> Object | None:
@@ -570,7 +570,7 @@ class Folder(MatlabMixin, PathMixin, Module, MatlabObject):
         self.extra["mkdocstrings"] = {"template": "folder.html.jinja"}
 
     def __repr__(self) -> str:
-        return f"Folder({self.filepath!r})"
+        return f"Folder({self.path!r})"
 
     @property
     def namespaces(self) -> dict[str, "Namespace"]:

{mkdocstrings_matlab-0.8.0 → mkdocstrings_matlab-0.8.2}/src/mkdocstrings_handlers/matlab/templates/material/children.html.jinja

@@ -99,7 +99,7 @@ Context:
           {% endif %}
         {% endwith %}
 
-        {% if config.show_submodules or obj.is_folder %}
+        {% if config.show_subnamespaces or obj.is_folder %}
           {% with modules = obj.modules|filter_objects(
               filters=config.filters,
               members_list=members_list,
@@ -153,7 +153,7 @@ Context:
                 {% include function|get_template with context %}
               {% endwith %}
 
-            {% elif (child.is_namespace and config.show_submodules) or obj.is_folder %}
+            {% elif (child.is_namespace and config.show_subnamespaces) or obj.is_folder %}
               {% with module = child %}
                 {% include module|get_template with context %}
               {% endwith %}

{mkdocstrings_matlab-0.8.0 → mkdocstrings_matlab-0.8.2}/src/mkdocstrings_handlers/matlab/templates/material/namespace.html.jinja

@@ -30,7 +30,7 @@ Context:
       {% set show_full_path = config.show_object_full_path %}
     {% endif %}
 
-    {% set module_name = module.path if show_full_path else module.name %}
+    {% set module_name = module.path + ".*" if show_full_path else module.name + ".*" %}
 
     {% if not root or config.show_root_heading %}
       {% filter heading(