mkdocs.yml

site_name: PlateauKit + PlateauLab
site_description: "PlateauKit: 国土交通省 Project PLATEAUの3D都市モデルを利用するためのオープンソースPythonライブラリおよび変換ツール"
# strict: true
site_url: https://ozekik.github.io/plateaukit/

theme:
  name: "material"
  language: ja
  logo: assets/icon.svg
  # font:
  #   text: "Noto Sans JP"
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: white
      # toggle:
      #   icon: material/lightbulb-outline
      #   name: "Switch to dark mode"
    # - media: "(prefers-color-scheme: dark)"
    #   scheme: slate
    #   primary: blue grey
    #   accent: blue grey
    #   toggle:
    #     icon: material/lightbulb
    #     name: "Switch to light mode"
  features:
    - navigation.footer
    - navigation.expand
    - content.code.copy
    # - toc.integrate
    # - content.action.view
    # - content.action.edit
    # - content.tabs.link
    # - content.code.annotate
    # - announce.dismiss
    - navigation.tabs
  icon:
    # logo: material/layers-outline
    repo: fontawesome/brands/github
    # favicon: "favicon.png"

repo_name: ozekik/plateaukit
repo_url: https://github.com/ozekik/plateaukit
edit_uri: edit/master/docs/
# extra:
#   version:
#     provider: mike

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - js/extra.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6

nav:
  - PlateauKit + PlateauLab:
      - PlateauKit: index.md
      - PlateauLab: lab/index.md
      - インストール: install.md
      - チュートリアル:
          - JupyterLabで試す: tutorial/jupyter.ipynb
          - 都市モデルとレイヤーを重ねる: tutorial/maps-overlay.ipynb
          - 🚧 チャットAI (LLM) との連携: tutorial/llm.md
      - コマンドラインでの利用:
          - 都市モデルを追加する・削除する: cli/setup.md
          - データを事前ビルドする: cli/prebuild.md
          - 都市モデルの情報を取得する: cli/info.md
          - 都市モデルを変換する: cli/convert.md
          - CLI リファレンス: cli/reference.md
      - ライブラリとして利用:
          # - PLATEAUデータの追加と削除: library/setup.ipynb
          # - 都市モデルを読み込む: library/dataset.ipynb
          - 範囲を選択する・抽出する: library/area.ipynb
          - 都市モデルを表示する: library/preview.ipynb
          - データを処理する: library/data-processing.ipynb
      # - Get Started:
      # - Usage:
      - 開発に参加する / バグ報告・機能要望: contributing.md
      - 🚧 API リファレンス: api.md
      - FAQ:
          - Windows: faq.md
      - ライセンス: license.md
  - ブラウザで試す: /plateaukit/jupyterlite/notebooks/?path=demo.ipynb
  - "Awesome PLATEAU": https://japan-opendata.github.io/awesome-plateau/

not_in_nav: |
  ./jupyterlite/

markdown_extensions:
  - tables
  - toc:
      permalink: true
      title: 項目
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: none
  - admonition
  - mkdocs-click
  - pymdownx.tasklist:
      custom_checkbox: false
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.superfences
  #   - pymdownx.highlight
  - pymdownx.extra
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
        #   - pymdownx.tabbed:
        #       alternate_style: true


  - pymdownx.superfences:
      custom_fences:
        - name: python
          class: python
          validator: !!python/name:markdown_exec.validator
          format: !!python/name:markdown_exec.formatter

watch:
  - plateaukit

plugins:
  # - mike:
  #     alias_type: symlink
  #     canonical_version: latest
  - search
  - markdown-exec
  - mkdocs-jupyter:
      execute: false # true
      ignore_h1_titles: true
      ignore: ["jupyterlite/**/*.ipynb", ".ipynb_checkpoints/**/*.ipynb"]
      include_requirejs: true
  - exclude:
      glob:
        - plugins/*
        - __pycache__/*
  - redirects:
      redirect_maps:
        "cli/usage.md": "cli/convert.md"
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [.]
          options:
            members_order: source
            separate_signature: true
            filters: ["!^_"]
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            inherited_members: true
            show_submodules: true
            docstring_section_style: spacy
            # extensions:
            #   - docs/plugins/griffe_doclinks.py
  # - mkdocs-simple-hooks:
  #     hooks:
  #       on_pre_build: "docs.plugins.main:on_pre_build"
  #       on_files: "docs.plugins.main:on_files"
  #       on_page_markdown: "docs.plugins.main:on_page_markdown"
  # - external-markdown: