|
|
@ -17,7 +17,7 @@ This command generates the documentation and deploys it on your CodeDoc space
|
|
|
|
|
|
|
|
|
|
|
|
- `-b --branch [branch]` pattern of branch names to deploy
|
|
|
|
- `-b --branch [branch]` pattern of branch names to deploy
|
|
|
|
- `-l --loc [dir]` location of the documentation sources root - **required**
|
|
|
|
- `-l --loc [dir]` location of the documentation sources root - **required**
|
|
|
|
- `-t --type [docusaurus|doxygen|swagger]` type of documentation generator to use. - **required**
|
|
|
|
- `-t --type [docusaurus|doxygen|mdbook|swagger]` type of documentation generator to use. - **required**
|
|
|
|
- `-d --dest [dir]` path to where to put the documentation outputs in your repository's CodeDoc space - **optional <u>!! cannot be absolute !!</u>**
|
|
|
|
- `-d --dest [dir]` path to where to put the documentation outputs in your repository's CodeDoc space - **optional <u>!! cannot be absolute !!</u>**
|
|
|
|
|
|
|
|
|
|
|
|
Note !
|
|
|
|
Note !
|
|
|
@ -29,6 +29,7 @@ Usage examples :
|
|
|
|
/entrypoint.sh -l ./documentation/api/api-swagger.yml -t swagger -d api_documentation
|
|
|
|
/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 ./documentation/app -t docusaurus -d application_documentation
|
|
|
|
/entrypoint.sh -b main -l ./src/Doxyfile -t doxygen -d sourcecode_documentation
|
|
|
|
/entrypoint.sh -b main -l ./src/Doxyfile -t doxygen -d sourcecode_documentation
|
|
|
|
|
|
|
|
/entrypoint.sh -l ./doc -t mdbook -d book
|
|
|
|
```
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### How to add a custom documentation generator ?
|
|
|
|
### How to add a custom documentation generator ?
|
|
|
|