Soundscapy/mkdocs.yml at main · MitchellAcoustics/Soundscapy · 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
118
119
120
121
122
123
124
125
126
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: "Soundscapy"
site_url: https://soundscapy.readthedocs.io/en/latest/
site_dir: site
site_author: "Andrew Mitchell"
site_description: "Documentation website for Soundscapy"
repo_name: "MitchellAcoustics/Soundscapy"
repo_url: https://github.com/MitchellAcoustics/Soundscapy
copyright: Copyright &copy; 2025 Andrew Mitchell

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

nav:
  - Home: index.md
  - About:
      - "License": license.md
  - Tutorials:
      - tutorials/index.md
      - "Quick Start": tutorials/QuickStart.ipynb
      - "Quick Start pt. 2": tutorials/0_QuickStart_for_Beginners.ipynb
      - "Understanding Soundscape Analysis": tutorials/1_Understanding_Soundscape_Analysis.ipynb
      - "Working with Soundscape Survey Data": tutorials/2_Working_with_Soundscape_Survey_Data.ipynb
      - "Advanced Visualization Techniques": tutorials/3_Advanced_Visualization_Techniques.ipynb
      - "The Soundscape Perception Index (SPI)": tutorials/SoundscapePerceptionIndex-SPI.ipynb
      - "Using Soundscapy for Binaural Recording Analysis": tutorials/BinauralAnalysis.ipynb
      - "How To Analyse and Represent Soundscape Perception": tutorials/HowToAnalyseAndRepresentSoundscapes.ipynb
  - "API reference":
      - "Core": reference/api.md
      - "Survey Analysis": reference/surveys.md
      - "Plotting":
          - reference/plotting.md
          - reference/plotting/plot_functions.md
          - reference/plotting/iso_plot.md
          - reference/plotting/likert.md
          - reference/plotting/param_models.md
          - reference/plotting/layers.md
          - reference/plotting/plot_context.md
          - reference/plotting/defaults.md
      - "Soundscape Perception Index (SPI)":
          - reference/spi.md
          - reference/spi/msn.md
      - "Binaural Analysis": reference/audio.md
      - "Databases": reference/databases.md
  - "News":
      - news.md
      - "Changelog": CHANGELOG.md

theme:
  name: material
  #  logo: img/DarkLogo.png
  features:
    - navigation.tabs
    - navigation.expand
    - navigation.path
    - navigation.top
    - content.action.edit
  icon:
    repo: fontawesome/brands/github
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

extra_css:
  - stylesheets/extra.css
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [.]
          options:
            docstring_section_style: spacy
            docstring_style: "numpy"
            separate_signature: true
            show_if_no_docstring: false
            merge_init_into_class: true
            show_symbol_type_heading: true # waiting for general release
            show_symbol_type_toc: true
            modernize_annotations: true
            summary: true
          inventories:
            - "https://docs.python.org/3/objects.inv"
  - include-markdown:
      opening_tag: "{!"
      closing_tag: "!}"
  - mkdocs-jupyter:
      include_source: true
      theme: default
#        execute: true

markdown_extensions:
  - admonition
  - pymdownx.tasklist
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - javascripts/katex.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js

extra:
  social:
    - icon: fontawesome/brands/github
      link: "https://github.com/MitchellAcoustics"