pydoc-markdown.yml

##
## Copyright (c) 2024 Hannah contributors.
##
## This file is part of hannah.
## See https://github.com/ekut-es/hannah for further info.
##
## 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.
##
loaders:
  - type: python
    search_path: ["."]
processors:
  - type: filter
  - type: smart
  - type: crossref

hooks:
  pre-render:
    - mkdir -p build/docs/content
    - cp -r doc/assets build/docs/content

renderer:
  type: mkdocs
  pages:
    - title: Home
      name: index
      source: README.md
    - title: Fallacies and Pitfalls
      name: fallacies
      source: doc/fallacies.md
    - title: Publications
      name: publications
      source: doc/publications.md
    - title: Experiment Management
      name: experiments
      source: doc/experiments.md
    - title: Configuration
      name: configuration
      children:
        - title: Overview
          name: configuration/overview
          source: doc/configuration/configuration.md
        - title: Multi-GPU support
          name: configuration/multi_gpu
          source: doc/configuration/multi_gpu.md

    - title: Compression
      children:
      - title: Quantization
        name: compression/quantization
        source: doc/compression/quantization.md
      - title: Pruning
        name: compression/pruning
        source: doc/compression/pruning.md
      - title: Clustering
        name: compression/clustering
        source: doc/compression/clustering.md
      - title: Tensor Decompositions
        name: compression/decomposition
        source: doc/compression/decomposition.md
      - title: Knowledge Distillation
        name: compression/knowledge_distillation
        source: doc/compression/knowledge_distillation.md
    - title: Optimization
      children:
        - title: Hyperparameter Optimization
          name: optimization/hyperparameter
          source: doc/optimization/hyperparameters.md
    - title: Neural Architecture Search
      children:
        - title: NAS (Legacy)
          name: nas/legacy
          source: doc/nas/legacy.md
        - title: Usage
          name: nas/usage
          source: doc/nas/usage.md
        - title: Search Spaces
          name: nas/search_spaces
          source: doc/nas/search_spaces.md
        - title: Parametrization
          name: nas/parametrization
          source: doc/nas/parametrization.md
        - title: Search
          name: nas/search
          source: doc/nas/search.md
        - title: Evaluating Results
          name: nas/eval
          source: doc/nas/eval.md
        - title: Optimization Metrics
          name: nas/metrics
          source: doc/nas/metrics.md
    - title: Deployment
      children:
        - title: Overview
          name: deployment/overview
          source: doc/deployment/overview.md
        - title: Torch Mobile
          name: deployment/torchmobile
          source: doc/deployment/torchmobile.md
        - title: T-Rax Ultratrail
          name: deployment/trax-Ultratrail
          source: doc/deployment/ultratrail.md
        - title: TVM
          name: deployment/tvm
          source: doc/deployment/tvm.md
        - title: TensorRT
          name: deployment/tensorrt
          source: doc/deployment/tensorrt.md
    - title: "Evaluation"
      children:
        - title: "Evaluation"
          name: eval
          source: doc/eval.md
    - title: "applications"
      children:
        - title: Seizure Detection
          name: applications/seizure_detection
          source: doc/applications/seizure_detection.md
        - title: Viterbi Decoding
          name: applications/viterbi_decoding
          source: doc/applications/viterbi_decoding.md
    - title: Development
      children:
        - title: Overview
          name: devel/overview
          source: doc/devel/overview.md
        - title: Debugging
          name: devel/debugging
          source: doc/devel/debugging.md
        - title: Profiling
          name: devel/profiling
          source: doc/devel/profiling.md
        - title: API Documentation
          name: devel/api
          contents:
            - 'hannah.*'


  mkdocs_config:
    site_name: HANNAH
    theme: readthedocs
    markdown_extensions:
      - def_list
      - admonition
      - codehilite
      - pymdownx.arithmatex:
          generic: true
    extra_javascript:
      - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js