--- a +++ b/docs/mkdocs.yml @@ -0,0 +1,131 @@ +site_name: BioNeMo Framework +site_url: https://nvidia.github.io/bionemo-framework +repo_url: https://github.com/NVIDIA/bionemo-framework +repo_name: NVIDIA/bionemo-framework + +theme: + name: "material" + custom_dir: overrides + features: + - content.code.annotate + - navigation.tabs + - navigation.indexes + - navigation.instant + - navigation.path + - navigation.instant.prefetch + - navigation.top + - navigation.footer + - search.suggest + - search.highlight + - content.code.copy + font: + code: Roboto Mono + favicon: assets/images/favicon.png + language: en + palette: + - media: "(prefers-color-scheme: light)" + scheme: light + primary: custom + accent: lime + toggle: + icon: material/weather-night + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: dark + primary: custom + accent: lime + toggle: + icon: material/weather-sunny + name: Switch to light mode + icon: + logo: nvidia/nvidia-logo + repo: fontawesome/brands/github + +extra_css: + - assets/css/color-schemes.css + - assets/css/fonts.css + - assets/css/custom-material.css + - assets/css/jupyter-themes.css + +plugins: + - search + - gen-files: + scripts: + - scripts/gen_ref_pages.py + - macros + - mike: + # These fields are all optional; the defaults are as below... + alias_type: copy + redirect_template: null + deploy_prefix: "" + canonical_version: "latest" + version_selector: true + css_dir: "assets/css" + javascript_dir: "assets/js" + - mkdocstrings: + handlers: + python: + paths: + - ../sub-packages/*/src + - mkdocs-jupyter: + theme: auto + highlight_extra_classes: "jupyter-notebook" + remove_tag_config: + remove_input_tags: + - hide-code + - hide_code + - hide-input + - hide_input + - remove_input + - remove-input + remove_cell_tags: + - hide-cell + - hide_cell + - remove-cell + - remove_cell + remove_all_outputs_tags: + - hide-output + - hide_output + - remove-output + - remove_output + - include_dir_to_nav: + file_pattern: '.*\.(md|ipynb)$' + - literate-nav: + nav_file: SUMMARY.md + - site-urls + +markdown_extensions: + - attr_list + - md_in_html + - pymdownx.details + - pymdownx.superfences + - pymdownx.snippets: + check_paths: true + restrict_base_path: False + base_path: "." + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + options: + custom_icons: + - overrides/.icons + - pymdownx.tabbed: + alternate_style: true + - def_list + - admonition + - footnotes + +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/NVIDIA/bionemo-framework + version: + provider: mike + default: latest + alias: true + docker_url: nvcr.io/nvidia/clara/bionemo-framework + docker_tag: nightly + github_url: https://github.com/NVIDIA/bionemo-framework + +copyright: | + © Copyright 2023-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.