mkdocs.yml

# Project information
site_name: iCal-library
site_url: https://jorricks.github.io/iCal-library
site_author: Jorrick Sleijster
site_description: ICal Reader - Fast, yet simple, iCalendar reader with excellent recurrence support

# Repository
repo_name: jorricks/iCal-library
repo_url: https://github.com/jorricks/iCal-library


# Copyright
copyright: Copyright © 2022 Jorrick Sleijster

# Configuration
theme:
  icon:
    logo: material/calendar-heart
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

# Plugins
plugins:
  - search
  - termynal
  - autorefs
  - mkdocstrings:
      enable_inventory: true
      handlers:
        python:
          import:
          - https://docs.python.org/3/objects.inv
          - https://dateutil.readthedocs.io/en/stable/objects.inv
# Unfortunately pendulum does not offer an objects.inv as of now:
# https://github.com/sdispater/pendulum/issues/190
          options:
            filters:
              - "!__repr__"
              - "!__eq__"
            annotations_path: brief
            show_root_heading: true
            show_root_full_path: false
            docstring_style: sphinx
            show_signature_annotations: false
            show_source: true
            docstring_options:
              ignore_init_summary: yes

# Customization
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Jorricks/iCal-library
    - icon: fontawesome/brands/python
      link: https://pypi.org/user/jorricks/
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/jorricks/

# Extensions
markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.details
  - pymdownx.superfences

# Page tree
nav:
  - Home: index.md
  - User guide:
      - Remote iCalendar: remote-icalendars.md
      - Timeline: timeline.md
  - Code documentation:
      - Client: code/client.md
      - Cached Client: code/cache_client.md
      - Calendar: code/calendar.md
      - Timeline: code/timeline.md
      - Components:
          - Base classes: code/components/base_class.md
          - Simple components: code/components/simple_components.md
          - Recurring components: code/components/recurring_components.md
          - Timezone components: code/components/timezone_components.md
      - Properties:
          - Base classes: code/properties/base_class.md
          - Property classes: code/properties/all_properties.md
          - Property helper classes: code/properties/help_classes.md
      - Exceptions: code/exceptions.md
  - Frequently asked questions: faq.md
  - Release notes: release-notes.md