docs/mkdocs.yml at main · pyfenn/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
site_name: Fenn Documentation
site_url: https://pyfenn.org/
site_description: FENN Friendly Environment for Neural Networks
site_author: PyFenn
docs_dir: src

theme:
  logo: images/logo.png
  favicon: images/logo.png
  name: material
  custom_dir: overrides
  language: en
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - content.code.copy
    - toc.integrate   # right-hand in-page TOC

  palette:
    scheme: default
    primary: custom
    accent: custom

nav:
  - Homepage: index.md
  - Quickstart: content/quickstart.md
  - User Guide:
    - Logging:
      - Local: content/user_guide/logging/local.md
      - Wandb: content/user_guide/logging/wandb.md
    - Notifications:
      - Basic Usage: content/user_guide/notifications/basic_usage.md
      - Discord: content/user_guide/notifications/discord.md
      - Telegram: content/user_guide/notifications/telegram.md
      - Email: content/user_guide/notifications/email.md
      - Slack: content/user_guide/notifications/slack.md
    - Neural Networks:
      - Trainers:
        - Overview: content/user_guide/neural_networks/trainers/index.md
        - Base Trainer: content/user_guide/neural_networks/trainers/base_trainer.md
        - Classification: content/user_guide/neural_networks/trainers/classification_trainer.md
        - Regression: content/user_guide/neural_networks/trainers/regression_trainer.md
        - Checkpointing: content/user_guide/neural_networks/trainers/checkpoint_management.md
        - Advanced Features: content/user_guide/neural_networks/trainers/features.md
    - Data Processing:
      - Tabular: content/user_guide/data_processing/tabular.md
  - CLI:
    - Pull: content/cli/pull.md
  - Community:
    - Contributing: content/community/contributing.md
    - Code of Conduct: content/community/code_of_conduct.md

markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/pyfenn/fenn
      name: Source on GitHub

extra_css:
  - css/extra.css

copyright: "Copyright &copy; 2025 PyFenn"