summaryrefslogtreecommitdiff
path: root/doc/source/invoking.rst
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-05-03 19:22:11 +0900
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-05-03 19:22:11 +0900
commitbcd88c9cfbec6c9fa6702d00eb291dd1bec255b2 (patch)
treeae3735ac796341b614ba5837b2cb108e330accc2 /doc/source/invoking.rst
parentd0413e4e17564fea0b31379dc905e1638ca07ad2 (diff)
downloadbuildstream-bcd88c9cfbec6c9fa6702d00eb291dd1bec255b2.tar.gz
Documentation: Added "Invoking BuildStream" user facing documentation
This is using the relatively new `sphinx-click` plugin and will automatically update the documentation based on whatever changes in the frontend.
Diffstat (limited to 'doc/source/invoking.rst')
-rw-r--r--doc/source/invoking.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/source/invoking.rst b/doc/source/invoking.rst
new file mode 100644
index 000000000..ca14f24bd
--- /dev/null
+++ b/doc/source/invoking.rst
@@ -0,0 +1,8 @@
+.. _invoking:
+
+Invoking BuildStream
+====================
+
+.. click:: buildstream._frontend.main:cli
+ :prog: bst
+ :show-nested: