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

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

@@ -93,7 +93,7 @@ jobs:
     concurrency:
       group: gh-pages
       cancel-in-progress: false
-      
+
     steps:
       - name: checkout repository
         uses: actions/checkout@v4
@@ -113,6 +113,7 @@ jobs:
         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

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

@@ -1,6 +1,14 @@
 # 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

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

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

{mkdocstrings_matlab-0.8.1 → 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.1 → mkdocstrings_matlab-0.8.2}/pyproject.toml

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

{mkdocstrings_matlab-0.8.1 → 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: