Skip to content

Commit

Permalink
Add build docs workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
xzkostyan committed Nov 29, 2022
1 parent aa06d07 commit b869dd4
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 2 deletions.
21 changes: 21 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
on: [push, pull_request]
name: build-docs
jobs:
tests:
runs-on: ubuntu-20.04
name: Build docs
steps:
- uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: 3.11
architecture: x64
- name: Update tools
run: pip install --upgrade pip setuptools wheel
- name: Install sphinx
run: pip install sphinx
- name: Install package
run: pip install -e .
- name: Build docs
run: cd docs && make html
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXOPTS = -W
SPHINXBUILD = sphinx-build
SOURCEDIR = .
BUILDDIR = _build
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = 'en'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down

0 comments on commit b869dd4

Please sign in to comment.