refactor: Job dict object as Class

docs/User Guide/Installation.md

@@ -0,0 +1,4 @@
+# Reference
+::: proxima.app.checks.WorkerCheck
+    handler: python
+

docs/css/code_select.css

@@ -0,0 +1,3 @@
+.language-pycon .gp, .language-pycon .go { /* Generic.Prompt, Generic.Output */
+    user-select: none;
+}

docs/gen_ref_pages.py

@@ -0,0 +1,32 @@
+"""Generate the code reference pages."""
+
+from pathlib import Path
+
+import mkdocs_gen_files
+
+nav = mkdocs_gen_files.Nav()
+
+for path in sorted(Path("src").rglob("*.py")):  #
+    module_path = path.relative_to("src").with_suffix("")  #
+    doc_path = path.relative_to("src/docs").with_suffix(".md")  #
+    full_doc_path = Path("reference", doc_path)  #
+
+    parts = list(module_path.parts)
+
+    if parts[-1] == "__init__":  #
+        parts = parts[:-1]
+        doc_path = doc_path.with_name("index.md")
+        full_doc_path = full_doc_path.with_name("index.md")
+    elif parts[-1] == "__main__":
+        continue
+
+    nav[parts] = doc_path.as_posix()
+
+    with mkdocs_gen_files.open(full_doc_path, "w") as fd:  #
+        identifier = ".".join(parts)  #
+        print("::: " + identifier, file=fd)  #
+
+    mkdocs_gen_files.set_edit_path(full_doc_path, Path("../") / path)  #
+
+    with mkdocs_gen_files.open("reference/SUMMARY.md", "w") as nav_file:
+        nav_file.writelines(nav.build_literate_nav())

mkdocs.yml

@@ -11,6 +11,10 @@ theme:
 
   custom_dir: docs/overrides
 
+  nav:
+  - Code Reference: reference/poet
+
+
   palette:
     - media: "(prefers-color-scheme: light)"
       scheme: default
@@ -36,12 +40,34 @@ theme:
     - search.suggest
     - search.highlight
 
+  nav:
+    - "My page": test.md
+
   plugins:
   - tags
   - search
-  - termynal
+  - mkdocstrings:
+      default_handler: python
+      handlers:
+        python:
+          setup_commands:
+            - import sys
+            - sys.path.append("src")
+          rendering:
+            show_source: true
+
+  watch:
+    - src/proxima
+
   - git-revision-date-localized:
       enable_creation_date: true
+  - gen-files:
+      scripts:
+      - docs/gen_ref_pages.py
+  - literate-nav:
+      nav_file: SUMMARY.md
+  - section-index
+
 
 extra:
   version:
@@ -62,4 +88,10 @@ markdown_extensions:
       custom_fences:
         - name: mermaid
           class: mermaid
-          format: !!python/name:pymdownx.superfences.fence_code_format
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.highlight:
+      use_pygments: true
+      pygments_lang_class: true
+
+extra_css:
+- css/code_select.css