summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2024-11-06 08:48:26 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-11-12 11:09:51 +0000
commitb5cb33f1f4fbd9896cd6b5e53ac81efb7b41d150 (patch)
treecfe8ecaba73bab0c398e799603625ceea6ad1ac4 /documentation
parentc2fb6065027987aa10f20d5ded614a2af05e2319 (diff)
downloadpoky-b5cb33f1f4fbd9896cd6b5e53ac81efb7b41d150.tar.gz
doc: add a download page for epub and pdf
These files are placed in the _static directory during publish. Note that Sphinx does not complain if files do not exist during compilation (since they are copied at the end). This is why this was used instead of the ":download:" role. (From yocto-docs rev: 3b9287eb5cde22cf5be48734d63efbd30c66ef06) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/downloads.rst11
-rw-r--r--documentation/index.rst7
2 files changed, 18 insertions, 0 deletions
diff --git a/documentation/downloads.rst b/documentation/downloads.rst
new file mode 100644
index 0000000000..7ec978ef2d
--- /dev/null
+++ b/documentation/downloads.rst
@@ -0,0 +1,11 @@
1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
2
3=======================
4Documentation Downloads
5=======================
6
7The documentation can be downloaded in file formats to be read offline or on
8another device. The currently supported formats are linked below:
9
10- `EPub <_static/TheYoctoProject.epub>`_
11- `PDF <_static/theyoctoproject.pdf>`_
diff --git a/documentation/index.rst b/documentation/index.rst
index 3fef1704a4..6c6be38a7e 100644
--- a/documentation/index.rst
+++ b/documentation/index.rst
@@ -51,3 +51,10 @@ Welcome to the Yocto Project Documentation
51 :hidden: 51 :hidden:
52 52
53 genindex 53 genindex
54
55.. toctree::
56 :maxdepth: 1
57 :caption: Documentation Downloads
58 :hidden:
59
60 downloads