mkdocs.yml

# This file was generated from skeleton-ci/skeleton-python@0.0.2rc-219-g781ce0c.
# Instead of changing this particular file, you might want to alter the template:
# https://github.com/skeleton-ci/skeleton-python/tree/0.0.2rc-219-g781ce0c/project/%23%25%20if%20docs%20%25%23mkdocs.yml%23%25%20endif%20%25%23.jinja

site_name: "pj"
site_description: "Set up projects for development quickly."
site_url: "https://pj.readthedocs.io/en/latest/"
repo_url: "https://github.com/bswck/pj"
watch:
- "pj"

nav:
- "Overview": "index.md"
- "API Reference": "api.md"
- "Contributing": "contributing.md"
- "Code of Conduct": "code_of_conduct.md"
- "Changelog": "changelog.md"

theme:
  name: "material"
  features:
  - "content.code.annotate"
  - "navigation.top"
  - "navigation.tracking"
  palette:
  - media: "(prefers-color-scheme: light)"
    scheme: "default"
    primary: "teal"
    accent: "purple"
    toggle:
      icon: "material/weather-night"
      name: "Switch to dark mode"
  - media: "(prefers-color-scheme: dark)"
    scheme: "slate"
    primary: "black"
    accent: "lime"
    toggle:
      icon: "material/brightness-auto"
      name: "Switch to system preference"
  - media: "(prefers-color-scheme)"
    toggle:
      icon: "material/weather-sunny"
      name: "Switch to light mode"

extra_css:
- "css/mkdocstrings.css"

markdown_extensions:
- "admonition"
- "footnotes"
- "pymdownx.emoji"
- "pymdownx.highlight":
    use_pygments: true
- "pymdownx.magiclink"
- "pymdownx.superfences"
- "toc":
    permalink: true

plugins:
- "autorefs"
- "search"
- "markdown-exec"
- "mkdocstrings":
    handlers:
      python:
        options:
          docstring_style: "numpy"
          members_order: "source"
          show_signature_annotations: true
        paths: ["pj/"]
        import:
        - "https://docs.python.org/3/objects.inv"