Merge pull request #913 from sphinx-contrib/support-v2-api #206
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
# Action which validates the ability to build this extension's documentation. | |
name: Documentation | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- '.github/workflows/docs.yml' | |
- 'doc/**' | |
- 'CHANGES.rst' | |
pull_request: | |
branches: | |
- main | |
paths: | |
- '.github/workflows/docs.yml' | |
- 'doc/**' | |
- 'CHANGES.rst' | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
- name: Cache pip | |
uses: actions/cache@v4 | |
id: cache-pip | |
with: | |
path: ~/.cache/pip | |
key: docs-pip | |
- name: Install dependencies | |
run: | | |
sudo apt-get update | |
sudo apt-get install \ | |
latexmk \ | |
texlive-latex-extra \ | |
texlive-latex-recommended \ | |
-y | |
sudo python -m pip install --upgrade sphinx | |
- name: Install confluencebuilder | |
run: | | |
sudo python -m pip install -e . | |
- name: HTML | |
run: make html | |
working-directory: doc | |
- name: PDF | |
run: make latexpdf | |
working-directory: doc | |
- name: Archive generated PDF | |
uses: actions/upload-artifact@v2 | |
with: | |
name: sphinxcontrib-confluencebuilder.pdf | |
path: doc/_build/latex/sphinxconfluencebuilder.pdf | |
retention-days: 10 |