blank-python-project/mkdocs.yml at main · ThermoPhase-FCSRG/blank-python-project · 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: mypackage's Docs
site_description: A simple MkDocs demonstration
site_url: https://volpatto.github.io/blank-python-project/
site_author: Author's name
repo_url: https://github.com/volpatto/blank-python-project

edit_uri: edit/main/docs/

theme:
  name: "material"
  custom_dir: docs/overrides
  icon:
    repo: github/mark-github-24
  features:
    # For more options, see: https://squidfunk.github.io/mkdocs-material/setup/
    - navigation.instant
    - content.code.copy
    - content.code.annotate
    - content.action.view
    - content.action.edit
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.top
    - navigation.sections
    - navigation.path
    - navigation.tabs  # enable to have nav bar at the top
    - search.highlight
    - search.suggest
    - toc.follow
    - toc.integrate
  palette:
    - scheme: default
      # Toggle buttom dark mode
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      # Toggle buttom light mode
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

markdown_extensions:
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
    # The extension below is important to add custom icons to the template
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - docs/overrides/.icons

extra_css:
  - css/nb-prompts.css  # a trick to hide `In [#]/Out [#]` in ipynb cells

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

plugins:
  - search
  - monorepo
  - mkdocstrings:
      handlers:
            python:
              paths: [src]
              options:
                docstring_style: sphinx
                heading_level: 2
                parameter_headings: false
                show_root_heading: true
                show_symbol_type_heading: true
                show_symbol_type_toc: false
  - mkdocs-jupyter:
      include: ["**/*.ipynb"]
      execute: false
      include_requirejs: true
      include_source: True
      ignore_h1_titles: True  # Disable this if you want to get page title from h1 header in ipynb
  - autorefs:
      resolve_closest: true


# Define the navigation bar
nav:
  - General:
    - Home page: index.md
    - Background: background.md
    - API Reference: reference.md
  - Notebooks:
    - Overview: notebooks.md
    - Tutorials: '!include ./notebooks/mkdocs.yml'