mkdocs.yml

site_name: UV Data Science Project Mono-Repository Template
repo_url: https://github.com/tiefenthaler/uv-datascience-project-monorepo-template
copyright: Copyright © 2025 David Tiefenthaler
nav:
  - Home:
    - index.md
    - About: about.md
  - Guides:
    - guides/index.md
    - UV: guides/uv.md
    - Ruff: guides/ruff.md
    - PyRight: guides/pyright.md
    - PyTest: guides/pytest.md
    - Pre-Commit: guides/pre_commit.md
    - CI-GitHub: guides/ci_github.md
    - MkDocs: guides/mkdocs.md
    - Docker-Production: guides/docker_prod.md
    - Docker-VSCode-DevContainer: guides/docker_vscode_devcontainer.md
  - Source Code API Reference:
      - api/index.md
      - Autoencoder: api/autoencoder.md
      - Training: api/training.md
      - FastAPI: api/fastapi_app.md
  # NOTE: Does not support nested lists.
  - Notebooks: 
    - Jupyter Notebook - App: notebooks/app_without_fastapi.ipynb
theme:
  name: material
  features:
    - navigation.indexes
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - content.code.copy
    - content.code.select
plugins:
  - search
  - include-markdown
  - mkdocstrings:
      handlers:
        python:
          paths: [src] # search packages in the src folder
          rendering:
            show_root_heading: yes
            merge_init_into_class: yes
            docstring_section_style: spacy
          options:
            docstring_style: google
            show_source: true
  - mkdocs-jupyter:
      # ignore_h1_titles: true # Ignore using first h1 as title, instead use filename.
extra_css:
  - stylesheets/extra.css
markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.blocks.caption
  - pymdownx.details
  - pymdownx.highlight:
      use_pygments: true
      pygments_lang_class: true
  - pymdownx.superfences
  - pymdownx.pathconverter
  - pymdownx.snippets:
      base_path: ["."] # Using --8<-- "dir/file.md" is relative to the base_path.
  - toc:
      permalink: true