fix: ✨ Update Python analysis paths and fix documentation issues (#26)

* chore: Update .vscode/settings.json with additional Python analysis paths

* fix: Update mkdocs.yml to fix indentation issue

* build: Update `mike` from `v1` to `v2`

* chore: Update poetry.lock and pyproject.toml files

* build: Update `mike` deploy command

The `mike` deploy command in the Python-publish workflow has been updated to remove the `--rebase` flag and update the `latest` alias without rebasing. This change ensures that the documentation is properly deployed for each release.

* docs: Update theory functions module with correct paths

* fix: Correct labeling for example section

.github/workflows/python-publish.yml

@@ -76,5 +76,5 @@ jobs:
             fi
         - name: Deploy documentation develops
           run: |
-            poetry run mike deploy --push --rebase --update-aliases ${{ github.event.release.tag_name }} latest --message "Release ${{ github.event.release.tag_name }}"
-            poetry run mike set-default --push --rebase latest
+            poetry run mike deploy --push --update-aliases ${{ github.event.release.tag_name }} latest --message "Release ${{ github.event.release.tag_name }}"
+            poetry run mike set-default --push latest

.vscode/settings.json

@@ -17,5 +17,8 @@
   "python.defaultInterpreterPath": "python",
   "python.analysis.importFormat": "absolute",
   "python.analysis.enablePytestExtra": true,
-  "python.analysis.enableSyncServer": true
+  "python.analysis.enableSyncServer": true,
+  "python.analysis.extraPaths": [
+    "umf"
+  ]
 }

docs/modules/functions/theory/pathological.md

@@ -1,7 +1,7 @@
 ## Weierstrass Function
 
 <!-- prettier-ignore -->
-::: umf.functions.optimization.theory.WeierstrassFunction
+::: umf.functions.theory.pathological.WeierstrassFunction
     options:
         show_bases: false
         show_source: true
@@ -18,7 +18,7 @@
 ## Riemann Function
 
 <!-- prettier-ignore -->
-::: umf.functions.optimization.theory.RiemannFunction
+::: umf.functions.theory.pathological.RiemannFunction
     options:
         show_bases: false
         show_source: true
@@ -34,7 +34,7 @@
 ## Takagi Function
 
 <!-- prettier-ignore -->
-::: umf.functions.optimization.theory.TakagiFunction
+::: umf.functions.theory.pathological.TakagiFunction
     options:
         show_bases: false
         show_source: true
@@ -51,7 +51,7 @@
 ## Mandelbrot's Fractal Function
 
 <!-- prettier-ignore -->
-::: umf.functions.optimization.theory.MandelbrotsFractalFunction
+::: umf.functions.theory.pathological.MandelbrotsFractalFunction
     options:
         show_bases: false
         show_source: true
@@ -68,7 +68,7 @@
 ## Besicovitch Function
 
 <!-- prettier-ignore -->
-::: umf.functions.optimization.theory.BesicovitchFunction
+::: umf.functions.theory.pathological.BesicovitchFunction
     options:
         show_bases: false
         show_source: true

mkdocs.yml

@@ -238,7 +238,7 @@ nav:
               - Modules: modules/api/optimization.md
           - Theory:
               - Modules: modules/api/theory.md
-        - Others:
+      - Others:
           - Data Generation:
               - Modules: modules/api/data_generation.md
           - Meta Models & Patterns:

pyproject.toml

@@ -36,10 +36,9 @@ mkdocstrings = { extras = ["python"], version = "^0.22.0" }
 mathjax = "^0.1.2"
 mkdocs-literate-nav = "^0.6.0"
 mkdocs-section-index = "^0.3.5"
-mike = "^1.1.2"
+mike = "^2.1.2"
 mkdocs-table-reader-plugin = "^2.0.1"
 pymdown-extensions = "^10.1"
-mkdocs-material-extensions = "^1.1.1"
 
 [build-system]
 requires = ["poetry-core"]

umf/functions/theory/pathological.py

@@ -30,7 +30,7 @@ class WeierstrassFunction(PathologicalWithCoefficients):
     continuous everywhere but differentiable nowhere. It is defined by an infinite
     series that oscillates too wildly to settle down to a smooth curve.
 
-    Example:
+    Examples:
         >>> import matplotlib.pyplot as plt
         >>> from matplotlib.animation import FuncAnimation
         >>> import numpy as np
@@ -117,7 +117,7 @@ class RiemannFunction(PathologicalPure):
     a series of terms. Each term in the series is calculated using the
     Riemann zeta function and the sine function.
 
-    Example:
+    Examples:
         >>> import matplotlib.pyplot as plt
         >>> from matplotlib.animation import FuncAnimation
         >>> import numpy as np
@@ -177,7 +177,7 @@ class TakagiFunction(PathologicalPure):
     The Takagi function is a fractal-like continuous function defined on the real line.
     It is also known as the Takagi-Landsberg function or the Blancmange function.
 
-    Example:
+    Examples:
         >>> import matplotlib.pyplot as plt
         >>> from matplotlib.animation import FuncAnimation
         >>> import numpy as np
@@ -252,7 +252,7 @@ class MandelbrotsFractalFunction(PathologicalPure):
     complex and boundary-defining structure, which reveals an infinitely detailed and
     varied pattern upon magnification.
 
-    Example:
+    Examples:
         >>> import matplotlib.pyplot as plt
         >>> from matplotlib.animation import FuncAnimation
         >>> import numpy as np
@@ -339,7 +339,7 @@ class BesicovitchFunction(PathologicalPure):
     The Besicovitch function is a fractal-like continuous function defined on the
     real line. It is also known as the Besicovitch-Eggleston function.
 
-    Example:
+    Examples:
         >>> import matplotlib.pyplot as plt
         >>> from matplotlib.animation import FuncAnimation
         >>> import numpy as np