THEMAP/mkdocs.yml at main · HFooladi/THEMAP · 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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
site_name: "THEMAP"
site_description: "THEMAP: Task Hardness Estimation for Molecular Activity Prediction"
site_url: "https://hfooladi.github.io/THEMAP/"
repo_url: "https://github.com/HFooladi/THEMAP"
repo_name: "HFooladi/THEMAP"
copyright: Copyright 2023 - 2026 Hosein Fooladi

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

# Fail on warnings to detect issues with types and docstring
strict: false

nav:
  - Home: index.md
  - Getting Started: user-guide/getting-started.md

  - User Guide:
      - Distance Computation: user-guide/distance-computation.md
      - Command Line Interface: user-guide/cli.md

  - Tutorials:
      - Overview: tutorials/index.md
      - Basic Distance Computation: tutorials/basic-distance-computation.md
      - Working with Tasks: tutorials/working-with-tasks.md
      - Performance Optimization: tutorials/performance-optimization.md

  - API Reference:
      - Data Module: api/data.md
      - Distance Module: api/distance.md
      - Features Module: api/features.md
      - Pipeline Module: api/pipeline.md

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  font:
    text: Inter
    code: JetBrains Mono

  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.path
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - toc.follow
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - search.highlight

  favicon: assets/images/logo-black.svg
  logo: assets/images/logo-white.svg

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

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.mark
  - pymdownx.critic
  - pymdownx.keys

watch:
  - themap/

plugins:
  - search

  - mkdocstrings:
      handlers:
        python:
          setup_commands:
            - import sys
            - sys.path.append("docs")
            - sys.path.append("themap")
          options:
            show_root_heading: yes
            heading_level: 3
            show_source: false
            group_by_category: true
            members_order: source
            separate_signature: true
            show_signature_annotations: true
            line_length: 80
            docstring_style: google

  - mkdocs-jupyter:
      execute: False
      include_source: True

  - mike:
      version_selector: true
      css_dir: css
      javascript_dir: js

extra:
  version:
    provider: mike
    default: latest
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/HFooladi/THEMAP
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/themap/
  analytics:
    provider: google
    property: G-XXXXXXXXXX