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
52 lines
903 B
ReStructuredText
52 lines
903 B
ReStructuredText
.. _airshipctl_phase_tree:
|
|
|
|
airshipctl phase tree
|
|
---------------------
|
|
|
|
Airshipctl command to show tree view of kustomize entrypoints of phase
|
|
|
|
Synopsis
|
|
~~~~~~~~
|
|
|
|
|
|
Get tree view of the kustomize entrypoints of a phase.
|
|
|
|
|
|
::
|
|
|
|
airshipctl phase tree PHASE_NAME [flags]
|
|
|
|
Examples
|
|
~~~~~~~~
|
|
|
|
::
|
|
|
|
|
|
yaml explorer of a phase with relative path
|
|
# airshipctl phase tree /manifests/site/test-site/ephemeral/initinfra
|
|
|
|
yaml explorer of a phase with phase name
|
|
# airshipctl phase tree initinfra-ephemeral
|
|
|
|
|
|
Options
|
|
~~~~~~~
|
|
|
|
::
|
|
|
|
-h, --help help for tree
|
|
|
|
Options inherited from parent commands
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
::
|
|
|
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
--debug enable verbose output
|
|
|
|
SEE ALSO
|
|
~~~~~~~~
|
|
|
|
* :ref:`airshipctl phase <airshipctl_phase>` - Airshipctl command to manage phases
|
|
|