|
|
|
@ -20,13 +20,14 @@ This command generates the documentation and deploys it on your CodeDoc space
|
|
|
|
|
- `-d --dest [dir]` path to where to put the documentation outputs in your repository's CodeDoc space - **optional <u>!! cannot be absolute !!</u>**
|
|
|
|
|
|
|
|
|
|
Note !
|
|
|
|
|
For swagger, you have to pass the configuration file instead of a directory
|
|
|
|
|
For swagger and doxygen, you have to pass the configuration file instead of a directory
|
|
|
|
|
|
|
|
|
|
usage examples :
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
/entrypoint.sh -l ./documentation/api/api-swagger.yml -t swagger -d api_documentation
|
|
|
|
|
/entrypoint.sh -l ./documentation/app -t docusaurus -d application_documentation
|
|
|
|
|
/entrypoint.sh -l ./src -t doxygen -d sourcecode_documentation
|
|
|
|
|
/entrypoint.sh -l ./src/Doxyfile -t doxygen -d sourcecode_documentation
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### How to add custom documentation generator ?
|
|
|
|
|