mkdocs.yml

site_name: FastAPI Gateway Auto-Generate
theme:
  name: "material"
  features:
    - content.code.annotate

    - navigation.tabs
  palette:
    - scheme: slate
      primary: red
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to Dark Mode
    - scheme: default
      primary: red
      toggle:
        icon: material/toggle-switch
        name: Switch to Light Mode
nav:
    - Home:
      - Overview: index.md
    - Usage:
      - Getting started: Usage/getting-started.md
      - Tags for service: Usage/tags_for_service.md
      - Service management:
        - API: Usage/service-management.md
        - Using as module: Usage/using-as-module.md
      - File Manipulation:
          HTTP/HTTPS: Usage/FileManipulation/http-https.md
      - Security: Usage/security.md
#          Broker: index.md
    - FAQ: FAQ.md
    - Code Reference:
        - Main: CodeReference/index.md
        - Domain:
            - Models:
                - RouteModel: CodeReference/domain/models/RouteModel.md
            - Usecases:
                - BuildRouteModelsUsecase: CodeReference/domain/usecases/BuildRouteModelsUsecase.md
                - BuildRoutesUsecase: CodeReference/domain/usecases/BuildRoutesUsecase.md
                - DeleteTmpModelsFilesUsecase: CodeReference/domain/usecases/DeleteTmpModelsFilesUsecase.md
                - InitDatabaseUsecase: CodeReference/domain/usecases/InitDatabaseUsecase.md
                - RefreshServicesUsecase: CodeReference/domain/usecases/RefreshServicesUsecase.md
                - UpdateOpenApiSchemaUsecase: CodeReference/domain/usecases/UpdateOpenApiSchemaUsecase.md
        - Management:
            - Management: CodeReference/management/Management.md
            - Routes:
                - AddServiceRoute: CodeReference/management/routes/AddServiceRoute.md
                - DeleteServiceRoute: CodeReference/management/routes/DeleteServiceRoute.md
                - GetAllInfoServicesRoute: CodeReference/management/routes/GetAllInfoServicesRoute.md
                - RefreshServicesRoute: CodeReference/management/routes/RefreshServicesRoute.md
            - Models:
                - AddService: CodeReference/management/models/AddService.md
                - DeleteService: CodeReference/management/models/DeleteService.md
                - GetAllInfoServices: CodeReference/management/models/GetAllInfoServices.md
        - Exceptions:
            - ConfigException: CodeReference/exceptions/ConfigException.md
            - FastapiGatewayAutoGenerageException: CodeReference/exceptions/FastapiGatewayAutoGenerageException.md

repo_name: fastapi-gateway-auto-generate
repo_url: https://github.com/gnss-lab/FastAPI-Auto-Generate-Gateway
edit_uri: edit/master/docs
docs_dir: docs

# extra:
#   homepage: /installing

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
#          paths: [ fastapi_gateway_auto_generate ]
          selection:
            docstring_style: google
            docstring_options:
              ignore_init_summary: yes
          rendering:
            merge_init_into_class: yes

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde