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
21 lines
1.1 KiB
Plaintext
21 lines
1.1 KiB
Plaintext
Provides commands which can be used to manage the airshipctl config file.
|
|
|
|
Usage:
|
|
config [command]
|
|
|
|
Available Commands:
|
|
get-context Airshipctl command to get context(s) information from the airshipctl config
|
|
get-management-config Airshipctl command to view management config(s) defined in the airshipctl config
|
|
get-manifest Airshipctl command to get a specific or all manifest(s) information from the airshipctl config
|
|
help Help about any command
|
|
init Airshipctl command to generate initial configuration file for airshipctl
|
|
set-context Airshipctl command to create/modify context in airshipctl config file
|
|
set-management-config Airshipctl command to create/modify out-of-band management configuration in airshipctl config file
|
|
set-manifest Airshipctl command to create/modify manifests in airship config
|
|
use-context Airshipctl command to switch to a different context
|
|
|
|
Flags:
|
|
-h, --help help for config
|
|
|
|
Use "config [command] --help" for more information about a command.
|