Skip to content

Commit

Permalink
add docs build path for ci to check pdf and epub
Browse files Browse the repository at this point in the history
  • Loading branch information
pacrob committed Jan 31, 2024
1 parent 2eff6f8 commit bdd1a34
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 4 deletions.
12 changes: 11 additions & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,20 @@ windows-wheel-steps:
paths:
- .tox
key: cache-v1-{{ arch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "setup.py" }}-{{ checksum "tox.ini" }}

docs: &docs
docker:
- image: common
steps:
- run:
name: install latexpdf dependencies
command: |
sudo apt-get update
sudo apt-get install latexmk tex-gyre texlive-fonts-extra
jobs:
docs:
<<: *common
<<: *docs
docker:
- image: cimg/python:3.8
environment:
Expand Down
10 changes: 8 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,18 @@ build-docs:
$(MAKE) -C docs clean
$(MAKE) -C docs html
$(MAKE) -C docs doctest

build-docs-ci:
$(MAKE) -C docs latexpdf
$(MAKE) -C docs epub

validate-docs:
validate-newsfragments:
python ./newsfragments/validate_files.py
towncrier build --draft --version preview

check-docs: build-docs validate-docs
check-docs: build-docs validate-newsfragments

check-docs-ci: build-docs build-docs-ci validate-newsfragments

docs: check-docs
open docs/_build/html/index.html
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ per-file-ignores=__init__.py:F401
usedevelop=True
commands=
core: pytest {posargs:tests/core}
docs: make check-docs
docs: make check-docs-ci
basepython=
docs: python
windows-wheel: python
Expand Down

0 comments on commit bdd1a34

Please sign in to comment.