Skip to content

glpi-project/dbdocs

Repository files navigation

GLPI Database Documentation Generator

Generate and publish GLPI database schema documentation to dbdocs.io.

Installation

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

For publishing: install dbdocs CLI

Usage

Single file

python glpi_dbdocs.py generate --sql-file path/to/glpi.sql --output docs

With relations:

python glpi_dbdocs.py generate --sql-file path/to/glpi.sql --relation-file path/to/relation.constant.php --output docs

Multiple sources

  1. Copy configuration:

    cp config.example.yml config.yml
  2. Process all sources:

    python glpi_dbdocs.py process
  3. Publish:

    python glpi_dbdocs.py publish

Published links

License

GNU GPLv3+

Languages