mkdocs.yml

# See the NOTICE file distributed with this work for additional information
# regarding copyright ownership.
#
# 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.

site_name: Ensembl-GenomIO
site_url: https://ensembl.github.io/ensembl-genomio
site_description: Pipelines to turn basic genomic data into Ensembl cores and back.

repo_url: https://github.com/Ensembl/ensembl-genomio
repo_name: Ensembl/ensembl-genomio

copyright: Copyright &copy; [2016-<script>document.write(new Date().getFullYear())</script>] <a href="https://www.ebi.ac.uk">EMBL-European Bioinformatics Institute</a>

theme:
  name: "material"
  logo: img/ensembl-logo.png
  icon:
    repo: fontawesome/brands/github
  palette:
    scheme: ensembl
  font:
    text: Lato
    code: IBM Plex Mono
  features:
      - content.tooltips
      - navigation.top
      - search.highlight
      - search.suggest
      - toc.follow
extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - toc:
      permalink: true

plugins:
- search
- gen-files:
     scripts:
     - docs/scripts/gen_ref_pages.py
- literate-nav:
    nav_file: summary.md
- section-index
- mkdocstrings:
    enabled: !ENV [ENABLE_MKDOCSTRINGS, true]
    default_handler: python
    handlers:
      python:
        paths: [src]
        options:
          filters: ["!^_"]
          show_if_no_docstring: true
          show_root_heading: true
          show_source: true
          show_symbol_type_heading: true
          show_symbol_type_toc: true

nav:
  - Home: index.md
  - Install: install.md
  - Usage: usage.md
  - Code of Conduct: code_of_conduct.md
  - Code Reference: reference/
  - Running Nextflow: nextflow.md
  - Ensembl-Genomio Pipelines: pipelines.md