lonkit/mkdocs.yml at main · helix-agh/lonkit · 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
site_name: lonkit
site_description: lonkit is a Python library for constructing, analyzing, and visualizing Local Optima Networks (LONs) for continuous and discrete optimization and fitness landscape analysis.
site_author: HELIX AGH
site_url: https://helix-agh.github.io/lonkit

repo_name: helix-agh/lonkit
repo_url: https://github.com/helix-agh/lonkit

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            heading_level: 2
            members_order: source
            show_signature_annotations: true
            separate_signature: true

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

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
      - Core Concepts: getting-started/concepts.md
  - User Guide:
      - Sampling: user-guide/sampling.md
      - Analysis: user-guide/analysis.md
      - Visualization: user-guide/visualization.md
      - Discrete Problems: user-guide/discrete.md
      - Examples: user-guide/examples.md
  - API Reference:
      - Overview: api/index.md
      - LON: api/lon.md
      - Sampling: api/sampling.md
      - Step Size: api/step_size.md
      - Discrete: api/discrete.md
      - Visualization: api/visualization.md
  - Contributing: contributing.md

extra:
  # Google Search Console verification token (HTML tag method), e.g. "abc123...".
  # Rendered as <meta name="google-site-verification"> when set.
  google_site_verification: ""
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/helix-agh/lonkit
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/lonkit/

copyright: Copyright &copy; 2025-2026 AGH University of Kraków