pydoc-markdown.yml

loaders:
  - type: python
    search_path: [grafana_api]
processors:
  - type: filter
  - type: smart
  - type: crossref
renderer:
  type: mkdocs
  pages:
    - title: Home
      name: index
      source: docs/grafana_api_sdk.md
    - title: API SDK
      name: grafana_api
      children:
        - title: Model
          contents: [ model.* ]
        - title: Api
          contents: [ api.* ]
        - title: Alerting
          contents: [ alerting.* ]
        - title: Alerting Provisioning
          contents: [ alerting_provisioning.* ]
        - title: Legacy Alerting
          contents: [ legacy_alerting.* ]
        - title: Alerting Notifications
          contents: [ alerting_notifications.* ]
        - title: Admin
          contents: [ admin.* ]
        - title: Annotations
          contents: [ annotations.* ]
        - title: Authentication
          contents: [ authentication.* ]
        - title: Correlations
          contents: [ correlations.* ]
        - title: Datasource
          contents: [ datasource.* ]
        - title: Dashboard
          contents: [ dashboard.* ]
        - title: External Group
          contents: [ external_group.* ]
        - title: Folder
          contents: [ folder.* ]
        - title: Library
          contents: [ library.* ]
        - title: Licensing
          contents: [ licensing.* ]
        - title: Organisation
          contents: [ organisation.* ]
        - title: Other HTTP
          contents: [ other_http.* ]
        - title: PlayList
          contents: [ playlist.* ]
        - title: Legacy Playlist
          contents: [ legacy_playlist.* ]
        - title: Preferences
          contents: [ preferences.* ]
        - title: Query History
          contents: [ query_history.* ]
        - title: RBAC
          contents: [ rbac.* ]
        - title: Reporting
          contents: [ reporting.* ]
        - title: Search
          contents: [ search.* ]
        - title: Service Account
          contents: [ service_account.* ]
        - title: SSO Settings
          contents: [ sso_settings.* ]
        - title: Short url
          contents: [ short_url.* ]
        - title: Snapshot
          contents: [ snapshot.* ]
        - title: Team
          contents: [ team.* ]
        - title: User
          contents: [ user.* ]
  mkdocs_config:
    site_name: Grafana API SDK
    theme: material
    repo_url: https://github.com/ZPascal/grafana_api_sdk
    markdown_extensions:
        - pymdownx.tasklist