aboutsummaryrefslogtreecommitdiff
path: root/pw_cli
diff options
context:
space:
mode:
authorArmando Montanez <amontanez@google.com>2020-03-13 13:06:24 -0700
committerCQ Bot Account <commit-bot@chromium.org>2020-03-17 00:13:35 +0000
commit0054a9be7053688b4001319ca7e9bce9340f9e9f (patch)
tree561dc2ca86f109859f4684bc2749fd5c9333c737 /pw_cli
parent59bcd9003fad77105cacc4867ec62aa8e8ba0477 (diff)
downloadpigweed-0054a9be7053688b4001319ca7e9bce9340f9e9f.tar.gz
Docs: Add missing RST docs
Adds dcos.rst files for all modules lacking documentation. Change-Id: Ief5594831d31fcb876381a4a3886382fab7d595e
Diffstat (limited to 'pw_cli')
-rw-r--r--pw_cli/BUILD.gn19
-rw-r--r--pw_cli/README.md5
-rw-r--r--pw_cli/docs.rst31
3 files changed, 53 insertions, 2 deletions
diff --git a/pw_cli/BUILD.gn b/pw_cli/BUILD.gn
new file mode 100644
index 000000000..31d536d5d
--- /dev/null
+++ b/pw_cli/BUILD.gn
@@ -0,0 +1,19 @@
+# Copyright 2020 The Pigweed Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+import("$dir_pw_docgen/docs.gni")
+
+pw_doc_group("docs") {
+ sources = [ "docs.rst" ]
+}
diff --git a/pw_cli/README.md b/pw_cli/README.md
index 8d0e36316..e2287f94e 100644
--- a/pw_cli/README.md
+++ b/pw_cli/README.md
@@ -1,4 +1,5 @@
-This directory contains the `pw` tool that facilitates working with
-Pigweed. Example starting functionality is the ability to watch the Pigweed source for changes and re-run tests.
+This directory contains the `pw` command line interface (CLI) that facilitates
+working with Pigweed. One example tool exposed by pw_cli is pw_watch, a file
+system watcher that triggers builds on source file changes.
This code is experimental and unfinished.
diff --git a/pw_cli/docs.rst b/pw_cli/docs.rst
new file mode 100644
index 000000000..92f839bfd
--- /dev/null
+++ b/pw_cli/docs.rst
@@ -0,0 +1,31 @@
+.. _chapter-pw-cli:
+
+.. default-domain:: python
+
+.. highlight:: sh
+
+------
+pw_cli
+------
+This directory contains the `pw` command line interface (CLI) that facilitates
+working with Pigweed. The CLI module adds several subcommands prefixed with
+`pw`, and provides a mechanism for other Pigweed modules to behave as "plugins"
+and register themselves as `pw` commands as well. After activating the Pigweed
+environment, these commands will be available for use.
+
+Some examples:
+
+.. code:: sh
+
+ $ pw doctor
+ $ pw format
+ $ pw logdemo
+ $ pw module-check
+ $ pw presubmit
+ $ pw test
+ $ pw watch
+
+To see an up-to-date list of `pw` subcommands, run ``pw --help``.
+
+.. note::
+ The documentation for this module is currently incomplete.