📚 Fix typos discovered by codespell (#969) #613
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: build-doc-formats | |
on: | |
push: | |
branches: [master] | |
pull_request: | |
jobs: | |
doc-builds: | |
name: Documentation builds | |
runs-on: ubuntu-latest | |
strategy: | |
fail-fast: false | |
matrix: | |
format: ["man", "text"] | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python 3.10 | |
uses: actions/setup-python@v5 | |
with: | |
python-version: "3.10" | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install -e .[linkify,rtd] | |
- name: Build docs | |
run: | | |
sphinx-build -nW --keep-going -b ${{ matrix.format }} docs/ docs/_build/${{ matrix.format }} | |
doc-builds-pdf: | |
name: Documentation builds | |
runs-on: ubuntu-latest | |
strategy: | |
fail-fast: false | |
matrix: | |
format: ["latex"] | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python 3.10 | |
uses: actions/setup-python@v5 | |
with: | |
python-version: "3.10" | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install -e .[linkify,rtd] | |
- name: Build docs | |
run: | | |
sphinx-build -nW --keep-going -b ${{ matrix.format }} docs/ docs/_build/${{ matrix.format }} | |
- name: Make PDF | |
uses: xu-cheng/latex-action@v2 | |
with: | |
working_directory: docs/_build/latex | |
root_file: "mystparser.tex" | |
# https://github.com/marketplace/actions/github-action-for-latex#it-fails-due-to-xindy-cannot-be-found | |
pre_compile: | | |
ln -sf /opt/texlive/texdir/texmf-dist/scripts/xindy/xindy.pl /opt/texlive/texdir/bin/x86_64-linuxmusl/xindy | |
ln -sf /opt/texlive/texdir/texmf-dist/scripts/xindy/texindy.pl /opt/texlive/texdir/bin/x86_64-linuxmusl/texindy | |
wget https://sourceforge.net/projects/xindy/files/xindy-source-components/2.4/xindy-kernel-3.0.tar.gz | |
tar xf xindy-kernel-3.0.tar.gz | |
cd xindy-kernel-3.0/src | |
apk add make | |
apk add clisp --repository=http://dl-cdn.alpinelinux.org/alpine/edge/community | |
make | |
cp -f xindy.mem /opt/texlive/texdir/bin/x86_64-linuxmusl/ | |
cd ../../ | |
env: | |
XINDYOPTS: -L english -C utf8 -M sphinx.xdy |