initial template commit

mkdocs.yml

@@ -0,0 +1,112 @@
+docs_dir: docs
+site_name: 'anytraverser'
+site_url: 'https://chacha.ddns.net/mkdocs-web/chacha/anytraverser/latest/'
+site_description: 'Stream either Data or Annotations; hook into each step with Triggers to validate, transform, and build objects.'
+site_author: 'chacha'
+repo_url: 'https://chacha.ddns.net/gitea/chacha/anytraverser'
+use_directory_urls: false
+copyright: 'CC BY-NC-SA 4.0'
+theme:
+  name: material
+  features:
+  - navigation.instant
+  - navigation.tracking
+  - navigation.tabs
+  - navigation.tabs.sticky
+  - navigation.footer
+  - navigation.path
+  - navigation.top
+  - navigation.section
+  - content.code.annotate
+  - navigation.expand
+  - toc.follow
+  palette:
+  - media: '(prefers-color-scheme: dark)'
+    scheme: slate
+    toggle:
+      icon: material/brightness-4
+      name: Switch to system preference
+  - media: (prefers-color-scheme)
+    toggle:
+      icon: material/brightness-auto
+      name: Switch to light mode
+  - media: '(prefers-color-scheme: light)'
+    scheme: default
+    toggle:
+      icon: material/brightness-7
+      name: Switch to dark mode
+plugins:
+- search
+- markdownextradata
+- mermaid2
+- localsearch
+- mkdocstrings:
+    default_handler: python
+    handlers:
+      python:
+        options:
+          filters:
+          - '!^_[^_]'
+          inherited_members: false
+          show_if_no_docstring: true
+          show_signature_annotations: true
+          show_source: false
+          show_category_heading: true
+          group_by_category: true
+          show_root_full_path: false
+          merge_init_into_class: true
+          separate_signature: true
+          heading_level: 2
+          docstring_section_style: spacy
+          show_root_toc_entry: false
+markdown_extensions:
+- def_list
+- tables
+- attr_list
+- abbr
+- pymdownx.blocks.admonition:
+    types:
+    - new
+    - settings
+    - note
+    - abstract
+    - info
+    - tip
+    - success
+    - question
+    - warning
+    - failure
+    - danger
+    - bug
+    - example
+    - quote
+- pymdownx.blocks.definition
+- pymdownx.blocks.details
+- pymdownx.blocks.tab
+- pymdownx.blocks.html
+- pymdownx.betterem:
+    smart_enable: all
+- pymdownx.caret
+- pymdownx.critic
+- pymdownx.details
+- pymdownx.inlinehilite
+- pymdownx.snippets
+- pymdownx.highlight:
+    anchor_linenums: true
+    line_spans: __span
+    pygments_lang_class: true
+- pymdownx.keys
+- pymdownx.mark
+- pymdownx.progressbar
+- pymdownx.smartsymbols
+- pymdownx.tasklist:
+    custom_checkbox: true
+- pymdownx.tilde
+- footnotes
+- pymdownx.superfences
+- pymdownx.emoji:
+    emoji_index: !!python/name:materialx.emoji.twemoji
+    emoji_generator: !!python/name:materialx.emoji.to_svg
+extra:
+  branch: master
+  repository: anytraverser