mkdocs.yml

site_name: QuaSi Software

version: 2

build:
  os: "ubuntu-20.04"
  tools:
    python: "3.7"

# Explicitly set the version of Python and its requirements
python:
  version: 2 # for unicode
  setup_py_install: true
  install:
    - requirements: docs/requirements.txt

# set theme
theme: readthedocs

# activate markdown math for latex 
markdown_extensions:
  - mdx_math
  - footnotes 
  - attr_list
  - abbr
  - pymdownx.snippets:
        auto_append:
            - includes/abbreviations.md

extra_javascript: ['https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML']

# navigation
# Mkdocs readthedocs theme supports only one sub layer in navigation
# should now support more than one sub layer with updated version, but structure of 
# navigation is not working properly --> changed back to former version
nav:
  - Home:
      - 'QuaSi - Overview': 'index.md'
  - 'ReSiE: Simulation engine':
      - 'Installation and usage': 'resie_installation.md'
      - 'Input file format': 'resie_input_file_format.md'
      - 'Time, time zones and weather files': 'resie_time_definition.md'
      - 'Logging': 'resie_logging.md'
      - 'Component parameters': 'resie_component_parameters.md'
  - 'ReSiE: Simulation model':
      - 'Fundamentals': 'resie_fundamentals.md'
      - 'Energy systems': 'resie_energy_systems.md'
      - 'Operation and control': 'resie_operation_control.md'
      - 'Energy system components': 'resie_energy_system_components.md'
      - 'General effects & traits': 'resie_transient_effects.md'
      - 'Validation': 'resie_validation.md'
  - 'ReSiE: Examples':
      - 'Exemplary Energy Systems': 'resie_exemplary_energy_systems.md'
  - 'GenSim: Generic Building Simulation':
      - 'User manual': 'gensim_user_manual.md'
  - Contributions:
      - 'How to help': 'contributions.md'
      - 'Working on the documentation': 'changing_documentation.md'
      - 'Workflow for code contributions': 'workflow_code_contributions.md'
  - Abbreviations:
      - 'abbreviations_list.md'
  - About:
      - 'License': 'license.md'