Browse Source

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>
Antonin Godard 6 months ago
parent
commit
b5cb33f1f4
2 changed files with 18 additions and 0 deletions
  1. 11 0
      documentation/downloads.rst
  2. 7 0
      documentation/index.rst

+ 11 - 0
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>`_

+ 7 - 0
documentation/index.rst

@@ -51,3 +51,10 @@ Welcome to the Yocto Project Documentation
    :hidden:
 
    genindex
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Documentation Downloads
+   :hidden:
+
+   downloads