molax/mkdocs.yml at main · HFooladi/molax · 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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
site_name: "molax"
site_description: "molax: A JAX library for molecular active learning"
site_url: "https://hfooladi.github.io/molax/"
repo_url: "https://github.com/HFooladi/molax"
repo_name: "HFooladi/molax"
copyright: Copyright 2024 - 2025 Hosein Fooladi

remote_branch: "gh-pages"
use_directory_urls: false
docs_dir: "docs"

# Allow warnings during build (e.g., missing link targets)
strict: false

nav:
  - Getting Started: index.md
  - Core Concepts: concepts.md
  - API Reference:
      - Models: api/models.md
      - Acquisition: api/acquisition.md
      - Data: api/data.md
      - Metrics: api/metrics.md
  - Roadmap: roadmap.md

theme:
  name: material
  # NOTE(hadim): to customize the material primary and secondary color,
  # see check `docs/assets/css/custom.css`.
  palette:
    primary: deep purple
    accent: indigo

  features:
    - navigation.tabs
    - navigation.sections
    - navigation.path
    - navigation.top
    - navigation.footer
    - toc.follow
    - content.code.copy
    - content.code.annotate

extra_css:
  - assets/css/custom-splito.css

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

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true

watch:
  - molax/

plugins:
  - search

  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            show_root_heading: true
            heading_level: 3
            show_source: false
            group_by_category: true
            members_order: source
            separate_signature: true
            show_signature_annotations: true
            line_length: 80

  - mkdocs-jupyter:
      execute: False

  - mike:
      version_selector: true

extra:
  version:
    # Multi versioning provider for mkdocs-material (used for the JS selector)
    provider: mike