site_name: "{{ project_name }}"
site_url: https://{{ github_username }}.github.io/{{ project_name }}

docs_dir: docs/

# For more configuration on the theme, see https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/
theme:
  name: material
  icon:
    logo: "fontawesome/solid/book"
  features:
    - instant
    - tabs
  language: en

# We customize the navigation by hand to control the order
# in which pages show up.

plugins:
  - search
  - mknotebooks:
      execute: true
      write_markdown: true
      allow_errors: false
      timeout: 1200
      binder: true
      binder_service_name: "gh"
      binder_branch: "master"
      binder_ui: "lab"
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          rendering:
            show_source: true
          # https://github.com/mkdocstrings/mkdocstrings/issues/278#issuecomment-831411193
          selection:
            docstring_style: restructured-text
      # custom_templates: templates
      watch:
        - {{ project_name }}
# Taken from here: https://squidfunk.github.io/mkdocs-material/extensions/codehilite/
markdown_extensions:
  - codehilite
  - admonition
  - pymdownx.superfences
  - markdown.extensions.attr_list

extra_css:
  - apidocs.css

extra_javascript:
  - config.js

repo_name: "{{ github_username }}/{{ project_name }}"
repo_url: "https://github.com/{{ github_username }}/{{ project_name }}"

extra:
  social:
    - icon: "fontawesome/brands/github"
      link: "https://github.com/{{ github_username }}"
    {% if twitter_username %}
    - icon: "fontawesome/brands/twitter"
      link: "https://twitter.com/{{ twitter_username }}"
    {% endif %}
    {% if linkedin_username %}
    - icon: "fontawesome/brands/linkedin"
      link: "https://linkedin.com/in/{{ linkedin_username }}"
    {% endif %}
