| Commit message (Collapse) | Author | Age | Files | Lines | |
|---|---|---|---|---|---|
| * | doc/Makefile: Stage stored sessions from session-storedtristan/getting-started | Tristan Van Berkom | 2018-06-16 | 8 | -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 tutorial | Tristan Van Berkom | 2018-06-16 | 10 | -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 generator | Tristan Van Berkom | 2018-06-13 | 1 | -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 titles | Tristan Van Berkom | 2018-06-13 | 22 | -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 html | Tristan Van Berkom | 2018-06-12 | 1 | -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 Berkom | 2018-06-12 | 2 | -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 Berkom | 2018-06-12 | 2 | -10/+8 |
| | | | | | subdirectory | ||||
| * | doc/source/examples_flatpak_autotools.rst: Using generated examples | Tristan Van Berkom | 2018-06-12 | 1 | -4/+6 |
| | | | | | Show the commands at work in this example. | ||||
| * | doc: Removed some unused link targets | Tristan Van Berkom | 2018-06-09 | 5 | -14/+0 |
| | | |||||
| * | doc/source/main_using.rst: Reversed ToC here | Tristan Van Berkom | 2018-06-09 | 1 | -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 here | Tristan Van Berkom | 2018-06-09 | 1 | -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 Berkom | 2018-06-09 | 1 | -5/+9 |
| | | | | | project on gitlab. | ||||
| * | doc: Stop generating the modules index | Tristan Van Berkom | 2018-06-09 | 1 | -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 here | Tristan Van Berkom | 2018-06-09 | 1 | -2/+0 |
| | | |||||
| * | doc: Split out cache keys and sandboxing writings into a sub section | Tristan Van Berkom | 2018-06-09 | 2 | -4/+11 |
| | | |||||
| * | doc/source/index.rst: Add resources directly at the bottom of the main page | Tristan Van Berkom | 2018-06-09 | 2 | -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 links | Tristan Van Berkom | 2018-06-09 | 1 | -7/+10 |
| | | |||||
| * | doc/source/main_core.rst: Use a hidden toctree to hide away some things | Tristan Van Berkom | 2018-06-09 | 1 | -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 links | Tristan Van Berkom | 2018-06-09 | 2 | -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 page | Tristan Van Berkom | 2018-06-09 | 1 | -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 docs | Tristan Van Berkom | 2018-06-06 | 1 | -0/+1 |
| | | |||||
| * | doc/source/examples_flatpak_autotools.rst: Enhanced example | Tristan Van Berkom | 2018-05-16 | 1 | -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 examples | Tristan Van Berkom | 2018-05-16 | 2 | -29/+36 |
| | | | | | We want one example per file, not a huge file full of different examples. | ||||
| * | doc: Add first example, building on a flatpak SDK | albfan | 2018-05-16 | 2 | -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 aliases | Tristan Van Berkom | 2018-05-16 | 1 | -0/+2 |
| | | |||||
| * | doc/source/projectconf.rst: Added link anchors for project option types | Tristan Van Berkom | 2018-05-16 | 1 | -0/+10 |
| | | |||||
| * | doc/source/artifacts.rst: Drop section about summary file updates | Jürg Billeter | 2018-05-11 | 1 | -17/+0 |
| | | | | | Summary files are no longer used. | ||||
| * | commands.rst: Split up commands to easily allow for further description | James Ennis | 2018-05-04 | 1 | -1/+119 |
| | | | | | An introduction for this section was also added | ||||
| * | doc/source/projectconf.rst: Documenting ref-storage as available since ↵ | Tristan Van Berkom | 2018-04-26 | 1 | -1/+1 |
| | | | | | format version 8 | ||||
| * | doc: Clarify that junction sources are stored separately from project.refstristan/separate-junction-refs | Tristan Van Berkom | 2018-04-25 | 2 | -1/+5 |
| | | |||||
| * | doc/source/install.rst: Add requirements to use the bst cachejjardon/install_deps | Javier Jardón | 2018-04-24 | 1 | -0/+5 |
| | | | | | See #358 | ||||
| * | doc/source/install.rst: Add fuse to the list of dependencies | Javier Jardón | 2018-04-24 | 1 | -0/+1 |
| | | | | | See #358 | ||||
| * | doc/source/install.rst: Update build instructions for Fedora | Javier Jardón | 2018-04-24 | 1 | -2/+2 |
| | | |||||
| * | doc/source/install.rst: Update build instructions for Debian Testing/Sid | Javier Jardón | 2018-04-24 | 1 | -3/+2 |
| | | |||||
| * | doc/source/install.rst: Update install instruction for Debian strech | Javier Jardón | 2018-04-24 | 1 | -2/+2 |
| | | |||||
| * | doc/source/install.rst: Removing blank line which appeared below title | Tristan Van Berkom | 2018-04-23 | 1 | -1/+0 |
| | | | | | Sections have 2 blank lines before them, and no blank line after them. | ||||
| * | doc/source/install.rst: minimum bubblewrap version is 0.1.2 | Javier Jardón | 2018-04-23 | 1 | -1/+1 |
| | | |||||
| * | Revert "doc/source/install.rst: Mention bwrap version requirements" | Javier Jardón | 2018-04-23 | 1 | -6/+1 |
| | | | | | | | | | | Seems this was not propperly rebased; libostree and bubblewrap requirements are already there. Also the paragraph about docker was removed in commit f0b350f158ed14c97613dc22b83ed89759b8d255 This reverts commit 7854fc5037204474d16618c657a1cd1ca12c888e. | ||||
| * | doc/source/index.rst: Make main documentation title sober again. | Tristan Van Berkom | 2018-04-23 | 1 | -3/+3 |
| | | | | | Drop the happy welcome phrase with exclamation point. | ||||
| * | doc/source/install.rst: Mention bwrap version requirements | milloni | 2018-04-20 | 1 | -1/+6 |
| | | |||||
| * | doc/source/index.rst: Replace welcome paragraphjjardon/doc_readme | Javier Jardón | 2018-04-18 | 1 | -10/+7 |
| | | |||||
| * | Add about page | Javier Jardón | 2018-04-18 | 2 | -0/+2 |
| | | |||||
| * | main_core.rst: Change title and moved authoring, sandboxing and cachekeys ↵ | James Ennis | 2018-04-17 | 4 | -19/+6 |
| | | | | | documentation here | ||||
| * | core_framework.rst: New file containing content that was in main_core.rst | James Ennis | 2018-04-17 | 2 | -20/+19 |
| | | |||||
| * | config.rst: Renamed to user_config.rst and anchors changed | James Ennis | 2018-04-17 | 3 | -3/+3 |
| | | |||||
| * | invoking.rst: renamed to commands.rst (anchors also changed) | James Ennis | 2018-04-17 | 3 | -5/+5 |
| | | |||||
| * | Consistent titling | James Ennis | 2018-04-17 | 11 | -58/+58 |
| | | |||||
| * | index.rst: Remove unnecessary toctree blocks | James Ennis | 2018-04-17 | 1 | -15/+0 |
| | | |||||
| * | Add a general documentation section | James Ennis | 2018-04-17 | 3 | -5/+20 |
| | | |||||
| * | main_authoring.rst: move to using buildstream | James Ennis | 2018-04-17 | 3 | -6/+3 |
| | | |||||
 |
index : delta/buildstream.git | |
| gitlab.com: buildstream/buildstream.git |
| summaryrefslogtreecommitdiff |