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
56 lines
1.2 KiB
ReStructuredText
56 lines
1.2 KiB
ReStructuredText
.. _airshipctl_document_pull:
|
|
|
|
airshipctl document pull
|
|
------------------------
|
|
|
|
Airshipctl command to pull manifests from remote git repositories
|
|
|
|
Synopsis
|
|
~~~~~~~~
|
|
|
|
|
|
The remote manifests repositories as well as the target path where
|
|
the repositories will be cloned are defined in the airship config file.
|
|
|
|
By default the airship config file is initialized with the
|
|
repository "https://opendev.org/airship/treasuremap" as a source of
|
|
manifests and with the manifests target path "$HOME/.airship/default".
|
|
|
|
|
|
::
|
|
|
|
airshipctl document pull [flags]
|
|
|
|
Examples
|
|
~~~~~~~~
|
|
|
|
::
|
|
|
|
|
|
Pull manifests from remote repos
|
|
# airshipctl document pull
|
|
>>>>>>> Updating cmd files for documentation
|
|
|
|
|
|
Options
|
|
~~~~~~~
|
|
|
|
::
|
|
|
|
-h, --help help for pull
|
|
-n, --no-checkout no checkout is performed after the clone is complete.
|
|
|
|
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 document <airshipctl_document>` - Airshipctl command to manage site manifest documents
|
|
|