write2audiobook/mkdocs.yml at main · deangelisdf/write2audiobook · 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
site_name: Write2Audiobook
site_description: Project documentation for Write2Audiobook.

repo_url: https://github.com/greg-martinez44/write2audiobook
edit_uri: edit/gh-docs/docs/

theme:
  name: material
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.path
    - navigation.top
    - navigation.indexes

nav:
  - Home: index.md
  - Quick start: quick-start.md
  - User guide:
    - user-guide/index.md
    - Download the scripts: user-guide/download-scripts.md
    - Install libraries: user-guide/install-libraries.md
    - Text files: user-guide/text-to-audio.md
    - Word documents: user-guide/docx-to-audio.md
    - PowerPoint presentations: user-guide/pptx-to-audio.md
    - Ebooks: user-guide/ebook-to-audio.md
  - Reference:
    - reference/index.md
    - backend_audio: reference/backend-audio.md
    - frontend: reference/frontend.md
    - docx2audio: reference/docx2audio.md
    - ebook2audio: reference/ebook2audio.md
    - pptx2audio: reference/pptx2audio.md
    - txt2audio: reference/txt2audio.md
  - About:
    - Release Notes: about/release-notes.md
    - Contributing: about/contributing.md
    - License: about/license.md

copyright: Copyright &copy; 2023 De Angelis Domenico Francesco.

markdown_extensions:
  - admonition
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: true
            docstring_section_style: list
            heading_level: 2
            parameter_headings: true
            docstring_section_style: list
            show_root_heading: true

exclude_docs: how-to-contribute-to-docs.md