The goal of this repo is to provide a temporary home for the rendered documentation for VMware's ansible-for-nsxt Repository.
I hope these docs find their way to the offical repo in the future.
The docs are hosted here
- Convert the module documentation to .rst file (using the mechanisms described Here)
- Push the resulting .rst files to this repo
- Let Sphinx/ Readthedocs handle the rest
Details on what's happening can be found in the docs.sh
script
⚠️ The current docs were generated with the following modules of following commit: https://github.com/12Balu34/ansible-for-nsxt/commit/970d15a71a7396da3809f4af0e9f35a10753db7f The docs will not be kept up to date!
As a semi-automated way to generate the .rst files needed to render the docs, simply run the following commands (requires Docker):
mkdir -p ~/rst
docker run --rm -ti \
-v ~/rst:/rst \
-e ANSIBLE_FOR_NSXT_REPO=https://github.com/uempfel/ansible-for-nsxt \
-e ANSIBLE_FOR_NSXT_BRANCH=fix-docs-syntax \
-e ANSIBLE_BRANCH='v2.9.9' \
12balu34/ansible-for-nsxt-docs
The .rst files will be located in ~/rst after the Container-run finishes
- Build the container