summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* 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.
* format.rst: Enhanced buildstream format documentationTristan Van Berkom2017-01-071-11/+173
| | | | | | | o Added documentation for variables o Added documentation about element composition, so that the priority of element composition is clear.
* 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.
* Merge branch 'leeming/project-conf-rename' into 'master' Tristan Van Berkom2017-01-041-2/+2
|\ | | | | | | | | Renaming root project configuration file from project.yaml to project.conf for extra clarity See merge request !12
| * Renaming root project configuration file from project.yaml to project.conf ↵Andrew Leeming2017-01-041-2/+2
| | | | | | | | for extra clarity
* | Sphinx to not assume python3 is the default python versionAndrew Leeming2017-01-042-0/+33
|/ | | | | | Adding in experimental makefile and sphinx script to explicitly run using python3 instead of assuming the python command points to a python3.x binary
* 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
|
* Format docs fixesTristan Van Berkom2016-12-141-3/+4
| | | | | | Specify project configuration as project.yaml, not project.conf. Also refer to the new Project docs from the format documentation.
* 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.
* Docs hackingTristan Van Berkom2016-12-132-2/+36
| | | | Replace sphinx-apidoc for plugin API docs generation.
* Complete first writeup of format documentationTristan Van Berkom2016-12-101-27/+270
|
* Adding new documentation on the general BuildStream formatTristan Van Berkom2016-11-282-0/+162
|
* 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-152-7/+8
| | | | | | * 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 config changesTristan Van Berkom2016-11-141-2/+2
| | | | | * Dont show module paths on function/class docs * Sort the module index ignoring the buildstream prefix
* Docs configuration changesTristan Van Berkom2016-11-141-0/+3
| | | | | | | | | | | - Enable sphinx.ext.napoleon extension Allows generation of docs from nicer looking docstrings - autodoc_member_order = 'bysource' Ensure class/module documentation orders the docs in the same order documentation was encountered in the source code
* documentation index: Added basic documentation skeletonTristan Van Berkom2016-11-091-5/+33
|
* Testing out links in index.rstTristan Van Berkom2016-11-091-0/+4
|
* documentation Makefile: Getting all the docs builtTristan Van Berkom2016-11-091-210/+18
| | | | | Build main buildstream package documentation in source, Build element and source plugins into separate directories.
* Adding sphinx doc stuffTristan Van Berkom2016-11-083-0/+592