docs: Generate pdf version of docs for apache#9095

This implements the changes required to genreate the pdf version of the documentation. The pdf will be generated as a build artifact attached to the build. This is the first patch to enable this a follow on patch to the website repo will publish the pdf to the NuttX website.
simbit18 · May 16, 2023 · 9a654b6 · 9a654b6
1 parent 6da335c
commit 9a654b6
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 4 deletions.
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -10,6 +10,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+---
 name: "Build Documentation"
 on:
   pull_request:
@@ -30,13 +31,22 @@ jobs:
       - uses: actions/setup-python@v4
         with:
           python-version: '3.8'
+      - name: Install LaTeX packages
+        run: |
+          sudo apt-get update -y
+          sudo apt-get install -y \
+            texlive-latex-recommended texlive-fonts-recommended \
+            texlive-latex-base texlive-latex-extra latexmk texlive-luatex \
+            fonts-freefont-otf xindy
       - name: Generate Documentation
         run: |
           cd Documentation/
           pip3 install pipenv
           pipenv install
-          pipenv run make html
+          pipenv run make html latexpdf
       - uses: actions/upload-artifact@v3
         with:
           name: sphinx-docs
-          path: Documentation/_build/html/
+          path: |
+            Documentation/_build/html/
+            Documentation/_build/latex/*.pdf
diff --git a/Documentation/components/nxgraphics/NXOrganization.gif b/Documentation/components/nxgraphics/NXOrganization.gif
diff --git a/Documentation/components/nxgraphics/NXOrganization.png b/Documentation/components/nxgraphics/NXOrganization.png
diff --git a/Documentation/components/nxgraphics/index.rst b/Documentation/components/nxgraphics/index.rst
@@ -83,7 +83,7 @@ That NuttX directory organization is discussed in `Appendix
 B <#grapicsdirs>`__ of this document. The logic modules are discussed in
 the following sub-paragraphs.
 
-.. figure:: NXOrganization.gif
+.. figure:: NXOrganization.png
   :align: center
 
 NX Graphics Library (``NXGL``)

diff --git a/Documentation/conf.py b/Documentation/conf.py
@@ -119,3 +119,5 @@
     "https://github.com/pyenv/pyenv#installation",
     "http://openocd.zylin.com/#/c/4103/",
 ]
+
+latex_engine = "lualatex"
diff --git a/Documentation/platforms/arm/nrf52/boards/nrf52832-mdk/index.rst b/Documentation/platforms/arm/nrf52/boards/nrf52832-mdk/index.rst
@@ -7,7 +7,7 @@ the nRF52832 SoC from Nordic. It features 24 I/Os an on-board RGB led and a chip
 It also includes an embedded DAPlink debugger which allows to flash/debug and monitor UART
 from the USB port.
 
-.. figure:: pinout.webp
+.. figure:: pinout.png
    :align: center
 
    Pinout diagram

diff --git a/Documentation/platforms/arm/nrf52/boards/nrf52832-mdk/pinout.png b/Documentation/platforms/arm/nrf52/boards/nrf52832-mdk/pinout.png
diff --git a/Documentation/platforms/arm/nrf52/boards/nrf52832-mdk/pinout.webp b/Documentation/platforms/arm/nrf52/boards/nrf52832-mdk/pinout.webp