diff mbox series

[4/5] doc: add a download page for epub and pdf

Message ID 20241106-pdf-xetex-v1-4-044eab7e77d3@bootlin.com
State New
Headers show
Series Add support for PDF/Epub generation | expand

Commit Message

Antonin Godard Nov. 6, 2024, 7:48 a.m. UTC 
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.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/downloads.rst | 11 +++++++++++
 documentation/index.rst     |  7 +++++++
 2 files changed, 18 insertions(+)
diff mbox series

Patch

diff --git a/documentation/downloads.rst b/documentation/downloads.rst
new file mode 100644
index 0000000000000000000000000000000000000000..7ec978ef2da80c33f4e3b2aab47320ef01973187
--- /dev/null
+++ b/documentation/downloads.rst
@@ -0,0 +1,11 @@ 
+.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
+
+=======================
+Documentation Downloads
+=======================
+
+The documentation can be downloaded in file formats to be read offline or on
+another device. The currently supported formats are linked below:
+
+-  `EPub <_static/TheYoctoProject.epub>`_
+-  `PDF <_static/theyoctoproject.pdf>`_
diff --git a/documentation/index.rst b/documentation/index.rst
index 3fef1704a481da9e5e4c697a8efa995525ae5e6a..6c6be38a7e8c46bcc910d14abdc18f78b200c399 100644
--- a/documentation/index.rst
+++ b/documentation/index.rst
@@ -51,3 +51,10 @@  Welcome to the Yocto Project Documentation
    :hidden:
 
    genindex
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Documentation Downloads
+   :hidden:
+
+   downloads