Skip to content

Commit bdd1a34

Browse files
committed
add docs build path for ci to check pdf and epub
1 parent 2eff6f8 commit bdd1a34

File tree

3 files changed

+20
-4
lines changed

3 files changed

+20
-4
lines changed

.circleci/config.yml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,20 @@ windows-wheel-steps:
8484
paths:
8585
- .tox
8686
key: cache-v1-{{ arch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "setup.py" }}-{{ checksum "tox.ini" }}
87+
88+
docs: &docs
89+
docker:
90+
- image: common
91+
steps:
92+
- run:
93+
name: install latexpdf dependencies
94+
command: |
95+
sudo apt-get update
96+
sudo apt-get install latexmk tex-gyre texlive-fonts-extra
8797
8898
jobs:
8999
docs:
90-
<<: *common
100+
<<: *docs
91101
docker:
92102
- image: cimg/python:3.8
93103
environment:

Makefile

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,18 @@ build-docs:
3838
$(MAKE) -C docs clean
3939
$(MAKE) -C docs html
4040
$(MAKE) -C docs doctest
41+
42+
build-docs-ci:
43+
$(MAKE) -C docs latexpdf
44+
$(MAKE) -C docs epub
4145

42-
validate-docs:
46+
validate-newsfragments:
4347
python ./newsfragments/validate_files.py
4448
towncrier build --draft --version preview
4549

46-
check-docs: build-docs validate-docs
50+
check-docs: build-docs validate-newsfragments
51+
52+
check-docs-ci: build-docs build-docs-ci validate-newsfragments
4753

4854
docs: check-docs
4955
open docs/_build/html/index.html

tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ per-file-ignores=__init__.py:F401
1616
usedevelop=True
1717
commands=
1818
core: pytest {posargs:tests/core}
19-
docs: make check-docs
19+
docs: make check-docs-ci
2020
basepython=
2121
docs: python
2222
windows-wheel: python

0 commit comments

Comments
 (0)