| 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.
|
| |
|
|
| |
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.
|
| |
|
|
| |
subdirectory
|
| |
|
|
|
|
| |
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.
|
| |
|
|
|
| |
We still have a few unused artifacts in the docs generation,
this is just one less.
|
| |
|
|
|
|
|
|
|
|
|
|
| |
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.
|
| |
|
|
|
| |
Instead add a comment about why this is really there,
and invoke sphinx python modules with python3 directly.
|
| |
|
|
|
|
|
|
|
|
| |
Some of the warnings from sphinx-build are really just warnings,
but a lot of the things we want to avoid and really break documentation,
like broken internal references and some invalid rst directives should
really be errors.
Now we treat all warnings as errors, this should ensure that
any commits landing upstream never break the docs.
|
| | |
|
| | |
|
| |
|
|
|
|
| |
Now that the sources and plugins directories have an __init__.py in
them, they appear in the documentation module index, just dont generate
any rst templates for them anymore.
|
| |
|
|
|
|
|
|
|
|
|
| |
This makes the 'sources' and 'elements' subdirectores modules technically,
but it does not effect how we load them with pluginbase, that still works.
Updated documentation machinery to have buildstream/plugins in the PYTHONPATH
and import the docs as elements.autotools etc.
This is all because since recent sphinx started importing from distutils,
this was conflicting with our distutils plugin.
|
| |
|
|
|
|
| |
Adding in experimental makefile and sphinx script to explicitly
run using python3 instead of assuming the python command points
to a python3.x binary
|
| |
|
|
| |
Replace sphinx-apidoc for plugin API docs generation.
|
| |
|
|
|
| |
Build main buildstream package documentation in source,
Build element and source plugins into separate directories.
|
| |
|
