docs: Generate pdf version of docs for #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.
This commit is contained in:
parent
6da335cd81
commit
9a654b658e
14
.github/workflows/doc.yml
vendored
14
.github/workflows/doc.yml
vendored
@ -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
|
||||
|
Binary file not shown.
Before Width: | Height: | Size: 34 KiB |
BIN
Documentation/components/nxgraphics/NXOrganization.png
Normal file
BIN
Documentation/components/nxgraphics/NXOrganization.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 25 KiB |
@ -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``)
|
||||
|
@ -119,3 +119,5 @@ linkcheck_ignore = [
|
||||
"https://github.com/pyenv/pyenv#installation",
|
||||
"http://openocd.zylin.com/#/c/4103/",
|
||||
]
|
||||
|
||||
latex_engine = "lualatex"
|
||||
|
@ -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
|
||||
|
BIN
Documentation/platforms/arm/nrf52/boards/nrf52832-mdk/pinout.png
Normal file
BIN
Documentation/platforms/arm/nrf52/boards/nrf52832-mdk/pinout.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 683 KiB |
Binary file not shown.
Before Width: | Height: | Size: 123 KiB |
Loading…
Reference in New Issue
Block a user