Skip to content
This repository has been archived by the owner on Dec 13, 2022. It is now read-only.

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

Merged
merged 1 commit into from
Mar 5, 2020
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/
Expand Down
8 changes: 8 additions & 0 deletions doc/API/README.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
```
785 changes: 0 additions & 785 deletions doc/API/centreon-api-v2.html
View file
Open in desktop

This file was deleted.