manta/mkdocs.yml

site_name: "Manta Documentation"
site_description: Manta Documentation
site_author: Fischer Moseley
site_url: https://fischermoseley.github.io/manta/

repo_url: https://github.com/fischermoseley/manta/
repo_name: fischermoseley/manta
docs_dir: 'doc'

theme:
  name: material
  logo: assets/logo_minimal_border.png
  favicon: assets/logo_ray_only_with_shadow.png
  custom_dir: doc/overrides/
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.sections
    - navigation.expand

  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: custom
      toggle:
        icon: material/brightness-auto
        name: Switch to system preference

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tilde
  - attr_list

extra:
  version:
    provider: mike

plugins:
  - mkdocstrings:
      handlers:
        python:
          options:
            heading_level: 3
            show_bases: false
            show_root_heading: true
            show_source: false
            separate_signature: true
            show_signature_annotations: true
            modernize_annotations: true
            signature_crossrefs: true
            docstring_section_style: list
            show_symbol_type_toc: true
            show_symbol_type_heading: true

            docstring_options:
              ignore_init_summary: false

            # filters: ["!^_"]
            unwrap_annotated: true

nav:
    - Home: index.md
    - Installation: installation.md
    - Getting Started: getting_started.md
    - Use Cases: use_cases.md
    - Architecture: architecture.md
    - Similar Tools: similar_tools.md
    - Cores:
      - IO Core: io_core.md
      - Logic Analyzer Core: logic_analyzer_core.md
      - Memory Core: memory_core.md

    - Interfaces:
      - UART Interface: uart_interface.md
      - Ethernet Interface: ethernet_interface.md
    - For Developers:
      - Roadmap: https://github.com/fischermoseley/manta/milestones
logic analyzer docs 2023-08-15 08:33:50 +02:00			`site_name: "Manta Documentation"`
add site config to mkdocs 2023-03-09 22:35:16 +01:00			`site_description: Manta Documentation`
			`site_author: Fischer Moseley`
docs: add mike 2024-10-06 18:52:23 +02:00			`site_url: https://fischermoseley.github.io/manta/`
add site config to mkdocs 2023-03-09 22:35:16 +01:00
			`repo_url: https://github.com/fischermoseley/manta/`
tidy DHCP counter 2024-02-19 22:53:04 +01:00			`repo_name: fischermoseley/manta`
fix docs_dir in mkdocs.yml 2023-03-09 22:40:11 +01:00			`docs_dir: 'doc'`
add docs_dir to mkdocs.yml 2023-03-09 22:37:41 +01:00
build docs 2023-03-09 22:26:45 +01:00			`theme:`
add site config to mkdocs 2023-03-09 22:35:16 +01:00			`name: material`
upate image names 2023-09-02 18:54:20 +02:00			`logo: assets/logo_minimal_border.png`
			`favicon: assets/logo_ray_only_with_shadow.png`
docs: add mike 2024-10-06 18:52:23 +02:00			`custom_dir: doc/overrides/`
update lotsa docs 2023-03-10 03:17:39 +01:00			`features:`
			`- content.code.copy`
			`- content.code.annotate`
update navbar in docs site 2023-04-13 03:32:34 +02:00			`- navigation.sections`
			`- navigation.expand`
update lotsa docs 2023-03-10 03:17:39 +01:00
update docs 2023-03-09 23:22:19 +01:00			`palette:`
fix grammar and diagrams 2024-02-10 07:49:58 +01:00			`- media: "(prefers-color-scheme)"`
update docs 2023-03-09 23:22:19 +01:00			`toggle:`
docs: autogenerate Python API docs, update IO core docs 2024-09-04 03:42:00 +02:00			`icon: material/brightness-7`
fix grammar and diagrams 2024-02-10 07:49:58 +01:00			`name: Switch to light mode`
			`- media: "(prefers-color-scheme: light)"`
			`scheme: default`
			`primary: blue`
			`accent: custom`
			`toggle:`
docs: autogenerate Python API docs, update IO core docs 2024-09-04 03:42:00 +02:00			`icon: material/brightness-4`
update docs 2023-03-09 23:22:19 +01:00			`name: Switch to dark mode`
fix grammar and diagrams 2024-02-10 07:49:58 +01:00			`- media: "(prefers-color-scheme: dark)"`
			`scheme: slate`
			`primary: black`
			`accent: custom`
