GitLab Overviewer

API Reference

  • API Module
  • CLI Module
  • Models Module
  • Rendering Module
  • Services Module
  • Utils Module
  • Config Module

Spec: Configuration

  • Configuration Settings Layer
  • Table Configuration (table_config.yaml)

Spec: Data Model

  • Data Collection Workflow
  • GitLab API Client
  • Model Mapping Layer
  • ReadmeExtract Model

Spec: Rendering

  • Table Rendering & UI
  • Table Sorting
  • Markdown Overview Renderer
  • Quarto Renderer (index.qmd + project sheets)

Spec: Misc

  • Docstring Conventions

Reference

  • Module Index
  • Full Index
GitLab Overviewer
  • Overview: module code

All modules for which code is available

  • gitlab_overviewer.api.client
  • gitlab_overviewer.api.errors
  • gitlab_overviewer.cli.__main__
  • gitlab_overviewer.cli.diag
  • gitlab_overviewer.config.settings
  • gitlab_overviewer.models.group
  • gitlab_overviewer.models.issue
  • gitlab_overviewer.models.mapper
  • gitlab_overviewer.models.overview_data
  • gitlab_overviewer.models.project
  • gitlab_overviewer.models.readme
  • gitlab_overviewer.models.readme_extract
  • gitlab_overviewer.rendering.markdown
  • gitlab_overviewer.rendering.quarto
  • gitlab_overviewer.rendering.renderer_base
  • gitlab_overviewer.rendering.table
  • gitlab_overviewer.services.data_collector
  • gitlab_overviewer.services.readme_extraction
  • gitlab_overviewer.services.sort_utils
  • gitlab_overviewer.utils.logging
  • gitlab_overviewer.utils.read_api
  • gitlab_overviewer.utils.timestamp

© Copyright 2025, GitLab Overviewer Team.

Built with Sphinx using a theme provided by Read the Docs.