summaryrefslogtreecommitdiffstats
path: root/documentation/.gitignore
Commit message (Collapse)AuthorAgeFilesLines
* manuals: add initial stylechecks with ValeMichael Opdenacker2024-03-191-0/+2
| | | | | | | | | | | | | Use the "Vale" (https://vale.sh) tool to perform text style checks Run "make stylecheck" to run the checks. This just checks the text, not the Sphinx syntax style choices. (From yocto-docs rev: d145e1dc45dc0792c8b8f7e73500b56face1e710) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: simplify .gitignore filesMichael Opdenacker2022-12-011-0/+1
| | | | | | | | | | | Remove obsolete and unnecessary ignores. Just found one .pyc file in documentation/sphinx/__pycache__, so ignored that directory. (From yocto-docs rev: 887ca562eb6f79674825a06c0fe2e8108fb7c8c4) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: auto-generate releases.rstQuentin Schulz2022-07-201-0/+1
| | | | | | | | | | | | | | | | | | | In order to maintain one less file, let's auto-generate the releases.rst file which contains a link for each release ever released. This gets auto-generated by checking the tags available in this git repo and adding a link for each that exists. A few tags are notoriously missing from this git repo and they are manually listed then, until the tags are pushed for the appropriate commit. Cc: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: c581eda3f87390b3e5223daff74d0ed6567ec51a) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* set_versions/switchers.js: Allow switchers.js version information to be ↵Richard Purdie2022-03-231-0/+1
| | | | | | | | | | | | | | | | autogenerated A horrible blunt hammer approach to updating the version information in switchers.js based on the available tag information. To merge and work correctly, this will need a change to the autobuilder-helper docs generation code to pull the swicthers.js and script from master, then to run the script. That should hopefully remove the need for other patching even on old docs branches though. (From yocto-docs rev: dc858c8b2ffdb792fe8cef05fab3d752aa858f78) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile/set_versions: Allow poky.yaml to be autogeneratedRichard Purdie2022-03-231-0/+1
| | | | | | | | | | | Use a script to generate the branch/tag information inside poky.yaml. If the branch isn't a known release branch, include git magic to find the closest matching release branch we know about. (From yocto-docs rev: 841e2df0e2e544b82fff9ddd0339a4e775148e3a) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile: allow epub and latexpdf outputs to use diagrams from SVG sourcesMichael Opdenacker2021-10-081-0/+2
| | | | | | | | | | | | | | | | | | | | | | html output is great when directly using SVG epub output has to use exported PNG because of issues using SVG directly latexpdf output cannot use SVG, it needs exported PDF instead This adds rules to generate PNG and PDF formats from new SVG sources. Newly added diagrams have be stored in svg/ subdirectories so that PNG and PDF files generated from SVG can be "gitignored" without ignoring the original PNG diagrams that have no SVG source. Note: had to remove the dependency to "Makefile" in the final "catch-all" target, otherwise it was also catching the SVG to PNG and SVG to PDF targets. (From yocto-docs rev: cd9bbd41d323bc124057396f142010509c65bbaf) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: add .vscode in .gitignoreNicolas Dechesne2020-12-031-0/+1
| | | | | | | (From yocto-docs rev: 0329a04de9def20b7dc24d58c301ab2a83fa3a6d) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Add Pipenv supportJoshua Watt2020-11-121-0/+1
| | | | | | | | | | Adds a Pipfile so that Pipenv can be used to automatically install all the dependencies required to build the documentation (From yocto-docs rev: 31658ad30827d38dcd4ea83bcfb828441c7c3eca) Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: add initial build infrastructureNicolas Dechesne2020-09-171-0/+1
Used sphinx-quickstart to generate top level config and Makefile.sphinx, to allow side by side DocBook and Sphinx co-existence. (From yocto-docs rev: 01dd5af7954e24552aca022917669b27bb0541ed) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>