mkdocs.yml

# Copyright (c) 2021 Abhishek Thakur(@abhiTronix) <abhi.una12@gmail.com>

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

#    http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Project information
site_name: DeFFcode
site_url: https://abhitronix.github.io/deffcode/
site_author: Abhishek Thakur
site_description: >-
  A High-performance Real-time Video frames Generator for generating blazingly fast video frames in python 🔥

# Repository
repo_name: abhiTronix/deffcode
repo_url: https://github.com/abhiTronix/deffcode
edit_uri: edit/master/docs/

# Copyright
copyright: Copyright &copy; 2021 Abhishek Thakur(@abhiTronix)

# Configuration
theme:
  name: material
  custom_dir: docs/overrides

  # Default values, taken from mkdocs_theme.yml
  language: en
  features:
    - announce.dismiss
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.top
    - navigation.tracking
    - search.suggest
    - search.highlight
    - search.share
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - content.footnote.tooltips
    - content.action.view
    - content.action.edit
    - content.tooltips
    - toc.follow
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: light green
      accent: green
      toggle:
        icon: fontawesome/regular/lightbulb
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: amber
      accent: lime
      toggle:
        icon: fontawesome/solid/lightbulb
        name: Switch to light mode
  font: # font
    text: Libre Franklin
    code: JetBrains Mono
  icon: # icon
    logo: logo
  logo: assets/images/android-chrome-192x192.png
  favicon: assets/images/favicon-32x32.png
  # 404 page
  static_templates:
    - 404.html

# Plugins
plugins:
  - search
  - git-revision-date-localized
  - minify:
      minify_html: true
  - mkdocstrings:
      handlers:
        python:
          options:
            show_root_heading: false
            show_root_toc_entry: false
            show_source: true
            heading_level: 3
  - exclude:
      glob:
        - overrides/assets/README.md

# Customization
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/abhiTronix
    - icon: fontawesome/brands/gitter
      link: https://gitter.im/deffcode-python/community
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/abhishek-abhitronix/
    - icon: fontawesome/brands/dev
      link: https://dev.to/abhitronix
  version:
    provider: mike
    default: latest
  analytics: # Google analytics
    provider: google
    property: G-XMZCQ3KBNJ
extra_css:
  - assets/stylesheets/custom.css
extra_javascript:
  - assets/javascripts/extra.js

# Logging
validation:
  unrecognized_links: ignore

# Extensions
markdown_extensions:
  - admonition
  - abbr
  - tables
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - meta
  - toc:
      permalink: true
      permalink_title: Anchor link to this section for reference
  - codehilite:
      guess_lang: false
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: abhiTronix
      repo: deffcode
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.striphtml:
      strip_comments: true
  - pymdownx.magiclink

# Page tree
nav:
  - Home:
      - Introduction:
          - Introduction: index.md
      - Installation Notes:
          - Overview: installation/index.md
          - FFmpeg Installation: installation/ffmpeg_install.md
      - Contribution Guidelines:
          - Overview: contribution/index.md
          - Issue Guidelines: contribution/issue.md
          - Pull Request(PR) Guidelines: contribution/PR.md
      - Changelog: changelog.md
      - License: license.md
  - Recipies:
      - Basic Recipes:
          - Overview: recipes/basic/index.md
          - Decoding Video Files: recipes/basic/decode-video-files.md
          - Decoding Camera Devices: recipes/basic/decode-camera-devices.md
          - Decoding Network Streams: recipes/basic/decode-network-streams.md
          - Decoding Image sequences: recipes/basic/decode-image-sequences.md
          - Transcoding Live frames: recipes/basic/transcode-live-frames.md
          - Transcoding Live Simple Filtergraphs: recipes/basic/transcode-live-frames-simplegraphs.md
          - Saving Key-frames as Image: recipes/basic/save-keyframe-image.md
          - Extracting video metadata: recipes/basic/extract-video-metadata.md
      - Advanced Recipies:
          - Overview: recipes/advanced/index.md
          - Decoding Live Virtual Sources: recipes/advanced/decode-live-virtual-sources.md
          - Decoding Live Feed Devices: recipes/advanced/decode-live-feed-devices.md
          - Hardware-Accelerated Video Decoding: recipes/advanced/decode-hw-acceleration.md
          - Transcoding Live Complex Filtergraphs: recipes/advanced/transcode-live-frames-complexgraphs.md
          - Transcoding Video Art with Filtergraphs: recipes/advanced/transcode-art-filtergraphs.md
          - Hardware-Accelerated Video Transcoding: recipes/advanced/transcode-hw-acceleration.md
          - Updating Video Metadata: recipes/advanced/update-metadata.md
  - API References:
      - deffcode.FFdecoder:
          - API: reference/ffdecoder/index.md
          - API Parameters: reference/ffdecoder/params.md
      - deffcode.Sourcer:
          - API: reference/sourcer/index.md
          - API Parameters: reference/sourcer/params.md
      - deffcode.ffhelper: reference/ffhelper.md
      - deffcode.utils: reference/utils.md
  - Help Section:
      - Help Us: help.md
      - Get Help: help/get_help.md