mkdocs.yml

---
site_name: python-package-ci-cd
repo_url: https://github.com/tektronix/python-package-ci-cd
edit_uri: ''
site_author: Tektronix
site_description: A collection of Actions and Reusable Workflows for Python Packaging
  CI/CD.
copyright: © Copyright 2024, Tektronix
strict: true
site_url: !ENV [READTHEDOCS_CANONICAL_URL, null]
use_directory_urls: true
docs_dir: .
exclude_docs: |
  *env*/
  .tox/
  .results*/
  Dockerfile
  action.yml
  *.py
  *.txt
  *.xml
  *.json
  *.lock
  .idea/
  .vscode/
  *templates*/
  __*/
  temp*
  SECURITY.md
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  not_found: warn
  anchors: warn
theme:
  name: readthedocs
  highlightjs: false
  custom_dir: doc_config/_templates/readthedocs
  include_homepage_in_sidebar: false
  titles_only: false
  navigation_depth: 20
  collapse_navigation: true
  sticky_navigation: true
  features: [content.tooltips]
extra_css:
  - doc_config/_static/css/code_styles.css
  - doc_config/_static/css/theme_overrides.css
  - doc_config/_static/css/copybutton.css
extra_javascript:
  - doc_config/_static/js/insert-hr.js
  - doc_config/_static/js/clipboard.min.js
  - doc_config/_static/js/copybutton.js
markdown_extensions:
  - meta
  - toc:
      permalink: true
  - tables
  - fenced_code
  - abbr
  - smarty
  - admonition
  - footnotes
  - md_in_html
  - sane_lists
  - attr_list
  - def_list
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.highlight:
      use_pygments: true
      pygments_style: default
      pygments_lang_class: true
      code_attr_on_pre: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid
  - pymdownx.inlinehilite
plugins:
  - search
  - same-dir
  - macros:
      module_name: doc_config/macros
      on_error_fail: true
      on_undefined: strict
      j2_block_start_string: '[[%'
      j2_block_end_string: '%]]'
      j2_variable_start_string: '[['
      j2_variable_end_string: ']]'
  - ezglossary:
      tooltip: full
      strict: true
      use_default: true
      inline_refs: none
      markdown_links: true
  - mermaid2
  - spellcheck:
      known_words: doc_config/known_words.txt
      skip_files: [CHANGELOG.md]
      backends:
        - symspellpy
        - codespell:
            dictionaries:
              - clear
              - rare
              - informal
              - usage
              - code
              - names
              - en-GB_to_en-US
      ignore_code: true
      min_length: 2
      max_capital: 1
      allow_unicode: true
      strict_only: true
nav:
  - README.md
  - CHANGELOG.md
  - Reusable Workflows:
      - workflows/test-code.md
      - workflows/test-docs.md
      - workflows/sbom-scan.md
      - workflows/codeql-analysis.md
      - workflows/enforce-community-standards.md
      - workflows/package-build.md
      - workflows/package-release.md
      - workflows/package-testpypi.md
      - workflows/check-api-for-breaking-changes.md
      - workflows/publish-api-comparison.md
      - workflows/publish-test-results.md
      - workflows/update-python-and-pre-commit-dependencies.md
  - Actions:
      - actions/create_unique_testpypi_version/readme.md
      - actions/find_unreleased_changelog_items/readme.md
      - actions/update_development_dependencies/readme.md
      - actions/fetch_pr_number/readme.md
  - Contributing: [CONTRIBUTING.md, CODE_OF_CONDUCT.md, LICENSE.md]