[docs] publish documentation for the generators (!932) · Merge requests · OpenAPI Tools / openapi-generator

Merged Administrator requested to merge github/fork/jmini/generate_docs into master Aug 30, 2018

Created by: jmini

Read the contribution guidelines.
Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
Filed the PR against the correct branch: master, 3.3.x, 4.0.x. Default: master.
Copied the technical committee to review the pull request if your PR is targeting a particular programming language. @OpenAPITools/generator-core-team @OpenAPITools/openapi-generator-collaborators

The documentation (cli help pages) are published under docs/generators.

3 new scripts are introduced:

bin/utils/export_generators_readme.sh updates the readme: docs/generators/README.md
bin/utils/export_generator.sh <generator_name> updates the file: docs/generators/<generator_name>.md
bin/utils/export_docs_generators.sh updates the complete folder docs/generators

This will stay up to data whit the ensure-up-to-date script (see #80)