open-processing-model/mkdocs.yml at main · eeditiones/open-processing-model · 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
site_name: Open Processing Model
site_description: Convert TEI, Docbook or JATS XML to HTML, PDF, EPUB, Word or Markdown, or publish it as a static website. A Python tool for digital editions, driven by TEI ODD.
site_url: https://opm.e-editiones.org/
repo_url: https://github.com/eeditiones/open-processing-model
repo_name: eeditiones/open-processing-model
edit_uri: edit/main/docs/

theme:
  name: material
  custom_dir: overrides
  variant: classic
  logo: assets/logo.svg
  favicon: assets/logo.svg
  features:
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.instant
    - search.suggest
    - search.highlight
    - content.code.copy
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

extra:
  pypi_url: https://pypi.org/project/open-processing-model/

extra_css:
  - stylesheets/brand.css

extra_javascript:
  - javascripts/slideshow.js

markdown_extensions:
  - admonition
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details

watch:
  - src

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_if_no_docstring: false
            members_order: source
            separate_signature: true
            merge_init_into_class: true
            show_signature_annotations: true
            signature_crossrefs: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quickstart: getting-started/quickstart.md
  - Tutorials:
      - Convert TEI to HTML: tutorials/tei-to-html.md
      - Publish a TEI website: tutorials/tei-website.md
      - Create a PDF from TEI: tutorials/tei-to-pdf.md
      - EPUB and Word from TEI: tutorials/tei-to-epub-word.md
  - Guide:
      - ODD files: guide/odd-files.md
      - Output formats: guide/output-formats.md
      - XPath extensions: guide/xpath-extensions.md
      - Templates & CSS: guide/templates-and-css.md
      - Chunking: guide/chunking.md
      - Search indexing: guide/search-indexing.md
      - ODD coverage: guide/coverage.md
      - ODD documentation: guide/odd-documentation.md
      - Integration with TEI Publisher: guide/tei-publisher.md
      - Configuration (opm.toml): guide/configuration.md
  - CLI Reference: cli.md
  - API Reference:
      - Overview: api/index.md
      - Project: api/project.md
      - transform: api/transform.md
      - chunking: api/chunking.md
      - indexing: api/indexing.md
      - coverage: api/coverage.md
      - spec_index: api/spec-index.md
      - odd_schema: api/odd-schema.md
      - document_site: api/document-site.md
      - config: api/config.md
      - odd_compiler: api/odd-compiler.md
      - output functions: api/output-functions.md
      - output modes: api/output-modes.md
      - typst_compile: api/typst-compile.md
      - runtime: api/runtime.md
  - License: license.md