Skip to content

Commit 939151d

Browse files
committed
LCORE-3141: devel-doc make target
1 parent b35bce4 commit 939151d

2 files changed

Lines changed: 7 additions & 5 deletions

File tree

Makefile

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -185,10 +185,11 @@ openapi-doc: docs/openapi.json scripts/fix_openapi_doc.py ## Generate OpenAPI do
185185
python3 scripts/fix_openapi_doc.py < output.md > openapi2.md
186186
rm output.md
187187

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

191-
doc: ## Generate documentation for developers
192+
devel-doc: ## Generate documentation for developers
192193
scripts/gen_doc.py
193194

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

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -918,8 +918,9 @@ security-check Check the project for security issues
918918
format Format the code into unified format
919919
schema Generate OpenAPI schema file stored in docs subdirectory
920920
openapi-doc Generate OpenAPI documentation
921-
generate-documentation Generate documentation
922-
doc Generate documentation for developers
921+
generate-documentation Generate or regenerated content of the whole /docs subdirectory
922+
doc Generate or regenerated content of the whole /docs subdirectory
923+
devel-doc Generate documentation for developers
923924
docs/models Generate documentation about models
924925
docs/models/requests.puml Generate PlantUML class diagram for requests data models
925926
docs/models/responses.puml Generate PlantUML class diagram for responses data models

0 commit comments

Comments
 (0)