doc(api): document how to generate html api documentation (#8394)

centreon · Mar 5, 2020 · eedb04f · eedb04f
1 parent f8b7410
commit eedb04f
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 691 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,9 @@
 #generic development files
 www/index.html
 
+#api html documentation
+doc/API/centreon-api-v2.html
+
 #backend development and project files
 .idea/
 vendor/

diff --git a/doc/API/README.MD b/doc/API/README.MD
@@ -0,0 +1,8 @@
+# API Documentation Guide
+
+## How to build ?
+
+```console
+npm install -g redoc-cli
+redoc-cli bundle --options.hideDownloadButton=true centreon-api-v2.yaml -o centreon-api-v2.html
+```
diff --git a/doc/API/centreon-api-v2.html b/doc/API/centreon-api-v2.html