aboutsummaryrefslogtreecommitdiff
path: root/mkdocs.yml
blob: 98b3557e1aa6f853af96b48f8060f05f7a060229 (plain)
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
site_name: ArGaze documentation
nav:
- index.md
- Getting Started:
  - getting_started/installation.md
  - getting_started/ready-made.md
  - getting_started/demos.md
- Code Reference:
  - argaze.md
- Contributor's Guide:
  - contributor_guide/build_documentation.md
  - contributor_guide/unitary_test.md
theme:
  name: readthedocs
  palette:
    primary: #0299D2
extra_css:
  - css/extra.css
plugins:
  - search
  - autorefs
  - include-markdown
  - mkdocstrings:
      handlers:
        # See: https://mkdocstrings.github.io/python/usage/
        python:
          options:
            docstring_style: google
            allow_inspection: false
            show_source: false
            members_order: 'alphabetical'
            heading_level: 2
            annotations_path: brief
            show_submodules: true
            show_root_toc_entry: false
watch:
  - src/argaze
markdown_extensions:
  - markdown_include.include:
      base_path: .
  - attr_list
  - admonition