mkdocs.yml

site_name: ring
site_url: https://ring.com/
site_description: The documentation for the ring software library.

nav:
  - 'index.md'
  - 'xml_syntax.md'
  - Examples / Notebooks:
    - 'notebooks/getting_started.ipynb'
    - 'notebooks/batched_simulation.ipynb'
    - 'notebooks/control.ipynb'
    - 'notebooks/custom_joint_type.ipynb'
    - 'notebooks/experimental_data.ipynb'
    - 'notebooks/error_quaternion.ipynb'
    - 'notebooks/machine_learning.ipynb'
    - 'notebooks/visualisation.ipynb'
    - 'notebooks/knee_angle_tracking.ipynb'
  - API:
    - ring: 'api.md'

theme:
    name: readthedocs
    logo: img/icon.svg
    favicon: img/favicon.ico

markdown_extensions:
    - pymdownx.arithmatex:  # Render LaTeX via MathJax
        generic: true
    - pymdownx.superfences  # Seems to enable syntax highlighting when used with the Material theme.
    - pymdownx.details  # Allowing hidden expandable regions denoted by ???
    - pymdownx.snippets:  # Include one Markdown file into another
        base_path: docs
    - admonition
    - toc:
        permalink: "¤"  # Adds a clickable permalink to each section heading
        toc_depth: 4  # Prevents h5, h6 (i.e. methods) from showing up in the TOC.

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

plugins:
    - search  # default search plugin; needs manually re-enabling when using any other plugins
    - autorefs  # Cross-links to headings
    - mknotebooks
    - mkdocstrings:
        default_handler: python
        handlers:
            python:
                options:
                    show_root_heading: true
                    show_root_full_path: false
                    show_if_no_docstring: false
                    show_signature_annotations: false
                    members_order: source  # order methods according to their order of definition in the source code, not alphabetical order
                    heading_level: 4  # Makes everything top-level be <h4>. Child entries will be <h5> etc., but because of toc_depth, above, (deliberately) won't appear in the TOC.
                    show_bases: false