mkdocs.yml

edit_uri: ''
extra:
  analytics:
    property: G-XT3KGMHSY8
    provider: google
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better.
markdown_extensions:
- admonition
- markdown_include.include
- md_in_html
- pymdownx.emoji
- pymdownx.magiclink
- pymdownx.superfences
- pymdownx.tabbed
- pymdownx.tasklist
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.snippets
- toc:
    permalink: ¤
plugins:
- awesome-pages
# warning don't use `macros` - yet
- search
- social
- autorefs
- git-revision-date-localized
- htmlproofer:
    enabled: true
    validate_rendered_template: false
    validate_external_urls: true
    raise_error_after_finish: false
    raise_error_excludes:
      # This is to remove some false positives for links which work.
      # Anchors are validated again by core mkdocs
      404: [ '#trestle.*' ]
- mkdocstrings:
    default_handler: python
    handlers:
      python:
        options:
          show_inheritance_diagram: true
          inherited_members: false
          group_by_category: true
          show_category_heading: true
          show_if_no_docstring: true
          show_root_heading: true
          filters:
          - '!^_[^_]'
          - '!^__json'
          - '!^__config__'
          new_path_syntax: true
- minify:
    minify_html: true
    minify_js: false
    minify_css: true
    css_files:
    - css/mkdocstrings.css
    htmlmin_opts:
      remove_comments: true
- mike:
    # These fields are all optional; the defaults are as below...
    alias_type: symlink
    redirect_template: null
    deploy_prefix: ''
    canonical_version: latest
    version_selector: true
    css_dir: css
    javascript_dir: js
repo_name: oscal-compass/compliance-trestle
repo_url: https://github.com/oscal-compass/compliance-trestle
site_description: Documentation for compliance-trestle package.
site_name: Compliance Trestle
site_url: https://oscal-compass.github.io/compliance-trestle
theme:
  features:
  - content.code.annotate
  - navigation.tabs
  name: material
  palette:
    accent: purple
    primary: black
    scheme: slate
  time_format: "%Y-%m-%d %H:%M:%S" # The format used to display the time
  meta_time_format: "%Y-%m-%d %H:%M:%S"
  #logo: "../images/compliance-trestle-800x800-transparent.png" # Update when have a single color svg
  favicon: assets/favicon.ico
validation:
  omitted_files: warn
  absolute_links: warn # Or 'relative_to_docs' - new in MkDocs 1.6
  unrecognized_links: warn
  anchors: warn # New in MkDocs 1.6