Adds the ability to generate a website with reference documentation based on JSDoc annotations in the Javascript code. Annotations are also added. This will help you if you use an editor that knows how to parse JSDoc annotations.
This change adds a workflow that depends on NodeJS however, normal usage of the gateway will not require NodeJs, nor will any development workflows. In the future, development workflows will require NodeJs. Discussion on this topic here: https://github.com/nginxinc/nginx-s3-gateway/discussions/163
Usage
To generate the documentation run:
make jsdoc
It will be located in the ./reference folder at the root of the project
To generate and view the documentation in a browser, run:
What
Adds the ability to generate a website with reference documentation based on JSDoc annotations in the Javascript code. Annotations are also added. This will help you if you use an editor that knows how to parse JSDoc annotations.
This change adds a workflow that depends on NodeJS however, normal usage of the gateway will not require NodeJs, nor will any development workflows. In the future, development workflows will require NodeJs. Discussion on this topic here: https://github.com/nginxinc/nginx-s3-gateway/discussions/163
Usage
To generate the documentation run:
It will be located in the
./referencefolder at the root of the projectTo generate and view the documentation in a browser, run:
To remove generated documentation, run: