mkdocs.yml

site_name: "databooks"
site_description: "Documentation for `databooks`."
site_url: "https://datarootsio.github.io/databooks"
repo_url: "https://github.com/datarootsio/databooks"
edit_uri: "blob/main/docs/"
repo_name: "datarootsio/databooks"

markdown_extensions:
  - def_list
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.tasklist:
      custom_checkbox: true

theme:
  name: "material"
  logo: images/sm-logo-white.png
  favicon: images/sm-logo.png
  font:
    text: arvo
    code: poppins
  icon:
    repo: fontawesome/brands/github-alt
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top

plugins:
- search
- autorefs
- coverage
- mkdocstrings:
    watch:
      - databooks
    handlers:
      python:
        selection:
          docstring_style: restructured-text

extra_css:
  - stylesheets/extra.css

nav:
- Home:
  - Overview: index.md
  - Alternatives and comparisons: alternatives.md
  - Changelog: https://github.com/datarootsio/databooks/releases
  - License: license.md
- Usage:
  - Overview: usage/overview.md
  - CLI: usage/cli.md
  - CI/CD: usage/cicd.md
  - Pre-commit hooks: usage/precommit.md
  - Configuration: usage/configuration.md
- CLI: CLI.md
- API:
  - Overview: API.md
  - Data models:
    - Base: data_models/base.md
    - Notebooks: data_models/notebook.md
  - Affirm: affirm.md
  - Common utils: common.md
  - Configuration: config.md
  - Conflicts: conflicts.md
  - Git: git_utils.md
  - Logging: logging.md
  - Metadata: metadata.md
  - TUI: tui.md
- Development:
  - Contributing: contrib.md
  - Coverage report: coverage.md

copyright: 'Maintained by dataroots'

extra:
    version:
      provider: mike
    social:
        - icon: fontawesome/brands/github-alt
          link: 'https://github.com/datarootsio'
        - icon: fontawesome/brands/linkedin
          link: 'https://www.linkedin.com/company/dataroots/'
        - icon: fontawesome/brands/instagram
          link: 'https://www.instagram.com/lifeatdataroots/'
        - icon: fontawesome/brands/youtube
          link: 'https://www.youtube.com/c/dataroots'
        - icon: fontawesome/solid/globe
          link: 'https://dataroots.io/'