Skip to content

doc: Add latex to generate pdf #315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
divipillai wants to merge 1 commit into
base: main
Choose a base branch
from
+35 −0
Open

doc: Add latex to generate pdf #315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/workflows/doc-build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,11 @@ jobs:
sudo tar xf doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz -C /opt
echo "/opt/doxygen-${DOXYGEN_VERSION}/bin" >> $GITHUB_PATH

- name: Install LaTeX
run: |
sudo apt-get install -y texlive-full
sudo apt-get install -y inkscape

- name: Set up Python
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
with:
Expand All @@ -66,11 +71,15 @@ jobs:
pip-install: |
-r doc/requirements.txt

- name: Install Python deps
run: pip install sphinx sphinxcontrib-svg2pdfconverter

- name: Build
working-directory: doc
run: |
doxygen
sphinx-build -M html . build
make latexpdf

- name: Check version
run: |
Expand Down Expand Up @@ -138,3 +147,10 @@ jobs:
retention-days: 5
path: |
publish/*

- name: Upload PDF artifact
uses: actions/upload-artifact@v4
with:
name: sphinx-pdf
retention-days: 5
path: doc/_build_sphinx/latex/ncs-serial-modem.pdf
19 changes: 19 additions & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
'sphinx_togglebutton',
"sphinxcontrib.jquery",
"sphinx_copybutton",
'sphinx.ext.imgconverter',
]

templates_path = ['_templates']
Expand All @@ -54,3 +55,21 @@
.. include:: /links.txt
.. include:: /shortcuts.txt
"""

# -- Options for LaTeX output -------------------------------------------------

latex_engine = 'xelatex'

latex_use_xindy = False

latex_elements = {
'papersize': 'a4paper',
'pointsize': '11pt',
}

latex_documents = [
('index', 'ncs-serial-modem.tex', f'{project} Documentation',
author, 'manual'),
]

figure_align = 'H'
Loading