mkdocs.yml

site_name: Network Scenario Generator (GeNet)
nav:
  - Home: index.md
  - installation.md
  - docker.md
  - Examples: [] # this will be filled in automatically to include reference to all the notebooks
  - Contributing: contributing.md
  - Changelog: CHANGELOG.md
  - Reference:
    - Command line interface: api/cli.md
theme:
  name: material
  custom_dir: docs/overrides
  features:
    - navigation.indexes
    - navigation.top
    - content.code.copy
    - content.code.annotate
repo_url: https://github.com/arup-group/genet/
site_dir: .docs
markdown_extensions:
  - admonition
  - attr_list
  - mkdocs-click
  - tables
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.tasklist:
      clickable_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: "#"
      toc_depth: 3
hooks:
  - docs/static/hooks.py
plugins:
  - search
  - autorefs
  - mkdocs-jupyter:
      include: ["examples/*.ipynb"]
      ignore: ["examples/.*/*.py"]
      allow_errors: false
      kernel_name: genet
      include_source: True
      execute: false
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_section_style: spacy
            show_bases: true
            filters:
              - "!^_"
            merge_init_into_class: true
            show_if_no_docstring: true
            signature_crossrefs: true
            show_root_toc_entry: false
            show_signature_annotations: false
          paths: [src]
          import:
            - https://docs.python.org/3/objects.inv
            - https://pandas.pydata.org/docs/objects.inv
            - https://shapely.readthedocs.io/en/stable/objects.inv
            - https://geopandas.org/en/stable/objects.inv
            - https://networkx.org/documentation/stable/objects.inv
watch:
  - src/genet
extra_css:
  - static/extras.css
extra:
  version:
    provider: mike