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
20 lines
769 B
Plaintext
20 lines
769 B
Plaintext
Provides commands that can be performed on bare metal host(s). The commands help in
|
|
performing the basic boot and power operations on the bare metal host(s).
|
|
|
|
Usage:
|
|
baremetal [command]
|
|
|
|
Available Commands:
|
|
ejectmedia Airshipctl command to eject virtual media attached to a bare metal host
|
|
help Help about any command
|
|
poweroff Airshipctl command to shutdown bare metal host(s)
|
|
poweron Airshipctl command to power on host(s)
|
|
powerstatus Airshipctl command to retrieve the power status of a bare metal host
|
|
reboot Airshipctl command to reboot host(s)
|
|
remotedirect Airshipctl command to bootstrap the ephemeral host
|
|
|
|
Flags:
|
|
-h, --help help for baremetal
|
|
|
|
Use "baremetal [command] --help" for more information about a command.
|