| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
|
|
|
| |
Separate the revisioned provisional session html files such
that the git tree does not become dirty as a result of a
documentation build process - which messes up the docs version
number and the version number printed in some command line output.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
o doc/Makefile: Added new directory to collect rst files from
o doc/examples/first-project: Added the "first-project" example
project.
o doc/source/sessions/first-project-*.html: Added the generated
snippets
o doc/source/using_tutorial.rst: Added the new main tutorial page
o doc/source/tutorial/first-project.rst: Added part 1 of the tutorial here
o tests/examples/first-project.py: Added test for the example project
This is largely based on an example by Javier Jardón, which was
submitted at https://gitlab.com/BuildStream/buildstream/merge_requests/323
Fixes #103
|
| |
|
|
|
|
|
|
|
|
|
| |
If --force is not specified, then we'll skip session files in
the case that all of the outputs exist.
Now setting BST_FORCE_SESSION_REBUILD when building the docs
will cause the session files to be rebuilt regardless of whether
they exist or not.
The .gitlab-ci.yml was also changed to use this and force rebuilds.
|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
When specifying a fake-output string, we don't really run the command
or assume it was a `bst` command, and we pretend that `fake-output`
was the output of the command.
Specifying an empty string explicitly enables the behavior too
for faking a command that has no stdout/stderr.
This also adds the "remove-files" hack allowing the session scripts
to remove files before executing commands (kind of unsure if we're
gonna keep this...)
|
| |
|
|
| |
This list needs to not be quoted.
|
| |
|
|
|
|
|
|
|
|
| |
Before we were creating one description file for each output,
making it easier to declare a make rule for it - but the result
was that we would have to build things more and it takes a
long time.
Instead, now we have session files which describe a series of commands
to run in a session, and each command optionally produces an output file.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
o Giving main pages simple word titles
This makes the main page:
* About
* Installing
* Using
* Reference
* Contributing
o Now named all rst files with their parent page name as a prefix.
o Also changed some titles to make overall consistent titles.
|
| |
|
|
|
|
| |
This was a bad idea and doesnt play well with mobile UIs, better
off to just include the whole thing even if it's long, and let
the backing page handle vertical scrolling.
|
| |
|
|
|
|
|
| |
This is only to make it easier for people who just want to
build docs locally and not regenerate the session files.
The session snapshot html files are always generated in CI every time.
|
| |
|
|
| |
subdirectory
|
| |
|
|
| |
Show the commands at work in this example.
|
| |
|
|
|
| |
The Makefile uses these to run some scenarios which are
later included by the documentation directly.
|
| |
|
|
|
|
| |
If you need an example output of bst to put in the documentation,
just add a .run file to the doc/examples directory and it will result
in a similarly named .html file in doc/source/examples.
|
| |
|
|
|
|
|
| |
This baby runs bst and captures the output with colors enabled
and then generates some html we can include in documentation.
These can be generated in CI continuously and used in the documentation.
|
| | |
|
| |
|
|
|
|
| |
Seems that the "commands" is taking a lot of space such that
we can't see the other sections here easily, that is alright
if "commands" remains at the end.
|
| |
|
|
|
| |
Here we're really listing examples, a ToC with depth is
not great here.
|
| |
|
|
| |
project on gitlab.
|
| |
|
|
| |
This was named autotools-flatpak, changed to flatpak-autotools.
|
| |
|
|
|
| |
We still have a few unused artifacts in the docs generation,
this is just one less.
|
| | |
|
| | |
|
| |
|
|
|
| |
This is nice to have on the main page, and is only a few links, dont
like having a whole toplevel ToC entry for this.
|
| | |
|
| |
|
|
|
| |
Sphinx generates some library style module index, we just include
it in a hidden toctree and avoid using it altogether.
|
| |
|
|
|
|
|
|
|
|
|
|
| |
o Now the page titles are declared in plugins, allowing for
a more descriptive ToC
o Makefile and plugin.rsttemplate updated to not produce the title,
to no longer use `:orphan:` for plugin pages, and to ignore any
private modules in the plugin directories.
o Interestingly, now the docs will fail to build if you add
a new plugin and forget to add it to the documentation.
|
| |
|
|
|
| |
The main page has too much information on it otherwise, we want
a friendly, not overwhelming first page to our docs.
|
| | |
|
| |
|
|
|
|
|
|
|
|
|
| |
This has now changed to:
* Have explanations of the project.conf and each element
in the example, explaining what they are for
* Have links into the reference for the specific features
this example uses, such that the reader can get familiar
with the reference manual from example windows
|
| |
|
|
|
| |
This is redundant with doc/source/examples_flatpak_base.rst, lets
please only document things once.
|
| |
|
|
| |
We want one example per file, not a huge file full of different examples.
|
| |
|
|
|
|
|
|
| |
This adds:
o A ToC area for adding examples
o The instructive example page for the first example
o The example project under doc/examples
o The corresponding integration test in tests/examples
|
| | |
|
| | |
|
| |
|
|
| |
Summary files are no longer used.
|
| |
|
|
| |
An introduction for this section was also added
|
| |
|
|
| |
format version 8
|
| | |
|
| |
|
|
| |
See #358
|
| |
|
|
| |
See #358
|
| | |
|
| | |
|
| | |
|
| |
|
|
| |
Sections have 2 blank lines before them, and no blank line after them.
|
| | |
|
| |
|
|
|
|
|
|
|
| |
Seems this was not propperly rebased; libostree and bubblewrap requirements
are already there.
Also the paragraph about docker was removed in
commit f0b350f158ed14c97613dc22b83ed89759b8d255
This reverts commit 7854fc5037204474d16618c657a1cd1ca12c888e.
|
| |
|
|
| |
Drop the happy welcome phrase with exclamation point.
|
| | |
|
| | |
|
| | |
|
