mkdocs.yml

# Project information
site_name: atomicwriter
site_author: Ravencentric
site_description: Cross-platform atomic file writer for all-or-nothing operations.

# Repository
repo_name: atomicwriter
repo_url: https://github.com/Ravencentric/atomicwriter
edit_uri: edit/main/docs/

theme:
  language: en
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil 
    view: material/eye
  name: material
  font:
    text: Noto Sans
  palette:
      primary: black
      accent: light-blue
      scheme: slate
  features:
    - navigation.instant
    - navigation.tracking
    - toc.follow
    - navigation.top
    - search.suggest
    - search.highlight
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - autorefs
  - mkdocstrings:
      enabled: true
      default_handler: python
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
          paths: [python]
          options:
            members_order: source
            allow_inspection: false
            docstring_style: numpy
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            separate_signature: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            merge_init_into_class: true
            filters: ["!^_", "^__init__$"]
            find_stubs_package: true
            show_source: false

markdown_extensions:
  - md_in_html
  - attr_list
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      url_download: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

nav:
  - Home: index.md
  - API Reference: api-reference.md