GSP/mkdocs.yml at master · vispy/GSP · 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
111
112
113
114
115
116
117
# To debug:
#   griffe dump gsp -o/dev/null -LDEBUG
#   mkdocs -v
# See also https://github.com/mkdocstrings/mkdocstrings/issues/451
#
# To build (with bash script execution):
#   export MARKDOWN_EXEC_AUTO=bash; mkdocs build

site_name: Graphic Server Protocol
use_directory_urls: false
repo_url: https://github.com/vispy/gsp
remote_name: origin # For mkdocs gh-deploy
docs_dir: 'docs'

theme:
  name: material
  features:
    - content.code.copy
    - navigation.tabs
    - navigation.tabs.sticky
extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - def_list
  - attr_list
  - md_in_html
  - admonition
  - codehilite
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      check_paths: true
      base_path: ["docs/snippets", "."]
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

plugins:
# - section-index
#  - search
  - markdown-exec
  - autorefs
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            annotations_path: brief
            docstring_style: numpy
            group_by_category: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docstring_section_style: table
            docstring_options:
              ignore_init_summary: false
            merge_init_into_class: true
            show_submodules: yes
            show_root_heading: true
            show_source: false
            show_bases: false
            show_root_full_path: false
            show_signature_annotations: yes
            inherited_members: true
            separate_signature: yes

nav:
 - Overview:
   - index.md
 - Gallery:
   - gallery/canvas-viewport.md
   - gallery/pixels-points-markers.md
 - Implementations:
   - Python:
     - python/command.md
     - python/memory.md
     - python/glm.md
 - Specifications:
   - Core:
     - api/core/canvas.md
     - api/core/viewport.md
     - api/core/data.md
     - api/core/buffer.md
     - api/core/types.md
   - Transform:
     - api/transform/transform.md
     - api/transform/operators.md
     - api/transform/accessors.md
     - api/transform/measures.md
     - api/transform/out.md
     - api/transform/colormap.md
     - api/transform/light.md
   - Visual:
     - api/visual/pixels.md
     - api/visual/points.md
     - api/visual/markers.md
     - api/visual/segments.md
     - api/visual/paths.md