pyarud/mkdocs.yml at main · cnemri/pyarud · 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
site_name: PyArud (بيعروض)
site_description: The comprehensive Python library for Arabic prosody (Arud) analysis, featuring deep theoretical documentation and robust processing.
site_url: https://cnemri.github.io/pyarud/
repo_url: https://github.com/cnemri/pyarud
repo_name: pyarud

theme:
  name: material
  features:
    - content.code.copy
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: lime
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: google
            show_root_heading: true
            show_source: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: installation.md
      - Quick Start: quickstart.md
  - Arudh Theory (علم العروض):
      - Introduction & History: theory/introduction.md
      - The Foundation (Components): theory/components.md
      - Arudi Writing (الكتابة العروضية): theory/writing.md
  - The Meters (البحور): meters.md
  - Modifications (الزحافات والعلل): zihafs.md
  - Technical Architecture: architecture.md
  - Tutorials:
      - First Analysis: tutorials/first_analysis.md
      - Debugging Poetry: tutorials/debugging.md
  - Cookbook: cookbook.md
  - API Reference: api.md