Initial commit

2026-04-15 10:48:27 -04:00
commit 79b1babcd0
47 changed files with 62913 additions and 0 deletions
@@ -0,0 +1,136 @@
+docs_dir: docs
+
+site_name: pcdigitizer
+site_author: Scientific Computing Studio
+
+repo_name: scienting/pcdigitizer
+repo_url: https://github.com/scienting/pcdigitizer
+copyright: <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/">CC BY-NC-SA 4.0</a> by Scientific Computing Studio
+
+# https://squidfunk.github.io/mkdocs-material/
+theme:
+  name: material
+  custom_dir: docs/.overrides
+  language: en
+  palette:
+    # Palette toggle for light mode
+    - scheme: default
+      toggle:
+        icon: material/lightbulb-outline
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - scheme: dark
+      toggle:
+        icon: material/lightbulb
+        name: Switch to light mode
+  font:
+    text: Roboto
+    code: Roboto Mono
+  icon:
+    repo: fontawesome/brands/github
+    annotation: material/star-four-points-circle
+  features:
+    - content.code.annotate
+    - content.code.copy
+    - content.code.select
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.tracking
+    - navigation.top
+    - navigation.indexes
+    - navigation.path
+    - navigation.prune
+    - toc.follow
+    - search.suggest
+
+validation:
+  omitted_files: warn
+  absolute_links: warn
+  unrecognized_links: warn
+
+# Options need to be indented twice for some reason?
+plugins:
+  - search
+  - autorefs
+  - gen-files:
+      scripts:
+        - docs/gen_ref_pages.py
+  - mkdocstrings:
+      handlers:
+        python:
+          inventories:
+            - "https://docs.python.org/3/objects.inv"
+            - "https://requests.readthedocs.io/en/latest/objects.inv"
+          paths: ["pcdigitizer"]
+          options:
+            show_source: false
+            show_root_heading: false
+            annotations_path: brief
+            docstring_style: google
+            merge_init_into_class: true
+            docstring_section_style: spacy
+            show_if_no_docstring: true
+            show_labels: false
+            parameter_headings: true
+            show_symbol_type_heading: true
+            show_symbol_type_toc: true
+            filters:
+              - ""
+  - awesome-nav
+  - git-revision-date-localized:
+      type: iso_datetime
+      timezone: America/Detroit
+      fallback_to_build_date: true
+  - macros
+  - glightbox
+
+extra:
+  generator: false
+
+extra_css:
+  - css/base.css
+  - css/colors.css
+  - css/mkdocstrings.css
+
+extra_javascript:
+  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
+  - js/mathjax-config.js
+
+markdown_extensions:
+  - abbr
+  - toc:
+      permalink: true
+  - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - md_in_html
+  - tables
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem
+  - pymdownx.caret
+  - pymdownx.details
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.snippets
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg