impresso-py/mkdocs.yml at 30ebdd8c4e6608482ae8cddfdb8005a3cf4b2539 · impresso/impresso-py · 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
site_name: "Impresso"

theme:
  name: "readthedocs"

plugins:
- search
- mkdocstrings:
    handlers:
      python:
        options:
          show_docstring_description: true
          allow_inspection: true
          show_signature: true
          show_source: false
          show_root_heading: true
          heading_level: 3
          docstring_style: google
          docstring_section_style: table
          annotations_path: brief
          docstring_options:
            ignore_init_summary: false
            trim_doctest_flags: true

markdown_extensions:
- toc
- tables
- admonition
- pymdownx.details  # Optional: allows for collapsible blocks
# - pymdownx.superfences  # Recommended: allows nesting code blocks inside banners

nav:
  - Home: index.md
  - Jupyter Notebook Guide: jupyter_guide.md
  - Result Object: result.md
  - Resources: resources.md
  - Preparing Queries: preparing_queries.md