9a654b658e
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.
53 lines
1.5 KiB
YAML
53 lines
1.5 KiB
YAML
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
---
|
|
name: "Build Documentation"
|
|
on:
|
|
pull_request:
|
|
push:
|
|
|
|
concurrency:
|
|
group: docs-${{ github.event.pull_request.number || github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
build-html:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- 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 latexpdf
|
|
- uses: actions/upload-artifact@v3
|
|
with:
|
|
name: sphinx-docs
|
|
path: |
|
|
Documentation/_build/html/
|
|
Documentation/_build/latex/*.pdf
|