oct2py/mkdocs.yml at main · blink1073/oct2py · 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
site_name: Oct2Py
site_description: Python to GNU Octave Bridge
repo_url: https://github.com/blink1073/oct2py
repo_name: blink1073/oct2py

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.top
    - content.code.copy
  palette:
    - scheme: default
      primary: indigo
      accent: indigo

plugins:
  - search
  - mkdocs-jupyter:
      include: ["*.ipynb"]
      execute: false
      ignore_h1_titles: true
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            show_source: true
            members_order: source
            show_root_heading: true
            show_category_heading: true
            show_signature_annotations: true

markdown_extensions:
  - pymdownx.snippets:
      base_path: ["."]

nav:
  - Home: index.md
  - Installation: installation.md
  - Demo: demo.md
  - Examples: examples.md
  - Type Conversions: conversions.md
  - Example Notebook: notebook.ipynb
  - Configuration: settings.md
  - API Reference: api.md
  - Information: info.md