diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-05-03 19:22:11 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-05-03 19:22:11 +0900 |
| commit | bcd88c9cfbec6c9fa6702d00eb291dd1bec255b2 (patch) | |
| tree | ae3735ac796341b614ba5837b2cb108e330accc2 | |
| parent | d0413e4e17564fea0b31379dc905e1638ca07ad2 (diff) | |
| download | buildstream-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.
| -rw-r--r-- | .gitlab-ci.yml | 1 | ||||
| -rw-r--r-- | doc/source/conf.py | 1 | ||||
| -rw-r--r-- | doc/source/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/invoking.rst | 8 |
4 files changed, 11 insertions, 0 deletions
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 765437273..b1b51b282 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -25,6 +25,7 @@ tests: pages: script: - pip3 install sphinx + - pip3 install sphinx-click - pip3 install --user -e . - make -C doc - mv doc/build/html public diff --git a/doc/source/conf.py b/doc/source/conf.py index 7d3ed6468..f702ecd0f 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -33,6 +33,7 @@ sys.path.insert(0, os.path.abspath('..')) extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.napoleon', + 'sphinx_click.ext' ] # Add any paths that contain templates here, relative to this directory. diff --git a/doc/source/index.rst b/doc/source/index.rst index c7651f473..648edd06d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -30,6 +30,7 @@ Here are some resources to help understand the BuildStream format and also to ge off the ground installing it on a new host. * :ref:`installing` +* :ref:`invoking` * :ref:`config` * :ref:`projectconf` * :ref:`format` 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: |