mkdocs.yaml

###
# Copyright (2022) Hewlett Packard Enterprise Development LP
#
# 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: CMF
site_description: CMF - Common Metadata Framework
site_author: AI Research & Development Lab (Hewlett-Packard Labs)


repo_name: HewlettPackard/cmf
repo_url: https://github.com/HewlettPackard/cmf
edit_uri: ""
docs_dir: docs/


theme:
  name: material
  language: en
  features:
    - navigation.sections  # Sections are included in the navigation on the left.
    - toc.integrate        # Table of contents is integrated on the left; does not appear separately on the right.
    - header.autohide      # header disappears as you scroll
  palette:
    primary: 'blue'
    accent: 'blue'
  font:
    text: 'Circular'
    code: 'Inconsolata'


markdown_extensions:
  - admonition
  - pymdownx.arithmatex:   # Render LaTeX via MathJax
      generic: true
  - pymdownx.tasklist
  - pymdownx.details       # Allowing hidden expandable regions denoted by ???
  - pymdownx.superfences   # Seems to enable syntax highlighting when used with the Material theme.
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: True
  - attr_list
  - md_in_html             # Parse markdown inside HTML tags (default is not to parse).

extra_css:
  - extra.css         # This defines custom properties, in particular, enforces custom HTML tables to be 100% width.


plugins:
  - autorefs          # Need to reference mkdocstrings-generated content from documentation files ([][] thing).
  - search
  - mkdocstrings:     # Automatically generate API documentation.
      default_handler: python
      handlers:
        python:
          paths: [src]
extra:
  social:
    # Buttons at the bottom of every page.
    - icon: fontawesome/brands/github
      link: https://github.com/HewlettPackard/cmf
    - icon: fontawesome/brands/slack
      link: https://commonmetadata.slack.com/


# This defines the structure of the CMF documentation portal (all must be in `docs/` directory).
nav:
  - index.md
  - Quick start with cmf-client: cmf_client/step-by-step.md
  - Examples:
      - Getting Started: examples/getting_started.md
  - Architecture:
      - Overview: architecture/overview.md
      - Components: architecture/components.md
      - Advantages: architecture/advantages.md
  - Client:
      - Overview: cmf_client/cmf_client.md
      - Quick start with cmf-client: cmf_client/step-by-step.md
      - dvc minio backend: cmf_client/minio-server.md
  - Server:
      - Getting started with cmf-server: cmf_server/cmf-server.md
  - TensorBoard:
      - Getting started with tensorboard: cmf_client/tensorflow_guide.md
  - Public API:
      - CMF: api/public/cmf.md
      - DataSlice: api/public/dataslice.md
      - CmfQuery: api/public/cmfquery.md
  - Ontology:
      - Ontology: common-metadata-ontology/readme.md