diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-05-16 14:12:30 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-05-16 16:51:31 +0900 |
| commit | b98791cb41f0b9871a1e93a231ef366b124912f8 (patch) | |
| tree | 0ce2be75a6e4ec29b5d9d6f364aaf9fa6d3f90f4 | |
| parent | b7e75da3f75495097874957591a6b861c156dc5f (diff) | |
| download | buildstream-b98791cb41f0b9871a1e93a231ef366b124912f8.tar.gz | |
doc/source/examples.rst: Rearranged ToC for examples
We want one example per file, not a huge file full of different examples.
| -rw-r--r-- | doc/source/examples.rst | 32 | ||||
| -rw-r--r-- | doc/source/examples_flatpak_autotools.rst | 33 |
2 files changed, 36 insertions, 29 deletions
diff --git a/doc/source/examples.rst b/doc/source/examples.rst index 156dc9549..cebba27ad 100644 --- a/doc/source/examples.rst +++ b/doc/source/examples.rst @@ -7,34 +7,8 @@ This page contains documentation for real examples of BuildStream projects, described step by step. All run under CI, so you can trust they are maintained and work as expected. -for detail info go to :ref:`authoring`. ------ - -Using flatpak runtimes to build and run from source - -Config files - -- project.conf - -.. literalinclude:: ../examples/flatpak-autotools/project.conf - :language: yaml - -- element - -.. literalinclude:: ../examples/flatpak-autotools/elements/flatpak-autotools.bst - :language: yaml - -- element - -.. literalinclude:: ../examples/flatpak-autotools/elements/dependencies/usrmerge.bst - :language: yaml - -Building:: - - bst build flatpak-autotools.bst - -Running:: - - bst shell flatpak-autotools.bst hello +.. toctree:: + :maxdepth: 2 + examples_flatpak_autotools diff --git a/doc/source/examples_flatpak_autotools.rst b/doc/source/examples_flatpak_autotools.rst new file mode 100644 index 000000000..d30e5435d --- /dev/null +++ b/doc/source/examples_flatpak_autotools.rst @@ -0,0 +1,33 @@ + +.. _examples_flatpak_autotools: + +Using flatpak runtimes to build and run from source +=================================================== +Here we demonstrate how to build and run software using +a Flatpak SDK for the base runtime. + +Config files + +- project.conf + +.. literalinclude:: ../examples/flatpak-autotools/project.conf + :language: yaml + +- element + +.. literalinclude:: ../examples/flatpak-autotools/elements/flatpak-autotools.bst + :language: yaml + +- element + +.. literalinclude:: ../examples/flatpak-autotools/elements/dependencies/usrmerge.bst + :language: yaml + +Building:: + + bst build flatpak-autotools.bst + +Running:: + + bst shell flatpak-autotools.bst hello + |