4da8a54887
Current modified go code, generates RsT files for each airshipctl
cmd and places them in a folder specific to the airshipctl subcommand.
It also generates the index.rst file for the specific airshipctl
subcommand folders. These generated rst files are appropriate to sphinx,
so that they can be easliy rendered in docs.airshipit.org
Steps to render the document locally
* Install sphinx: python3 -m pip install sphinx
* Clone airshipctl: git clone https://github.com/airshipit/airshipctl.git
* Download current PS: cd airshipctl; git fetch "https://review.opendev.org/airship/airshipctl" refs/changes/50/789250/2 && git checkout -b change-789250-1 FETCH_HEAD
* Build sphinx html pages: cd docs/source; sphinx-build -b html . _build
* Run local server: cd _build; python3 -m http.server
* Open URL to access the page: http://localhost:8000/ navigate to commands section access the document
Relates-To: #280
Change-Id: Ifa1dafc7b296014cc826072ac2c52f4488421352
31 lines
1.3 KiB
Plaintext
31 lines
1.3 KiB
Plaintext
Render documents for a phase.
|
|
|
|
Usage:
|
|
render PHASE_NAME [flags]
|
|
|
|
Examples:
|
|
|
|
Get all 'initinfra' phase documents containing labels "app=helm" and "service=tiller"
|
|
# airshipctl phase render initinfra -l app=helm,service=tiller
|
|
|
|
Get all phase documents containing labels "app=helm" and "service=tiller" and kind 'Deployment'
|
|
# airshipctl phase render initinfra -l app=helm,service=tiller -k Deployment
|
|
|
|
Get all documents from config bundle
|
|
# airshipctl phase render --source config
|
|
|
|
Get all documents executor rendered documents for a phase
|
|
# airshipctl phase render initinfra --source executor
|
|
|
|
|
|
Flags:
|
|
-a, --annotation string filter documents by Annotations
|
|
-g, --apiversion string filter documents by API version
|
|
-d, --decrypt ensure that decryption of encrypted documents has finished successfully
|
|
-h, --help help for render
|
|
-k, --kind string filter documents by Kind
|
|
-l, --label string filter documents by Labels
|
|
-s, --source string phase: phase entrypoint will be rendered by kustomize, if entrypoint is not specified error will be returned
|
|
executor: rendering will be performed by executor if the phase
|
|
config: this will render bundle containing phase and executor documents (default "phase")
|