Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
eclipse
GitHub Repository: eclipse/sumo
 Path: blob/main/docs/web/mkdocs.yml
169666 views
1
site_name: SUMO Documentation

2
site_url: https://sumo.dlr.de/docs/

3
repo_url: https://github.com/eclipse-sumo/sumo/

4
edit_uri: edit/main/docs/web/docs/

5
site_description: SUMO Documentation

6
use_directory_urls: false

7
dev_addr: 127.0.0.1:8000

8
#docs_dir: docs

9
#site_dir: site

10
copyright: "Copyright © 2001-2025 German Aerospace Center (DLR) and others."

11


12
nav:

13
  - Documentation: index.md

14
  - Tutorials: Tutorials/index.md

15
  - FAQ: FAQ.md

16
  - Downloads: Downloads.md

17
  - Publications: Publications.md

18
  - Developer: Developer/index.md

19
  - ChangeLog: ChangeLog.md

20
  - Contact: https://eclipse.dev/sumo/contact/

21


22
theme:

23
  name: mkdocs

24
  custom_dir: theme/

25
  shortcuts:

26
    help: 191     # ?

27
    search: 83    # s

28
    edit: 69      # e

29


30
validation:

31
  links:

32
    absolute_links: ignore #info

33
    anchors: warn

34
    unrecognized_links: warn

35


36
plugins:

37
  - git-revision-date:

38
      as_datetime: true

39
  - unused_files:

40
      dir: images

41
      excluded_files:

42
        - apple-touch-icon.png

43
        - favicon.ico

44
        - image-facebook.jpg

45
        - mkdocs-grid.png

46
        - sumo-logo.png

47
        - sumo-logo.svg

48
  - macros

49
  - pub-debugger:

50
      console_log:

51
        enabled: true

52
        log_level: WARNING

53
  - redirects:

54
      redirect_maps:

55
          "ChangeLog/index.md" : "ChangeLog.md"

56
          "Contact.md" : "https://eclipse.dev/sumo/contact/"

57
#  - spellcheck:

58
#      backends:  # the backends you want to use

59
#      - codespell:  # or nested configs

60
#          dictionaries: [clear, rare]

61
#      # known_words can also be a list of words

62
#      known_words: known_words.txt

63
#      # ignore words in <code> tags

64
#      ignore_code: yes

65
#      # minimum length of words to consider

66
#      min_length: 2

67
#      # maximum number of capital letters in a word

68
#      max_capital: 1

69
#      # keep unicode characters

70
#      allow_unicode: no

71
#      # whether to only check in strict mode

72
#      strict_only: yes

73
#      skip_files:

74
#      - DiplomStudArb.md

75
#      - Tools/Import/VISSIM.md

76


77
markdown_extensions:

78
  - attr_list

79
  - admonition

80
  - pymdownx.tilde

81
  - meta

82
  - pymdownx.keys

83
  - footnotes

84
  - mdx_truly_sane_lists:

85
      nested_indent: 2

86
      truly_sane: true

87
  - pymdownx.tasklist:

88
      custom_checkbox: true

89
  - toc:

90
      permalink: "#"

91
      separator: "_"

92
      baselevel: 1

93
  - pymdownx.magiclink:

94
      provider: github

95
  - mdx_gh_links:

96
      user: eclipse-sumo

97
      repo: sumo

98
  - plantuml_markdown

99
  - codehilite

100


101
extra:

102
    Version: 1.24.0

103
    ReleaseDate: 22.07.2025

104
    DOI: "10.5281/zenodo.13907886"

105


106
    AdditionalFile: '[*additional-file*](/docs/sumo.html#format_of_additional_files)'

107
    AdditionalFiles: '[*additional-files*](/docs/sumo.html#format_of_additional_files)'

108
    DT_2DBoundingBox: '[*&lt;2D-BOUNDING_BOX&gt;*](/docs/Basics/Notation.html#referenced_data_types)'

109
    DT_2DPosition: '[*&lt;2D-POSITION&gt;*](/docs/Basics/Notation.html#referenced_data_types)'

110
    DT_BOOL: '[*&lt;BOOL&gt;*](/docs/Basics/Notation.html#referenced_data_types)'

111
    DT_Color: '[*&lt;COLOR&gt;*](/docs/Basics/Notation.html#referenced_data_types)'

112
    DT_FILE: '[*&lt;FILE&gt;*](/docs/Basics/Notation.html#referenced_data_types)'

113
    DT_FLOAT: '[*&lt;FLOAT&gt;*](/docs/Basics/Notation.html#referenced_data_types)'

114
    DT_IDList: '[*&lt;ID&gt;*](/docs/Basics/Notation.html#referenced_data_types)'

115
    DT_INT: '[*&lt;INT&gt;*](/docs/Basics/Notation.html#referenced_data_types)'

116
    DT_NET: '[*&lt;NETWORK_FILE&gt;*](/docs/Basics/Notation.html#referenced_data_types)'

117
    DT_PATH: '[*&lt;PATH&gt;*](/docs/Basics/Notation.html#referenced_data_types)'

118
    DT_PROJ_DEF: '[*&lt;PROJ_DEFINITION&gt;*](/docs/Basics/Notation.html#referenced_data_types)'

119
    DT_Routes: '[*&lt;ROUTES_FILE&gt;*](/docs/Basics/Notation.html#referenced_data_types)'

120
    DT_STR: '[*&lt;STRING&gt;*](/docs/Basics/Notation.html#referenced_data_types)'

121
    DT_STR_LIST: '[*&lt;STRING&lbrack; &rbrack;&gt;*](/docs/Basics/Notation.html#referenced_data_types)'

122
    DT_TIME: '[*&lt;TIME&gt;*](/docs/Basics/Notation.html#referenced_data_types)'

123
    Outdated: '<div style="background: #801010; padding: .5em; border: 1px dashed #ffcc44; margin-right:10px; margin-left:10px; color: #ffffff">This information is outdated.</div>'

124
    Source: 'https://github.com/eclipse-sumo/sumo/blob/main/'

125
    SUMO: '***&lt;SUMO_HOME&gt;***'

126
    SUMOUSERConference: '[SUMO User Conference](https://eclipse.dev/sumo/conference)'

127


128