PyHOPE/mkdocs.yml at main · NumathUPM/PyHOPE · 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
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This file is part of PyHOPE
#
# Copyright (c) 2024 Numerics Research Group, University of Stuttgart, Prof. Andrea Beck
#
# PyHOPE is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# PyHOPE is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with
# PyHOPE. If not, see <http://www.gnu.org/licenses/>.
# ==================================================================================================================================
# Mesh generation library
# ==================================================================================================================================

# General settings
site_name: PyHOPE
site_url: https://hopr-framework.github.io/PyHOPE
repo_url: https://github.com/hopr-framework/PyHOPE
site_description: PyHOPE documentation
site_author: Numerics Research Group (NRG), University of Stuttgart
copyright: Copyright &copy; 2025, <a href="https://numericsresearchgroup.org/team.html">Numerics Research Group</a>
edit_uri: ""  # Disable "Edit on GitHub", just link to the repository

# Visual settings
theme:
  name: mkdocs
  user_color_mode_toggle: true
  locale: en
  highlightjs: true

# Navigation settings
nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - User Guide:
    - Introduction: user-guide/index.md
    - Installation: user-guide/installation.md
    - Library Usage: user-guide/library_usage.md
    - Mesh Generators:
      - Internal: user-guide/mesh-generators/internal.md
      - External: user-guide/mesh-generators/external.md
    - Parameter File Format: user-guide/parameter-file.md
  # - Issue Tracker: 'https://github.com/hopr-framework/PyHOPE/issues'
  - Developer Guide:
    - Introduction: developer-guide/index.md
    - GitHub Workflow: developer-guide/github-workflow.md
    - Environment Setup: developer-guide/get-the-source.md
    - Style Guide: developer-guide/style-guide.md
  - Mesh Format: mesh-format.md
  - About:
    - Authors: 'AUTHORS.md'
    - Changelog: 'CHANGELOG.md'
    - Code of Conduct: 'CODE_OF_CONDUCT.md'
    - Contributing: 'CONTRIBUTING.md'
    - License: 'LICENSE.md'

# CSS settings
extra_css:
  - css/extra.css

# Plugin settings
plugins:
  - search
  # - autorefs
  # Image zoom
  - glightbox

# Markdown settings
markdown_extensions:
  # Footnotes
  - footnotes
  # Table of contents (links to headings)
  - toc:
      permalink: true
  # Tables (enabled by default)
  - tables
  # Code blocks
  - pymdownx.highlight:
      anchor_linenums: true
      guess_lang: false
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  # Math equations
  - pymdownx.arithmatex:
      generic: true
  # Adminition (callouts)
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  # Attribute lists
  - attr_list
  # Images support
  - md_in_html
  - pymdownx.blocks.caption

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