Skip to content

Commit

Permalink
Move OpenAPI documentation from UI/openapi to doc/openapi
Browse files Browse the repository at this point in the history
  • Loading branch information
ylavoie committed Oct 8, 2022
1 parent c40e724 commit 00f8c98
Show file tree
Hide file tree
Showing 5 changed files with 2,525 additions and 7 deletions.
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -138,9 +138,9 @@ pod:
$(DOCKER_CMD) utils/devel/pod2projdocs.pl 2>&1 pod2projdocs.log

api:
rm -rf UI/openapi
mkdir UI/openapi
chmod 777 UI/openapi
rm -rf doc/openapi
mkdir doc/openapi
chmod 777 doc/openapi
$(DOCKER_CMD) utils/devel/rebuild_api.sh 2>&1 rebuild_api.log

pot:
Expand Down
2,518 changes: 2,518 additions & 0 deletions doc/openapi/LedgerSMB-api.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@
"UI/**/util/**/*.css",
"UI/js/**",
"UI/pod/**",
"UI/openapi/**"
"doc/openapi/**"
],
"rules": {
"declaration-block-no-duplicate-custom-properties": null,
Expand Down
2 changes: 1 addition & 1 deletion utils/devel/rebuild_api.sh
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ cp $gitDirName/openapi/.redocly.yaml .
npx @redocly/cli lint API.yaml || exit

# Build the documentation
redoc-cli build API.yaml -o $gitDirName/UI/openapi/LedgerSMB-api.html
redoc-cli build API.yaml -o $gitDirName/doc/openapi/LedgerSMB-api.html

mv API.yaml $gitDirName/openapi/

Expand Down
4 changes: 2 additions & 2 deletions utils/devel/rebuild_pot.sh
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ EOF

# EXTRACT STRINGS AND CREATE POT
find . -name '*.pl' -o -name '*.pm' | \
grep -v '\(b\|xt/\)lib/\|UI/pod\|UI/openapi/\|\./\.[a-z]*\+' | grep -v LaTeX | sort | \
grep -v '\(b\|xt/\)lib/\|UI/pod/\|\./\.[a-z]*\+' | grep -v LaTeX | sort | \
utils/devel/extract-perl >> locale/LedgerSMB.pot

find UI/ templates/ t/data/ \
-name '*.html' -o -name '*.tex' -o -name '*.csv' | \
grep -v 'UI/\(js\|pod\|UI/openapi\)/' | sort | \
grep -v 'UI/\(js\|pod\)/' | sort | \
utils/devel/extract-template-translations >> locale/LedgerSMB.pot

utils/devel/extract-sql < sql/Pg-database.sql >> locale/LedgerSMB.pot
Expand Down

0 comments on commit 00f8c98

Please sign in to comment.