update docs 2023-03-09 23:22:19 +01:00			`toggle:`
docs: autogenerate Python API docs, update IO core docs 2024-09-04 03:42:00 +02:00			`icon: material/brightness-auto`
fix grammar and diagrams 2024-02-10 07:49:58 +01:00			`name: Switch to system preference`
add site config to mkdocs 2023-03-09 22:35:16 +01:00
one more docs update 2023-03-10 05:31:05 +01:00			`extra_css:`
			`- stylesheets/extra.css`

add docs and add trigger config for logic analyzer 2023-04-17 23:57:26 +02:00			`extra_javascript:`
			`- javascripts/mathjax.js`
			`- https://polyfill.io/v3/polyfill.min.js?features=es6`
			`- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js`

update lotsa docs 2023-03-10 03:17:39 +01:00			`markdown_extensions:`
			`- pymdownx.highlight:`
			`anchor_linenums: true`
			`line_spans: __span`
			`pygments_lang_class: true`
add docs and add trigger config for logic analyzer 2023-04-17 23:57:26 +02:00			`- pymdownx.arithmatex:`
			`generic: true`
update lotsa docs 2023-03-10 03:17:39 +01:00			`- pymdownx.inlinehilite`
			`- pymdownx.snippets`
			`- pymdownx.superfences`
add a little info on the io cores 2023-03-10 05:56:16 +01:00			`- admonition`
			`- pymdownx.details`
			`- pymdownx.superfences`
update bram docs 2023-08-16 08:07:59 +02:00			`- pymdownx.tilde`
fix images on docs site 2023-09-02 18:29:26 +02:00			`- attr_list`
update lotsa docs 2023-03-10 03:17:39 +01:00
docs: add mike 2024-10-06 18:52:23 +02:00			`extra:`
			`version:`
			`provider: mike`

docs: autogenerate Python API docs, update IO core docs 2024-09-04 03:42:00 +02:00			`plugins:`
			`- mkdocstrings:`
			`handlers:`
			`python:`
			`options:`
			`heading_level: 3`
			`show_bases: false`
			`show_root_heading: true`
			`show_source: false`
			`separate_signature: true`
			`show_signature_annotations: true`
			`modernize_annotations: true`
			`signature_crossrefs: true`
			`docstring_section_style: list`
			`show_symbol_type_toc: true`
			`show_symbol_type_heading: true`

			`docstring_options:`
			`ignore_init_summary: false`

			`# filters: ["!^_"]`
			`unwrap_annotated: true`

add site config to mkdocs 2023-03-09 22:35:16 +01:00			`nav:`
update lots of docs 2023-08-02 16:39:07 +02:00			`- Home: index.md`
			`- Installation: installation.md`
update docs, bump required python to 3.8 2024-01-14 00:05:45 +01:00			`- Getting Started: getting_started.md`
docs: autogenerate Python API docs, update IO core docs 2024-09-04 03:42:00 +02:00			`- Use Cases: use_cases.md`
update docs, bump required python to 3.8 2024-01-14 00:05:45 +01:00			`- Architecture: architecture.md`
docs: autogenerate Python API docs, update IO core docs 2024-09-04 03:42:00 +02:00			`- Similar Tools: similar_tools.md`
			`- Cores:`
update lots of docs 2023-08-02 16:39:07 +02:00			`- IO Core: io_core.md`
fix broken links 2023-09-02 18:33:42 +02:00			`- Logic Analyzer Core: logic_analyzer_core.md`
convert diagrams to .drawio.svg format 2024-01-06 08:01:57 +01:00			`- Memory Core: memory_core.md`
docs: autogenerate Python API docs, update IO core docs 2024-09-04 03:42:00 +02:00
			`- Interfaces:`
update docs, bump required python to 3.8 2024-01-14 00:05:45 +01:00			`- UART Interface: uart_interface.md`
update docs in response to feedback from Joe 2023-09-12 04:09:42 +02:00			`- Ethernet Interface: ethernet_interface.md`
			`- For Developers:`
			`- Roadmap: https://github.com/fischermoseley/manta/milestones`