summaryrefslogtreecommitdiff
path: root/doc/source/index.rst
Commit message (Collapse)AuthorAgeFilesLines
* Documentation: Restructured toplevel documentationdocs-reorganizationTristan Van Berkom2018-01-171-53/+5
| | | | | | | | | | | | | | | | | | | | | This is intended to make things easier to find for the various types of people searching for stuff. o The installation instructions remain on the main page. o Three main separate pages have been created - Using BuildStream - Authoring BuildStream projects - Core API reference, for plugin authors o The "Authoring projects" section swallows the previous plugin index; so one can find the plugin one is looking for on the same page as the rest of the format docs o The plugin authoring section has been swallowed by the core API reference section, with a note that this is useful especially for plugin authors.
* doc/source/projectconf.rst: Documenting plugin loading section.Tristan Van Berkom2018-01-081-0/+1
| | | | | | | | | | | | | This fixes issue #183. Also move the `format-version` related documentation to the first section "Essentials", beside the project name and element path, since this is a quite global option it belongs here and not hidden away with the plugin loading documentation. Also adjust the main index.rst to include the plugins sub-section as an adjacent sub-point of the project configuration (consistent with other project configuration sections).
* Documentation: Fix warnings, and make all warnings errors.Tristan Van Berkom2018-01-051-0/+3
| | | | | | | | | | 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.
* doc: Add cache key documentationjuerg/cache-key-docJürg Billeter2017-12-201-0/+5
|
* Update documentation to refer to new home of dpkg and x86image elementsjonathan/external-pluginsJonathan Maw2017-10-261-0/+5
|
* doc/source/formatintro.rst: Documenting list composition directiveslist-composition-directivesTristan Van Berkom2017-10-171-1/+1
|
* Restructuring documentation and documenting project optionsoptions-refactorTristan Van Berkom2017-10-101-61/+34
|
* doc/source/index.rst: Fix documentation to link the correct Sandbox moduleTristan Van Berkom2017-10-021-1/+1
|
* Add documentationTristan Maat2017-09-141-0/+1
|
* Adding new patch source to the docs index.Tristan Van Berkom2017-09-091-0/+1
|
* doc/source/completion.rst: Added some docs on setting up bash completionsTristan Van Berkom2017-08-281-0/+1
|
* Add a pip elementMathieu Bridon2017-08-101-0/+1
| | | | | | | | | | | | | | | | | | | Packaging is a big topic in the Python community these days. Things are evolving, but a consensus seems to have formed around the path forward. With PEP 518, Pip is becoming the primary tool to install Python modules. In turn, Pip will use the right underlying tool for the job. (distutils, setuptools, flint, ...) Given all this, it makes sense to have a pip element in BuildStream. This element installs a single Python module, telling Pip not to go and download its dependencies, to make builds reproducible and not rely on the network during builds. By default it will use the `pip` command which generally points to Pip for Python 2. Users can override the "pip" variable, for example to use the `pip3` command, which generally points to Pip for Python 3.
* Add documentation links to dpkg_build and dpkg_deploy elementsJonathan Maw2017-07-191-0/+2
|
* Adding documentation about setting up artifact caches.Tristan Van Berkom2017-07-101-0/+1
|
* Added documentation about public data in the bst domain.Tristan Van Berkom2017-06-301-0/+2
|
* Added x86image element to the documentationTristan Van Berkom2017-06-061-0/+1
|
* Documentation: Adding bzr source to the docs indexTristan Van Berkom2017-05-251-0/+1
|
* Added __init__.py to the plugin subdirectories.Tristan Van Berkom2017-05-241-16/+16
| | | | | | | | | | | 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.
* Documentation: Added "Invoking BuildStream" user facing documentationTristan Van Berkom2017-05-031-0/+1
| | | | | | This is using the relatively new `sphinx-click` plugin and will automatically update the documentation based on whatever changes in the frontend.
* Documentation: Added user facing project configuration sectionTristan Van Berkom2017-05-031-0/+1
| | | | | | | | | | Instead of documenting this in the Project object, provide a section more targetted at users. The default configuration is shown in the user facing documentation and removed from the Project object documentation which is more targetted at API references for plugin authors. References to the Project Configuration from the format documentation have been updated to refer to this new section.
* Documentation: Added user facing configuration sectionTristan Van Berkom2017-05-031-0/+1
| | | | | | | Instead of documenting this in the Context object, provide a section more targetted at users. The default configuration is shown in the user facing documentation and removed from the Context object documentation which is more targetted at API references for plugin authors.
* Documentation: Created "Installing BuildStream" SectionTristan Van Berkom2017-04-181-8/+10
| | | | | | Included pedro's docker documentation at the end of this, as an alternative for those who cannot obtain the base system requirements to use BuildStream.
* Add Dockerfile and instructions for running BuildStream with DockerPedro Alvarez Piedehierro2017-04-181-0/+1
|
* Adding tar source plugin documentation linksTristan Van Berkom2017-04-131-1/+2
|
* Added new script element.Tristan Van Berkom2017-04-021-0/+1
| | | | | | This allows quite manual transformations of input, allowing one to select a base for the shell and tooling to use and stage the input separately in order to create some output.
* Documentation index: Started categorizing elementsTristan Van Berkom2017-03-161-4/+12
| | | | Split up General Elements from Build Elements
* Added new compose elementTristan Van Berkom2017-03-151-0/+1
| | | | This creates a selective composition of its dependencies.
* Facelift for documentation main index.Tristan Van Berkom2017-03-101-19/+20
|
* Added new meson build element to the documentation indexTristan Van Berkom2017-02-091-0/+1
|
* Added symbolic stack elementTristan Van Berkom2017-02-011-0/+1
|
* ostree.py: Include ostree plugin on the main docs and some docs touchups.Tristan Van Berkom2017-01-261-3/+3
|
* import.py: Added new import elementTristan Van Berkom2017-01-181-0/+1
| | | | | This element simply stages it's sources and collects a sandbox relative directory to wrap into an artifact.
* plugin.py: Added new Plugin base class.Tristan Van Berkom2017-01-071-0/+1
| | | | | | | This just shares some common aspects of being a plugin in buildstream, allowing some code sharing between Element and Source interfaces. This class also swallows up the utils node handling utilities.
* Adding Perl Module::Build build elementTristan Van Berkom2016-12-311-0/+1
|
* Adding Perl MakeMaker build elementTristan Van Berkom2016-12-311-1/+2
|
* Adding python distutils elementTristan Van Berkom2016-12-311-0/+1
|
* Adding qmake build element for qmake build systemTristan Van Berkom2016-12-311-0/+1
|
* Adding cmake build elementTristan Van Berkom2016-12-311-0/+1
|
* Adding autotools build elementTristan Van Berkom2016-12-311-1/+2
|
* Documentation: Reorganized the index a bitTristan Van Berkom2016-12-311-4/+5
|
* Adding in basic sandbox interface classAndrew Leeming2016-12-151-0/+1
| | | | | | | | Sandbox has two implementations: bwrap and chroot Bwrap has quite a comprehensive implementation, whereas chroot just covers the basic directory mappings/mounts.
* Documentation: Added link to new local source pluginTristan Van Berkom2016-12-151-0/+1
|
* Initial writeup of Project object, holding project configuration.Tristan Van Berkom2016-12-141-0/+1
| | | | | This also adds the default configuration file and adds a link to the Project documentation in the docs index
* Adding public utility functions for fetching yaml node valuesTristan Van Berkom2016-12-131-0/+1
| | | | | Needed by both Element and Source implementations, but let's not give them the whole _yaml API.
* Adding new documentation on the general BuildStream formatTristan Van Berkom2016-11-281-0/+9
|
* Main docs index: Refer to things by their module, not their class.Tristan Van Berkom2016-11-151-5/+5
|
* Documentation skeleton touchupsTristan Van Berkom2016-11-151-7/+3
| | | | | | * Remove obnoxious entry in sidebar * Remove search page access from bottom of main page, search is available in sidebar
* Rename InvocationContext -> ContextTristan Van Berkom2016-11-141-1/+1
| | | | | It's a bit big and wordy, looks like it makes sense to just call it "Context".
* documentation: Added InvocationContext to main sectionTristan Van Berkom2016-11-141-0/+1
|
* documentation index: Added basic documentation skeletonTristan Van Berkom2016-11-091-5/+33
|
View Lorry Controller Status