gutensearch/mkdocs.yml at main · yanniskatsaros/gutensearch · 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
site_name: gutensearch
site_description: gutensearch Documentation
site_author: Yannis Katsaros
site_dir: public
docs_dir: docs
dev_addr: 0.0.0.0:8000 # used to serve docs from Docker

nav:
  - Home: index.md
  - Reference:
    - cli.py: api/cli.md
    - database.py: api/database.md
    - download.py: api/download.md
    - parse.py: api/parse.md

theme:
  name: material
  include_search_page: false
  palette:
    scheme: default
    primary: blue grey
    accent: light blue
  icon:
    repo: fontawesome/brands/github
    logo: fontawesome/solid/book
    favicon: fontawesome/solid/book

extra_css:
  - css/mkdocstrings.css

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          selection:
            filters:
              - "!^__"        # exclude any __ methods
              - "^__init__$"  # but include __init__
          rendering:
            show_if_no_docstring: false

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.keys
  - pymdownx.highlight:
      use_pygments: true
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg