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

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

@@ -10,6 +10,7 @@ on:
       - synchronize
       - labeled
       - unlabeled
+      - edited
     branches:
       - main
 
@@ -38,11 +39,16 @@ jobs:
       uses: actions/checkout@v4
       with: 
         fetch-depth: 0
-        ref: ${{ github.sha }}
+        ref: main
 
-    - name: Force correct release branch on workflow sha
+    - name: Create fake commit with PR title
       run: |
-        git checkout -B ${{ github.ref_name }} ${{ github.sha }}
+        git config --global user.name '${{ steps.app-token.outputs.app-slug }}[bot]'
+        git config --global user.email '${{ steps.get-user-id.outputs.user-id }}+${{ steps.app-token.outputs.app-slug }}[bot]@users.noreply.github.com'
+        git switch -c temp-${{ github.run_id }}
+        touch temp.txt
+        git add temp.txt
+        git commit -m "${{ github.event.pull_request.title }}"
 
     - name: Install the latest version of uv
       uses: astral-sh/setup-uv@v5

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

@@ -55,7 +55,7 @@ jobs:
 
     - name: Update version and changelogs
       id: semantic-release
-      uses: python-semantic-release/python-semantic-release@v9.15.2
+      uses: python-semantic-release/python-semantic-release@v9.16.1
       with: 
         build: false
         changelog: true
@@ -81,7 +81,7 @@ jobs:
     - name: Publish package distributions to GitHub Releases
       if: steps.semantic-release.outputs.released == 'true'
       id: publish-dist
-      uses: python-semantic-release/publish-action@v9.15.2
+      uses: python-semantic-release/publish-action@v9.16.1
       with:
         github_token: ${{ steps.app-token.outputs.token }}
         tag: ${{ steps.semantic-release.outputs.tag }}

mkdocstrings_matlab-0.8.0/.github/workflows/update-templates.yaml

@@ -0,0 +1,48 @@
+name: Update template copies
+
+on:
+  pull_request:
+    types: 
+      - opened
+      - synchronize
+      - reopened
+      - edited
+
+permissions:
+  contents: write
+
+jobs:
+  update-templates:
+    runs-on: ubuntu-latest
+    if: contains(github.event.pull_request.title, 'mkdocstrings-python')
+
+    steps:
+    
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with: 
+          fetch-depth: 0
+          ref: ${{ github.sha }}
+
+      - name: Force correct release branch on workflow sha
+        run: |
+          git checkout -B ${{ github.ref_name }} ${{ github.sha }}
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "latest"
+
+      - name: Run script
+        run: |
+          uv sync 
+          uv run python scripts/copy_and_update_python_templates.py
+
+      - name: Commit changes
+        continue-on-error: true # Ignore if there are no changes
+        run: |
+          git config --global user.name 'github-actions[bot]'
+          git config --global user.email '41898282+github-actions[bot]@users.noreply.github.com'
+          git add .
+          git commit -m "Update templates"
+          git push origin ${{ github.ref_name }}

{mkdocstrings_matlab-0.6.0 → mkdocstrings_matlab-0.8.0}/.gitignore

@@ -122,6 +122,7 @@ celerybeat.pid
 *.sage.py
 
 # Environments
+uv.lock
 .env
 .venv
 env/

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

@@ -1,6 +1,46 @@
 # CHANGELOG
 
 
