khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-02 17:59:36 +07:00
Code Issues Packages Projects Releases Wiki Activity

Add new OCS API documentation

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

7
.gitignore vendored
View File

@@ -29,6 +29,11 @@ _build
developer_manual/html_css_design/img
developer_manual/html_css_design/icons.txt
# OpenAPI file
developer_manual/_static/openapi.json
developer_manual/_static/stoplight-elements.js
developer_manual/_static/stoplight-elements.css
# Exclude Eclipse project
.project
@@ -47,4 +52,4 @@ venv
.history/
# JetBrains IDEs
.idea/
.idea/

3
.gitmodules vendored Normal file
View File

@@ -0,0 +1,3 @@
[submodule "build/openapi-extractor"]
path = build/openapi-extractor
url = https://github.com/nextcloud/openapi-extractor

18
Makefile
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

1
build/openapi-extractor Submodule

Submodule build/openapi-extractor added at 13d22c9cc3

10
developer_manual/_static/openapi.html Normal file
View File

@@ -0,0 +1,10 @@
<html>
<head>
<title>OCS API</title>
<script src="stoplight-elements.js"></script>
<link rel="stylesheet" href="stoplight-elements.css">
</head>
<body>
<elements-api apiDescriptionUrl="openapi.json" router="hash" hideTryIt="true" logo="logo-blue.png"></elements-api>
</body>
</html>

4
developer_manual/client_apis/OCS/index.rst
View File

@@ -4,6 +4,10 @@
OCS API
===============================
To browse the new OCS API documentation please go `here <../../_static/openapi.html>`_.
The old documentation is still kept as it provides some additional documentation that is not completely covered in the new documentation:
.. toctree::
ocs-api-overview

2
developer_manual/conf.py
View File

@@ -126,7 +126,7 @@ html_short_title = "Developer Manual"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['../_shared_assets/static']
html_static_path = ['../_shared_assets/static', '_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.