Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -191,19 +191,30 @@ generate-documentation: ## Generate documentation
doc: ## Generate documentation for developers
scripts/gen_doc.py

docs/models: docs/models/requests.puml ## Generate documentation about models
docs/models: docs/models/requests.puml docs/models/common.puml ## Generate documentation about models

docs/models/requests.puml:
uv run pyreverse src/models/api/requests/ --output puml --output-directory=docs/models/
mv docs/models/classes.puml docs/models/requests.puml

docs/models/common.puml:
uv run pyreverse src/models/common/ --output puml --output-directory=docs/models/
mv docs/models/classes.puml docs/models/common.puml

docs/models/requests.svg: docs/models/requests.puml
pushd docs/models && \
java -jar ${PATH_TO_PLANTUML}/plantuml.jar requests.puml -tsvg && \
xmllint --format classes.svg > requests.svg && \
rm -f classes.svg && \
popd

docs/models/common.svg: docs/models/common.puml
pushd docs/models && \
java -jar ${PATH_TO_PLANTUML}/plantuml.jar common.puml -tsvg && \
xmllint --format classes.svg > common.svg && \
rm -f classes.svg && \
popd

docs/config.puml: src/models/config.py ## Generate PlantUML class diagram for configuration
uv run pyreverse src/models/config.py --output puml --output-directory=docs/
mv docs/classes.puml docs/config.puml
Expand Down
Loading
Loading