Skip to content

LCORE-3141: devel-doc make target #2188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tisnik merged 1 commit into from
Jul 21, 2026
+7 −5
Merged

LCORE-3141: devel-doc make target #2188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,10 +185,11 @@ openapi-doc: docs/openapi.json scripts/fix_openapi_doc.py ## Generate OpenAPI do
python3 scripts/fix_openapi_doc.py < output.md > openapi2.md
rm output.md

generate-documentation: ## Generate documentation
scripts/gen_doc.py
generate-documentation: devel-doc ## Generate or regenerated content of the whole /docs subdirectory

doc: devel-doc ## Generate or regenerated content of the whole /docs subdirectory

doc: ## Generate documentation for developers
devel-doc: ## Generate documentation for developers
scripts/gen_doc.py

docs/models: docs/models/requests.puml docs/models/responses.puml docs/models/database.puml docs/models/common.puml ## Generate documentation about models
Expand Down
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -918,8 +918,9 @@ security-check Check the project for security issues
format Format the code into unified format
schema Generate OpenAPI schema file stored in docs subdirectory
openapi-doc Generate OpenAPI documentation
generate-documentation Generate documentation
doc Generate documentation for developers
generate-documentation Generate or regenerated content of the whole /docs subdirectory
doc Generate or regenerated content of the whole /docs subdirectory
devel-doc Generate documentation for developers
docs/models Generate documentation about models
docs/models/requests.puml Generate PlantUML class diagram for requests data models
docs/models/responses.puml Generate PlantUML class diagram for responses data models
Expand Down
Loading