summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2024-11-06 08:48:26 +0100
committerSteve Sakoman <steve@sakoman.com>2024-11-18 06:59:35 -0800
commit1371c1106beff6e33cfb46d5c509d42e566eb50c (patch)
tree4916ed274485b9ae5d8805da2ed73b7aa6e550f5 /documentation
parent656b0274b2b93ae6c2669678b2908f90f0b0e30c (diff)
downloadpoky-1371c1106beff6e33cfb46d5c509d42e566eb50c.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: a422a2f4fe452d6f01685717961f6acdf09217de) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 38aa55418426227203fe3a106fa1e85494a57c12) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
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