+## v0.8.0 (2025-01-13)
+
+### Features
+
+- Update dependencies ([#46](https://github.com/watermarkhu/mkdocstrings-matlab/pull/46),
+  [`03229a2`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/03229a2e7ef8ee46dc680b676a796ae38c6617b7))
+
+
+## v0.7.0 (2025-01-12)
+
+### Chores
+
+- **deps**: Update python-semantic-release/publish-action action to v9.16.0
+  ([#38](https://github.com/watermarkhu/mkdocstrings-matlab/pull/38),
+  [`fc404c4`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/fc404c46af2830eaba288beb8635092174a21b3b))
+
+Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
+
+- **deps**: Update python-semantic-release/python-semantic-release action to v9.16.0
+  ([#39](https://github.com/watermarkhu/mkdocstrings-matlab/pull/39),
+  [`56e8f87`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/56e8f877d357deeaee3eb6cf31bee2b064ee2438))
+
+Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
+
+Co-authored-by: Mark Shui Hu <watermarkhu@gmail.com>
+
+### Features
+
+- Folder modules ([#37](https://github.com/watermarkhu/mkdocstrings-matlab/pull/37),
+  [`81b551d`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/81b551d794804212c18645926d58121cf556c79d))
+
+* remove redundant root object
+
+* feat: document folders
+
+* uv format
+
+* docs: update readme
+
+
 ## v0.6.0 (2025-01-04)
 
 ### Documentation

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

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-matlab
-Version: 0.6.0
+Version: 0.8.0
 Summary: A MATLAB handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
-License: ISC
+License: MIT
 License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
@@ -21,11 +21,11 @@ Classifier: Topic :: Software Development :: Documentation
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
-Requires-Dist: charset-normalizer>=3.3.2
+Requires-Dist: charset-normalizer==3.4.1
 Requires-Dist: mkdocstrings-python==1.13.0
 Requires-Dist: mkdocstrings==0.27.0
-Requires-Dist: tree-sitter-matlab>=1.0.2
-Requires-Dist: tree-sitter>=0.23.2
+Requires-Dist: tree-sitter-matlab==1.0.3
+Requires-Dist: tree-sitter==0.23.2
 Description-Content-Type: text/markdown
 
 <!-- --8<-- [start:header] -->
@@ -40,7 +40,7 @@ Description-Content-Type: text/markdown
 [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://watermarkhu.nl/mkdocstrings-matlab)
 [![pypi version](https://img.shields.io/pypi/v/mkdocstrings-matlab.svg)](https://pypi.org/project/mkdocstrings-matlab/)
 
-The MATLAB handler uses [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) and its [MATLAB parser](https://github.com/acristoffers/tree-sitter-matlab) to collect documentation from MATLAB source code. Via the python bindings the Abstract Syntax Tree (AST) of the source code is traversed to extract useful information. The imported objected are imported as custom [Griffe](https://mkdocstrings.github.io/griffe/) objects and mocked for the [python handler](https://mkdocstrings.github.io/python/). 
+The MATLAB handler uses [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) and its [MATLAB parser](https://github.com/acristoffers/tree-sitter-matlab) to collect documentation from MATLAB source code. The AST information are imported as custom [Griffe](https://mkdocstrings.github.io/griffe/) objects and mocked for the [python handler](https://mkdocstrings.github.io/python/). 
 
 
 You can install this handler by specifying it as a dependency:
@@ -64,10 +64,10 @@ dependencies = [
 
 - **Support for argument validation blocks:** Tree-sitter collects your [function and method argument validation](https://mathworks.com/help/matlab/matlab_prog/function-argument-validation-1.html)
    blocks to display input and output argument types and default values. 
-   It is even able to automatically add cross-references o other objects from your API.
+   It is even able to automatically add cross-references to other objects from your API.
 
-- **Recursive documentation of MATLAB [namespaces](https://mathworks.com/help/matlab/matlab_oop/namespaces.html):** 
-  just add `+` to the identifer, and you get the full namespace docs. You don't need to inject documentation for each class, function, and script. Additionaly, the parent namespace documentation will be either extracted from the `Contents.m` or the `readme.md` file at the root of the namespace. 
+- **Recursive documentation of MATLAB [namespaces](https://mathworks.com/help/matlab/matlab_oop/namespaces.html) and folders:** 
+  just add `+` to the identifer for namespaces or the relative path for folder, and you get documentation for the entire directory. You don't need to inject documentation for each class, function, and script. Additionaly, the directory documentation will be either extracted from the `Contents.m` or the `readme.md` file at the root of the namespace or folder.
 
 - **Support for documented properties:** properties definitions followed by a docstring will be recognized in classes. 
 

{mkdocstrings_matlab-0.6.0 → mkdocstrings_matlab-0.8.0}/README.md

@@ -10,7 +10,7 @@
 [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://watermarkhu.nl/mkdocstrings-matlab)
 [![pypi version](https://img.shields.io/pypi/v/mkdocstrings-matlab.svg)](https://pypi.org/project/mkdocstrings-matlab/)
 
-The MATLAB handler uses [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) and its [MATLAB parser](https://github.com/acristoffers/tree-sitter-matlab) to collect documentation from MATLAB source code. Via the python bindings the Abstract Syntax Tree (AST) of the source code is traversed to extract useful information. The imported objected are imported as custom [Griffe](https://mkdocstrings.github.io/griffe/) objects and mocked for the [python handler](https://mkdocstrings.github.io/python/). 
+The MATLAB handler uses [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) and its [MATLAB parser](https://github.com/acristoffers/tree-sitter-matlab) to collect documentation from MATLAB source code. The AST information are imported as custom [Griffe](https://mkdocstrings.github.io/griffe/) objects and mocked for the [python handler](https://mkdocstrings.github.io/python/). 
 
 
 You can install this handler by specifying it as a dependency:
@@ -34,10 +34,10 @@ dependencies = [
 
 - **Support for argument validation blocks:** Tree-sitter collects your [function and method argument validation](https://mathworks.com/help/matlab/matlab_prog/function-argument-validation-1.html)
    blocks to display input and output argument types and default values. 
-   It is even able to automatically add cross-references o other objects from your API.
+   It is even able to automatically add cross-references to other objects from your API.
 
-- **Recursive documentation of MATLAB [namespaces](https://mathworks.com/help/matlab/matlab_oop/namespaces.html):** 
-  just add `+` to the identifer, and you get the full namespace docs. You don't need to inject documentation for each class, function, and script. Additionaly, the parent namespace documentation will be either extracted from the `Contents.m` or the `readme.md` file at the root of the namespace. 
+- **Recursive documentation of MATLAB [namespaces](https://mathworks.com/help/matlab/matlab_oop/namespaces.html) and folders:** 
+  just add `+` to the identifer for namespaces or the relative path for folder, and you get documentation for the entire directory. You don't need to inject documentation for each class, function, and script. Additionaly, the directory documentation will be either extracted from the `Contents.m` or the `readme.md` file at the root of the namespace or folder.
 
 - **Support for documented properties:** properties definitions followed by a docstring will be recognized in classes. 
 

{mkdocstrings_matlab-0.6.0 → mkdocstrings_matlab-0.8.0}/docs/api.md

@@ -1,8 +1,4 @@
 
-!!! note
-
-    Due to that for the documentation of mkdocstrings-matlab both the MATLAB and the Python handler are loaded, the symbols shown for Python objects will be incorrect (see [Configuration](usage/index.md#configuration)). 
-
 ::: mkdocstrings_handlers.matlab
     handler: python
     options:

{mkdocstrings_matlab-0.6.0 → mkdocstrings_matlab-0.8.0}/docs/index.md

@@ -27,8 +27,6 @@ Given the function above, the rendered documentation here is created from the fo
       parse_arguments: true
 ```
 
-
-
 </div>
 
 --8<-- "README.md:footer"

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

@@ -553,13 +553,17 @@ plugins:
     === "With symbol type in headings"
 
         ```markdown
-        ::: +mynamespace
+        ::: docs/snippets
             options:
+              members:
+                - mynamespace
               show_symbol_type_heading: true
         ```
 
-        ::: +mynamespace
+        ::: docs/snippets
             options:
+              members: 
+                - mynamespace
               show_symbol_type_heading: true
               show_docstring_input_arguments: false
               show_docstring_output_arguments: false
@@ -567,13 +571,17 @@ plugins:
     === "Without symbol type in headings"
 
         ```markdown
-        ::: +mynamespace
+        ::: docs/snippets
             options:
+              members:
+                - mynamespace
               show_symbol_type_heading: false
         ```
 
-        ::: +mynamespace
+        ::: docs/snippets
             options:
+              members:
+                - mynamespace
               show_symbol_type_heading: false
               show_docstring_input_arguments: false
               show_docstring_output_arguments: false
@@ -586,11 +594,12 @@ plugins:
 Show the symbol type in the Table of Contents.
 
 This option will prefix items in the ToC with
-<code class="doc-symbol doc-symbol-attribute"></code>,
+<code class="doc-symbol doc-symbol-property"></code>,
 <code class="doc-symbol doc-symbol-function"></code>,
 <code class="doc-symbol doc-symbol-method"></code>,
-<code class="doc-symbol doc-symbol-class"></code> or
-<code class="doc-symbol doc-symbol-module"></code> types.
+<code class="doc-symbol doc-symbol-class"></code>,
+<code class="doc-symbol doc-symbol-namespace"></code> or.
+<code class="doc-symbol doc-symbol-folder"></code> types.
 See also [`show_symbol_type_heading`][show_symbol_type_heading].
 
 ```yaml title="in mkdocs.yml (global configuration)"
@@ -603,7 +612,7 @@ 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. 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. 
+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)"
@@ -617,12 +626,13 @@ plugins:
     === "With symbol type in ToC"
 
         <ul style="list-style: none;">
-          <li><code class="doc-symbol doc-symbol-module"></code> namespace</li>
+          <li><code class="doc-symbol doc-symbol-folder"></code> folder</li>
+          <li><code class="doc-symbol doc-symbol-namespace"></code> namespace</li>
           <li><code class="doc-symbol doc-symbol-function"></code> function</li>
           <li><code class="doc-symbol doc-symbol-class"></code> Class
             <ul style="list-style: none;">
               <li><code class="doc-symbol doc-symbol-method"></code> method</li>
-              <li><code class="doc-symbol doc-symbol-attribute"></code> property</li>
+              <li><code class="doc-symbol doc-symbol-property"></code> property</li>
             </ul>
           </li>
         </ul>
@@ -630,6 +640,7 @@ plugins:
     === "Without symbol type in ToC"
 
         <ul style="list-style: none;">
+          <li>folder</li>
           <li>namespace</li>
           <li>function</li>
           <li>Class

{mkdocstrings_matlab-0.6.0 → mkdocstrings_matlab-0.8.0}/docs/usage/configuration/members.md

@@ -700,11 +700,6 @@ plugins:
               summary:
                 functions: true
 
-!!! warning
-
-    In the summary, the title of the properties summary will be *attributes*, and the title of the namespaces summary will be *modules*. This is due to mkdocstrings-matlab's dependency on mkdocstrings-python. For now, mkdocstrings-matlab does not implement its own Jinja templates for rendering, leading to these summary titles. 
-
-
 ## `show_labels`
 
 - **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**

{mkdocstrings_matlab-0.6.0 → mkdocstrings_matlab-0.8.0}/docs/usage/index.md

@@ -27,21 +27,14 @@ plugins:
         ...  # the MATLAB handler configuration
 ```
 
-When using the [material](https://squidfunk.github.io/mkdocs-material) theme, it is best to also configure the `mkdocs_material_matlab` plugin. This additional plugin, which is installed together with mkdocstrings-matlab, will overrule the symbols shown with [`show_symbol_type_heading`][] and [`show_symbol_type_toc`][] to show the correct symbols as per MATLAB nomenclature. 
-
 ```yaml title="mkdocs.yml"
 plugins:
-- mkdocs_material_matlab
 - mkdocstrings:
     default_handler: matlab
     matlab:
         ...  # the MATLAB handler configuration
 ```
 
-??? warning "I want to document both MATLAB and Python"
-
-    The `mkdocs_material_matlab` plugin will also change the symbols for the Python handler. This means that Python modules will not be tagged with symbol `mod` but `name` (namespace), and attributes are not tagged with symbol `attr` but `prop` (property). 
-
 ## Injecting documentation
 
 With the MATLAB handler installed and configured as default handler, you can inject documentation for a module, class, function, or any other MATLAB object with *mkdocstrings*' [autodoc syntax], in your Markdown pages:
@@ -56,6 +49,7 @@ If another handler was defined as default handler, you can explicitely ask for t
 ::: path.to.object
     handler: matlab
 ```
+### Namespaces
 
 Entire [namespaces](https://mathworks.com/help/matlab/matlab_oop/namespaces.html) can be fully documented by prefixing the `+` character to the namespace that is to be documented. E.g. the following namespace 
 
@@ -74,8 +68,7 @@ is documented with:
 ::: +mynamespace
 ```
 
-The docstring of the namespace is taken from either the [`Contents.m`](https://mathworks.com/help/matlab/matlab_prog/create-a-help-summary-contents-m.html) or a `readme.md` that resides at the root level of the namespace, with `Contents.m` taking precedence over `readme.md`. 
-
+The docstring of the namespace is taken from either the [`Contents.m`](https://mathworks.com/help/matlab/matlab_prog/create-a-help-summary-contents-m.html) or a `readme.md` that resides at the root level of the namespace, with `Contents.m` taking precedence over `readme.md`.
 
 Documenting a nested namespace requires only a single prefixed `+` at the start of the fully resolved path, e.g. 
 
@@ -83,6 +76,49 @@ Documenting a nested namespace requires only a single prefixed `+` at the start
 ::: +mynamespace.subnamespace
 ```
 
+### Folders
+
+Similarly to namepaces, all contents of a folder can be fully documented by specifying the relative path of a folder with respect to the `mkdocs.yml` config file. E.g. the following repository
+
+```tree
+src
+    module
+        myfunction.m
+        myClass.m
+        submodule
+            myfunction.m
+        +mynamespace
+            namespacefunction.m
+docs
+    index.md
+mkdocs.yml
+```
+
+is documented with:
+
+```markdown
+::: src/module
+```
+
+In the case above the function `module/submodule/myfunction.m` overshadows the function `module/myfunction.m` on the MATLAB path. This means that in the global namespace myfunction will always call `module/submodule/myfunction.m`, which is the function to be documented by `::: myfunction`. 
+
+While this kind of behavior is strictly recommended against, mkdocstrings-matlab does support documenting the shadowed function by using its path. The file extension is now stricty required. 
+
+```markdown
+::: src/module/myfunction.m
+```
+
+!!! tip
+
+    A folder identifier must strictly contain the `/` character. For a folder `foo` that is in the same directory with `mkdocs.yml`, use `::: ./foo`. 
+
+!!! tip
+
+    If the `mkdocs.yml` lives inside of a subdirectly that does not contain source code, use relative paths e.g. `../src/module`. 
+
+!!! tip
+
+    Sub-selecting folder members are possible with the [members](./configuration/members.md) options. 
 
 ### Global-only options
 

{mkdocstrings_matlab-0.6.0 → mkdocstrings_matlab-0.8.0}/mkdocs.yml

@@ -127,11 +127,10 @@ markdown_extensions:
     toc_depth: 3
 
 plugins:
+- callouts
 - autorefs
 - search
 - markdown-exec
-- callouts
-- mkdocs-material-matlab
 - mkdocstrings:
     default_handler: matlab
     handlers:
@@ -201,16 +200,13 @@ plugins:
           summary: true
           unwrap_annotated: true
 
+- minify:
+    minify_html: !ENV [DEPLOY, false]
+
 - git-revision-date-localized:
     enabled: !ENV [DEPLOY, false]
     enable_creation_date: true
     type: timeago
-- minify:
-    minify_html: !ENV [DEPLOY, false]
-- group:
-    enabled: !ENV [MATERIAL_INSIDERS, false]
-    plugins:
-    - typeset
 
 extra:
   version:

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

@@ -1,19 +1,19 @@
 [project]
 name = "mkdocstrings-matlab"
-version = "0.6.0"
+version = "0.8.0"
 description = "A MATLAB handler for mkdocstrings"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }
 ]
-license =  { text = "ISC" }
+license =  { text = "MIT" }
 readme = "README.md"
 requires-python = ">=3.10"
 dependencies = [
     "mkdocstrings==0.27.0",
-    "mkdocstrings-python==1.13.0",  # Later versions will currently break 
-    "charset-normalizer>=3.3.2",
-    "tree-sitter>=0.23.2",
-    "tree-sitter-matlab>=1.0.2",
+    "mkdocstrings-python==1.13.0",
+    "charset-normalizer==3.4.1",
+    "tree-sitter==0.23.2",
+    "tree-sitter-matlab==1.0.3",
 ]
 classifiers = [
     "Development Status :: 4 - Beta",
@@ -44,19 +44,13 @@ managed = true
 allow-direct-references = true
 
 [tool.hatch.build.targets.wheel]
-packages = ["src/mkdocstrings_handlers", "src/mkdocs_material_matlab"]
-
-[project.entry-points."mkdocs.plugins"]
-mkdocs-material-matlab = "mkdocs_material_matlab:MkdocsMaterialMatlabPlugin"
+packages = ["src/mkdocstrings_handlers"]
 
 [dependency-groups]
 docs = [
     "mkdocs-material>=9.5.33",
     "markdown-exec>=1.10.0",
     "mkdocs-callouts>=1.15.0",
-    "mkdocs-with-pdf>=0.9.3",
-    "mkdocs-gen-files>=0.5.0",
-    "mkdocs-literate-nav>=0.6.1",
     "mkdocs-git-revision-date-localized-plugin>=1.3.0",
     "mkdocs-minify-plugin>=0.8.0",
     "mike>=2.1.3",

mkdocstrings_matlab-0.8.0/scripts/copy_and_update_python_templates.py

@@ -0,0 +1,121 @@
+"""A script to copy the modules and attributes templates from
+the python handler to the matlab handler and update the names"""
+
+from mkdocstrings_handlers.python.handler import PythonHandler
+from pathlib import Path
+import re
+
+# Get the templates directory of the python handler
+pythonHandler = PythonHandler("python", "material")
+templatesDir = pythonHandler.get_templates_dir()
+targetDir = (
+    Path(__file__).parent.parent
+    / "src"
+    / "mkdocstrings_handlers"
+    / "matlab"
+    / "templates"
+)
+
+
+def copy_template(
+    sourcePath: str,
+    targetPath: str,
+    mapping: dict[str, str] = {},
+    theme: str = "material",
+):
+    sourceFile = templatesDir / theme / sourcePath
+    targetFile = targetDir / theme / targetPath
+    content = sourceFile.read_text()
+    pattern = re.compile(
+        "|".join([re.escape(k) for k in sorted(mapping, key=len, reverse=True)]),
+        flags=re.DOTALL,
+    )
+    content = pattern.sub(lambda x: mapping[x.group(0)], content)
+    targetFile.write_text(content)
+
+    return (targetFile, content)
+
+
+# Copy the namespace and module templates
+copy_template(
+    "_base/module.html.jinja",
+    "folder.html.jinja",
+    {"doc-symbol-module": "doc-symbol-folder"},
+)
+copy_template(
+    "_base/module.html.jinja",
+    "namespace.html.jinja",
+    {"doc-symbol-module": "doc-symbol-namespace"},
+)
+
+# Copy the property template
+copy_template(
+    "_base/attribute.html.jinja",
+    "property.html.jinja",
+    {"doc-symbol-attribute": "doc-symbol-property"},
+)
+
+# Copy the summary modules template
+copy_template(
+    "_base/summary.html.jinja",
+    "summary.html.jinja",
+    {
+        "summary/modules": "summary/namespaces",
+        "summary/attributes": "summary/properties",
+    },
+)
+
+
+## Copy the summary properties template
+copy_template(
+    "_base/summary/attributes.html.jinja",
+    "summary/properties.html.jinja",
+    {
+        "docstring/attributes": "docstring/properties",
+        "Summary of attributes": "Summary of properties",
+    },
+)
+copy_template(
+    "_base/docstring/attributes.html.jinja",
+    "docstring/properties.html.jinja",
+    {
+        'lang.t("Attributes:")': '"Properties:"',
+        'lang.t("ATTRIBUTE")': '"PROPERTY:"',
+        " attributes ": " properties ",
+        '"Attributes"': '"Properties"',
+    },
+)
+
+## Copy the summary namespaces template
+copy_template(
+    "_base/summary/modules.html.jinja",
+    "summary/namespaces.html.jinja",
+    {
+        "docstring/modules": "docstring/namespaces",
+        "Summary of modules": "Summary of namespaces",
+    },
+)
+copy_template(
+    "_base/docstring/modules.html.jinja",
+    "docstring/namespaces.html.jinja",
+    {
+        'lang.t("Modules:")': '"Namespaces:"',
+        'lang.t("MODULE")': '"NAMESPACE:"',
+        " modules ": " namespaces ",
+        '"Modules"': '"Namespaces"',
+    },
+)
+
+## Copy children template
+copy_template(
+    "_base/children.html.jinja",
+    "children.html.jinja",
+    {
+        "-attributes": "-properties",
+        "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 %}",
+    },
+)