summaryrefslogtreecommitdiff
path: root/doc/source
Commit message (Collapse)AuthorAgeFilesLines
...
* doc: Adding the release badges to the install page and the semantic ↵Tristan Van Berkom2018-08-294-4/+65
| | | | | | versioning page This is a part of #528
* doc: Adding badges.py release badge generatorTristan Van Berkom2018-08-291-1/+1
| | | | | | | | This adds a step to the docs generation Makefile to generate release.svg and snapshot.svg badges, modelled after the gitlab badges. This also adds the generated badges directory in docs to .gitignore
* doc/source/conf.py: Fix E402 warningJavier Jardón2018-08-281-2/+2
|
* doc/source/conf.py: Fix E201, E202 warningsJavier Jardón2018-08-281-1/+1
|
* doc/source/main_install.rst: Clarify that BuildStream cannot be run on WindowsTristan Van Berkom2018-08-271-4/+6
| | | | | | | | The previous wording was misleading and caused one to think you can run BuildStream on Windows, this commit fixes that and rewords the main section heading to be a bit more abstract. Fixes issue #608
* doc/source/install_source.rst: Explain about release tag in git install ↵Tristan Van Berkom2018-08-252-0/+17
| | | | | | | | instructions. This obsoletes Laurence's explanation in merge request !657, and is a part of the initiative of issue #528 to clarify which versions users should be installing.
* Add section about current releasesTristan Van Berkom2018-08-252-0/+19
| | | | | | | | This is not ideal as the releases are hardcoded, but I think is better than nothing until we got a solution to automate this This commit was originally by Javier Jardón <jjardon@gnome.org> from merge request !661, and then later reworked into an install guide refactor.
* doc/source/install_source.rst: Splitting up install instructionsTristan Van Berkom2018-08-253-255/+281
| | | | | | | Instead of having all of this on one page, we now have a much simpler page for installing on distros where BuildStream is packaged and a separate page for installing distro specific system dependencies and installing from source code (either from PyPI or git).
* doc/source/main_install.rst: Move the main install link target hereTristan Van Berkom2018-08-252-1/+4
| | | | | This is referred to from the artifact install guide, and was previously pointing directly to the source install guide.
* doc/source/main_install.rst: Use one level depth toctreeTristan Van Berkom2018-08-251-1/+1
| | | | | This main section is just a choice of subsections, lets make this more clear with a single level depth toctree.
* doc/source/developing/workspaces.rst: Some whitespace fixesTristan Van Berkom2018-08-251-3/+2
| | | | | Some whitespace changes to follow the style regarding empty lines between sections.
* workspaces.rst: fix note which is not rendering correctlyPhil Dawson2018-08-251-0/+1
|
* workspaces.rst: Move terminal sessions to doc/source/sessions-stored/Phil Dawson2018-08-258-0/+0
|
* doc: Add instructions to install BuildStream via PyPIChandan Singh2018-08-241-5/+36
| | | | | | | Add instructions to install and update BuildStream python package via PyPI, and also make it the recommended method. Part of https://gitlab.com/BuildStream/buildstream/issues/587.
* Add pip source pluginChandan Singh2018-08-151-0/+1
| | | | | | | | | | | `pip` source plugin can stage python packages that are either specified directly in the element definition or picked up from `requirements.txt` from previous sources. In order to support the latter use-case (which is also the primary motivation for this plugin), this plugin requires access to previous sources and hence is an example of a Source Transform source. Also, bump `BST_FORMAT_VERSION` as this patch adds a new core plugin.
* docs: Add documentation for Configurable WarningsJosh Smith2018-08-151-11/+18
| | | | This includes detailing the use of `fatal-warnings` within project.conf
* docs: Add documentation of build-depends and runtime-depends fieldsJonathan Maw2018-08-141-2/+66
|
* doc: Fix install instructions for FedoraChandan Singh2018-08-121-1/+2
| | | | | | | | | `python3-arpy` package is not available on Fedora so it has to be installed using `pip`. Update instructions accordingly. For reference, here is a pipeline that failed when trying to install `arpy` using current instructions: https://gitlab.com/BuildStream/buildstream-docker-images/-/jobs/88553245.
* install_linux_distro.rst: Change install instructions for python-arpy ↵jennis/change_arch_install_instructionsJames Ennis2018-08-071-2/+13
| | | | | | | | package on Arch - python-arpy is unobtainable via pacman - Also a minor change to how we display install instructions from Fedora's dnf package manager
* source/install_linux_distro.rst: Fix formattingJavier Jardón2018-08-071-0/+2
|
* Add systemd service file examples to artifacts documentationAdam Jones2018-08-071-0/+44
| | | | change code style to ini
* source/install_linux_distro.rst: Make clearer ArchLinux packages availableJavier Jardón2018-08-071-5/+4
|
* install_linux_distro.rst: Fix broken linksJames Ennis2018-08-061-2/+2
|
* doc: Mention the Fedora packagesMathieu Bridon2018-08-061-0/+12
| | | | These aren't official yet, but they should work.
* doc: Fix junctions user guide to refer to doc/sessions, not doc/sessions-stored.Tristan Van Berkom2018-08-051-3/+4
|
* Add support for include '(@)' in project.conf and .bst filesValentin David2018-08-021-0/+44
| | | | Fixes #331.
* local plugin: validate project pathsTiago Gomes2018-08-021-2/+2
| | | | | | The autotools example had to be copied over inside of the junction example, as referring to a path outside of the project directory is now disallowed.
* install_linux_distro.rst: Add install instructons for UbuntuPhil Dawson2018-08-011-0/+24
| | | | This commit is part of the work required to resolve issue #436
* tutorials: Add workspaces tutorialPhil Dawson2018-08-013-0/+110
| | | | This is part of the work towards issue #437
* doc/sessions: Add terminal sessions for use in workspaces tutorialPhil Dawson2018-08-018-0/+213
| | | | This is part of the the work towards issue #437
* junction-elements.rst: Add missing language specifier to literalincludephil/fixup-junctions-tutorialPhil Dawson2018-07-301-0/+1
| | | | | | A missing language specifier on a literal include directive results in yaml being rendered as python code. This commit adds the :language: tag to that directive.
* using_advanced_features.rst: Added fileJames Ennis2018-07-302-0/+14
|
* junction-elements.rst: Add junctions walkthroughPhil Dawson2018-07-301-0/+72
| | | | This is part of the work towards #437.
* junctions.run: Add terminal session output for junctions walkthrough.Phil Dawson2018-07-303-0/+192
| | | | This is part of the work towards #437.
* doc: Add tutorials for setting up git and tar mirrorsJonathan Maw2018-07-273-0/+249
|
* doc: Add documentation for source mirroringJonathan Maw2018-07-272-0/+58
|
* main_install.rst: Add note to refer Windows and macOS users to dockerJames Ennis2018-07-271-1/+6
|
* Documentation typos and fixesWilliam Salmon2018-07-266-13/+13
| | | | | | Daniel went through the Doc's etc and made a list of suggestions. These are the result of the most easily patched suggestions and one or two thing that I noticed as well.
* Add remote source pluginEd Baunton2018-07-251-0/+1
| | | | | | | | Add a plugin that supports downloading files verbatim from a source with an optional overridable filename and destination directory. Bumps bst format version to 10. Fixes #163
* doc/source/install_linux_distro.rst: buildstream doesn't depend on ostree or ↵jjardon/ostree_repoJavier Jardón2018-07-231-22/+15
| | | | pygobject anymore
* install_linux_distro.rst: Document plugins deps for the rest of the systemsJavier Jardón2018-07-201-2/+16
|
* install_linux_distro.rst: document plugins installed by defaultJavier Jardón2018-07-201-0/+8
|
* Added dependency to the DocsWilliam Salmon2018-07-201-0/+5
| | | | | | | | | | | These dependencies are needed to use the plugins that are installed as part of this guild. As the dependencies added are not dependencies of the core package they have been added to a separate section. The lzip package is needed to build gnome. https://wiki.gnome.org/Newcomers/BuildSystemComponent
* Docs: Update the required build packages for the rest of the systemsJavier Jardón2018-07-201-9/+10
| | | | | | | Also remove the recomendation to install psutil as we need to build other python modules anyway (like ruamel) Completes 96d07153b7817cdaeda57dd163eed52b2b1b31e8
* Docs: Update the required build packages for fedora based systems.Jordan Petridis2018-07-201-1/+1
| | | | | | `ruamel.yaml` seems to require `Python.h` header file to build. `python3-devel` is what provides it for Fedora.
* Bump required python version to 3.5Tristan Maat2018-07-181-1/+1
|
* Fix 'main install' to be explicit that it is for Linux distros onlydevcurmudgeon2018-07-172-5/+3
|
* Adding a helpful link to the exampleWilliam Salmon2018-07-171-1/+1
|
* doc/source/artifacts.rst: Update documentation for CAS artifact serverJürg Billeter2018-07-171-76/+64
|
* doc: Adding part 4 of the getting started tutorial: integration commandsTristan Van Berkom2018-06-255-0/+319
| | | | | This new section talks about how integration commands work and shows them at work.