Skip to content

Commit 8c9c736

Browse files
committed
Added new Makefile target
1 parent 7743e5c commit 8c9c736

2 files changed

Lines changed: 9 additions & 1 deletion

File tree

Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ openapi-doc: docs/openapi.json ## Generate OpenAPI documentation
4343
requirements.txt: pyproject.toml pdm.lock ## Generate requirements.txt file containing hashes for all non-devel packages
4444
pdm export --prod --format requirements --output requirements.txt --no-extras --without evaluation
4545

46+
doc:
47+
scripts/gen_doc.py
48+
4649
docs/config.puml: src/models/config.py ## Generate PlantUML class diagram for configuration
4750
pyreverse src/models/config.py --output puml --output-directory=docs/
4851
mv docs/classes.puml docs/config.puml

scripts/gen_doc.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
#!/usr/bin/env python3
22

3+
"""Generate documentation for all modules from Lightspeed Stack core service."""
4+
35
import os
46

57
import ast
@@ -15,7 +17,10 @@
1517

1618
try:
1719
with open("README.md", "w", encoding="utf-8", newline="\n") as indexfile:
18-
print(f"# List of source files stored in `{directory}` directory", file=indexfile)
20+
print(
21+
f"# List of source files stored in `{directory}` directory",
22+
file=indexfile,
23+
)
1924
print("", file=indexfile)
2025
files = sorted(os.listdir())
2126

0 commit comments

Comments
 (0)