mkdocs.yml 1.87 KB
Newer Older
1
site_name: Unified Ticketing Docs
Lukas Wiest's avatar
Lukas Wiest committed
2

3
4
docs_dir: docs
edit_uri: 'blob/master/docs/'
5
repo_name: 'Code on Transfer Portal'
Lukas Wiest's avatar
Lukas Wiest committed
6
repo_url: 'https://transfer.hft-stuttgart.de/gitlab/9Lukas5/unified-ticketing'
Lukas Wiest's avatar
Lukas Wiest committed
7

8
copyright: 'Copyright © 2020 University for Applied Sciences Stuttgart'
Lukas Wiest's avatar
Lukas Wiest committed
9

Lukas Wiest's avatar
Lukas Wiest committed
10
11
12
13
14
use_directory_urls: false

nav:
  - Home:
    - Index: 'index.md'
15
16
17
18
19
20
21
22
23
24
25
26
    - Changelog: 'unified-ticketing/changelog-softlink.md'
    - Usage: 'unified-ticketing/usage.md'
    - Contributing: 'unified-ticketing/contributing.md'
    - License: 'unified-ticketing/license-softlink.md'
  - API:
    - Index: 'api/index.md'
    - Core:
      - Logging: 'api/core/logging.md'
      - Ticket: 'api/core/ticket.md'
      - Ticketsystem: 'api/core/ticket-system.md'
    - Exceptions: 'api/exceptions.md'
    - Systems:
27
28
29
        - GitHub:
          - Ticket: 'api/systems/github/ticket.md'
          - Ticketsystem: 'api/systems/github/ticket-system.md'
30
31
32
33
        - GitLab:
          - Ticket: 'api/systems/gitlab/ticket.md'
          - Ticketsystem: 'api/systems/gitlab/ticket-system.md'
  - Developers Guide:
34
    - Machine Setup: 'developers-guide/machine-setup.md'
35
    - Styleguide: 'developers-guide/styleguide.md'
36
    - UML Diagram: 'developers-guide/uml.md'
37
    - Workflow: 'developers-guide/workflow.md'
Lukas Wiest's avatar
Lukas Wiest committed
38
39

theme:
40
41
42
43
44
  features:
    - navigation.tabs
  icon:
    logo: material/book-open
  language: 'en'
Lukas Wiest's avatar
Lukas Wiest committed
45
46
  name: 'material'
  palette:
47
48
    accent: 'blue'
    primary: 'red'
Lukas Wiest's avatar
Lukas Wiest committed
49
50

markdown_extensions:
51
  - admonition
52
  - attr_list
53
  - footnotes
54
  - markdown_del_ins
55
56
  - plantuml_markdown:
      format: svg
57
      server: http://plantuml.com/plantuml
58
  - pymdownx.details
59
60
61
62
63
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight:
      linenums: true
64
  - pymdownx.superfences
65
66
67
68
69
  - pymdownx.tabbed
  - pymdownx.tasklist
  - toc:
      permalink: True
  - tables