Add new OCS API documentation

Signed-off-by: jld3103 <jld3103yt@gmail.com>
This commit is contained in:
jld3103
2023-04-05 12:49:16 +02:00
parent f4c96a4acb
commit 3435dacebb
7 changed files with 41 additions and 4 deletions

View File

@@ -13,7 +13,7 @@ user-manual-html:
cd user_manual && make html
@echo "User manual build finished; HTML is updated"
developer-manual-html: icons-docs
developer-manual-html: openapi-spec icons-docs
rm -rf developer_manual/_build/html/com
cd developer_manual && make html
@echo "Developer manual build finished; HTML is updated"
@@ -26,8 +26,22 @@ user-manual-pdf:
cd user_manual && make latexpdf
@echo "User manual build finished; PDF is updated"
icons-docs: clean-icons-docs
get-server-sources:
cd build && sh get-server-sources.sh $(DRONE_BRANCH)
openapi-spec: get-server-sources
git submodule update --init
cd build/openapi-extractor && composer install
cd build && ./openapi-extractor/merge-specs \
--core server/core/openapi.json \
--merged ../developer_manual/_static/openapi.json \
$$(ls server/apps/*/openapi.json)
cd developer_manual/_static && \
wget https://unpkg.com/@stoplight/elements@7.7.17/web-components.min.js -O stoplight-elements.js && \
wget https://unpkg.com/@stoplight/elements@7.7.17/styles.min.css -O stoplight-elements.css
icons-docs: clean-icons-docs get-server-sources
cd build && composer install && composer update
cd build && php generateIconsDoc.php