summaryrefslogtreecommitdiff
path: root/doc/source
Commit message (Collapse)AuthorAgeFilesLines
* 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.
* doc/source/tutorial/running-commands.rst: Added tip about using `--` in `bst ↵Tristan Van Berkom2018-06-251-0/+10
| | | | shell`
* doc/source/tutorial/autotools.rst: Consistent wording of "chapter"Tristan Van Berkom2018-06-251-1/+1
| | | | | We've been calling these tutorials "chapters", let's not start also calling them "sections".
* doc/source/format_declaring.rst: Improving linkage to other parts of the manualTristan Van Berkom2018-06-251-1/+4
| | | | Adding a couple of important links to relevant material.
* doc/source/main_using.rst: Updating headline for this page.Tristan Van Berkom2018-06-251-1/+3
| | | | | The purpose of this page has changed with time, better to clarify this in the headline of the page.
* doc/source/core_plugins.rst, doc/source/install_main.rst: Fixing link anchor ↵Tristan Van Berkom2018-06-222-2/+2
| | | | | | | name In core_plugins.rst, we are already using _plugins, _plugins_build_elements, so lets call this one _plugins_sources to be consistent.
* BuildStream depends on host tools for Source pluginsJavier Jardón2018-06-222-0/+6
|
* doc/source/index.rst: fix tiny, but impactful typoPatrick Martin2018-06-221-1/+1
| | | | Fixes #435
* doc/source/examples/flatpak-autotools.rst: Reordering of titles.Tristan Van Berkom2018-06-181-10/+14
| | | | | | Place the titles of literally included `bst` files directly before the includes, and moved all related text to start below the included file for each section.
* doc: Use consistent titles when referring to files in an example projectTristan Van Berkom2018-06-182-10/+18
| | | | | | | | | | | | Use the following form across the board: ``elements/foo.bst`` ~~~~~~~~~~~~~~~~~~~~ .. literalinclude:: ../path/to/foo.bst :language: yaml Always use an example project relative path, too.
* doc/source/using_tutorial.rst: Use a numbered ToC for the tutorialTristan Van Berkom2018-06-181-0/+1
|
* doc: Adding part 3 of the getting started tutorial: autotools elementTristan Van Berkom2018-06-185-0/+372
| | | | | | | | | This part of the tutorial uses a lot of the work from Phil Dawson and James Ennis, and uses their example submitted on merge request 499 as a basis to introduce the user to yaml composition and variable resolution. This is a part of issue #103
* doc/source/tutorial/running-commands.rst: Adding summaryTristan Van Berkom2018-06-181-1/+22
| | | | And adding some link anchors needed by the incomming chapter.
* doc: Adding part 2 of the getting started tutorialTristan Van Berkom2018-06-177-0/+365
| | | | | | | | | | | | | o doc/examples/running-commands: New example project of a `manual` build element o doc/sessions/running-commands.run: New session file to capture bst output o doc/source/sessions-stored: Added new generated sessions o doc/source/tutorial/running-commands.rst: New tutorial entry describing how commands are run in the sandbox o tests/examples/running-commands.py: Test case validating the tutorial's assertions
* doc/source/tutorial/first-project.rst: Adding linksTristan Van Berkom2018-06-171-3/+6
| | | | | Linking out to the relevant invoking pages for the command line reference, and adding a link anchor here for use by the next chapter.
* doc/Makefile: Stage stored sessions from session-storedtristan/getting-startedTristan Van Berkom2018-06-168-0/+0
| | | | | | | 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.
* doc: Adding part 1 of the getting started tutorialTristan Van Berkom2018-06-1610-0/+235
| | | | | | | | | | | | | | | | | | | | | 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
* doc: Improve the new console output html generatorTristan Van Berkom2018-06-131-13/+13
| | | | | | | | | | 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.
* doc: Overhaul of page names and titlesTristan Van Berkom2018-06-1322-41/+43
| | | | | | | | | | | | | | | | 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.
* doc: Don't allow setting a height on the generated session htmlTristan Van Berkom2018-06-121-14/+14
| | | | | | 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.
* doc/source/sessions: Committing generated session files.Tristan Van Berkom2018-06-122-0/+168
| | | | | | | 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.
* doc/source/examples.rst: Restructuring individual examples into an examples ↵Tristan Van Berkom2018-06-122-10/+8
| | | | subdirectory
* doc/source/examples_flatpak_autotools.rst: Using generated examplesTristan Van Berkom2018-06-121-4/+6
| | | | Show the commands at work in this example.
* doc: Removed some unused link targetsTristan Van Berkom2018-06-095-14/+0
|
* doc/source/main_using.rst: Reversed ToC hereTristan Van Berkom2018-06-091-2/+2
| | | | | | 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.
* doc/source/examples.rst: Use a flat ToC hereTristan Van Berkom2018-06-091-1/+1
| | | | | Here we're really listing examples, a ToC with depth is not great here.
* doc/source/examples_flatpak_autotools.rst: Added some links to the example ↵Tristan Van Berkom2018-06-091-5/+9
| | | | project on gitlab.
* doc: Stop generating the modules indexTristan Van Berkom2018-06-091-1/+1
| | | | | We still have a few unused artifacts in the docs generation, this is just one less.
* doc/source/authoring.rst: Removed unneeded link anchor from hereTristan Van Berkom2018-06-091-2/+0
|
* doc: Split out cache keys and sandboxing writings into a sub sectionTristan Van Berkom2018-06-092-4/+11
|
* doc/source/index.rst: Add resources directly at the bottom of the main pageTristan Van Berkom2018-06-092-11/+8
| | | | | 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.
* doc/source/core_framework.rst: Use a toctree instead of linksTristan Van Berkom2018-06-091-7/+10
|
* doc/source/main_core.rst: Use a hidden toctree to hide away some thingsTristan Van Berkom2018-06-091-0/+10
| | | | | Sphinx generates some library style module index, we just include it in a hidden toctree and avoid using it altogether.
* doc: Added plugins as ToC elements instead of orphaned linksTristan Van Berkom2018-06-092-38/+33
| | | | | | | | | | | | 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.
* doc/source/index.rst: Use only one level depth ToC on main pageTristan Van Berkom2018-06-091-1/+1
| | | | | The main page has too much information on it otherwise, we want a friendly, not overwhelming first page to our docs.
* doc/source/authoring.rst: Adding `make` element to the docsTristan Van Berkom2018-06-061-0/+1
|
* doc/source/examples_flatpak_autotools.rst: Enhanced exampleTristan Van Berkom2018-05-161-12/+117
| | | | | | | | | | | 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
* doc/source/examples.rst: Rearranged ToC for examplesTristan Van Berkom2018-05-162-29/+36
| | | | We want one example per file, not a huge file full of different examples.
* doc: Add first example, building on a flatpak SDKalbfan2018-05-162-0/+41
| | | | | | | | 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
* doc/source/projectconf.rst: Added link anchor for source aliasesTristan Van Berkom2018-05-161-0/+2
|
View Lorry Controller Status