summaryrefslogtreecommitdiff
path: root/doc/bst2html.py
Commit message (Collapse)AuthorAgeFilesLines
* doc/bst2html.py: Error out if bst command in doc failsctolentino82019-10-071-2/+5
|
* node: Add 'get_str_list' on 'MappingNode'Benjamin Schubert2019-07-171-1/+1
| | | | | | `mapping.get_sequence(...).as_str_list()` is a very common pattern seen both in plugins and the core. Adding a helper to reduce the number of operations will make usage smoother
* _yaml: Decomission 'dump()'. 'roundtrip_dump' is an equivalent function nowBenjamin Schubert2019-07-151-1/+1
| | | | | Remove completely '_yaml.dump()' and replace all notions and call by 'roundtrip_dump'
* _yaml: Remove 'node_items' and add 'MappingNode.items()'Benjamin Schubert2019-07-151-1/+2
| | | | | | One difference is that 'MappingNode.items()' does not strip the provenance from scalars and lists, which ends up not affecting the code much.
* doc/bst2html: Remove usage of 'node_get' and use new APIBenjamin Schubert2019-07-151-13/+11
|
* _yaml.pyx: Forbid expected_type=Mapping, and remove isinstance checkBenjamin Schubert2019-06-031-3/+2
| | | | | | | | | | | Calls to `isinstance` can be particularily costly. Using type() is much faster. The only known case where the `isinstance` was useful is for dictionnaries where we would ask for a 'Mapping' instead. Disallowing 'Mapping' for expected_type considerably speeds up the calls to this functions. Also add into NEWS
* cachedir: add new dir option that's default root to other dirsRaoul Hidalgo Charman2019-02-191-4/+1
| | | | | | Makes artifactdir and builddir obsolete. Fixes #870
* Fix spelling of it's and itsRichard Dale2018-10-161-1/+1
|
* bst2html.py: Name the second argument to avoid an errorjmac/doc-argument-fixJim MacArthur2018-10-161-1/+1
|
* update HACKING referencesAdam Jones2018-09-171-1/+1
|
* Fix E741 warningsjjardon/pycodestyle_fixesJavier Jardón2018-08-281-2/+2
|
* Fix E305 warningsJavier Jardón2018-08-281-0/+1
|
* doc/bst2html.py: Fix deprecation warningJavier Jardón2018-08-261-1/+1
| | | | | | | | This fixes the following: " /home/jjardon/buildstream/buildstream/doc/bst2html.py:32: DeprecationWarning: Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated, and in 3.8 it will stop working from collections import Mapping "
* doc: Some modifications to the bst2html programTristan Van Berkom2018-08-051-71/+34
| | | | | | | | | | | o Added feature to allow running shell commands o Removed unused codepaths to launch bst commands through the script, this program is anyway only used to parse and run the session files. o Fixed previous patch to run BuildStream uninstalled with the subprocess module, as running it in the same interpretor causes a bunch of problems.
* doc: Build the docs without Buildstream installedbochecha/build-docsMathieu Bridon2018-08-041-4/+24
|
* doc/bst2html.py, doc/Makefile: Added --force optionTristan Van Berkom2018-06-161-4/+51
| | | | | | | | | | | If --force is not specified, then we'll skip session files in the case that all of the outputs exist. Now setting BST_FORCE_SESSION_REBUILD when building the docs will cause the session files to be rebuilt regardless of whether they exist or not. The .gitlab-ci.yml was also changed to use this and force rebuilds.
* doc/bst2html.py: Add support for `fake-output` when running commands.Tristan Van Berkom2018-06-161-21/+46
| | | | | | | | | | | | | When specifying a fake-output string, we don't really run the command or assume it was a `bst` command, and we pretend that `fake-output` was the output of the command. Specifying an empty string explicitly enables the behavior too for faking a command that has no stdout/stderr. This also adds the "remove-files" hack allowing the session scripts to remove files before executing commands (kind of unsure if we're gonna keep this...)
* doc: Improve the new console output html generatorTristan Van Berkom2018-06-131-115/+188
| | | | | | | | | | 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: Don't allow setting a height on the generated session htmlTristan Van Berkom2018-06-121-10/+0
| | | | | | 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/bst2html.py: Added bst2html.pyTristan Van Berkom2018-06-121-0/+345
This baby runs bst and captures the output with colors enabled and then generates some html we can include in documentation. These can be generated in CI continuously and used in the documentation.