Skip to content

Commit d27f44e

Browse files
committed
Add GitHub workflow for releasing docs
1 parent e165abe commit d27f44e

File tree

2 files changed

+41
-1
lines changed

2 files changed

+41
-1
lines changed

.github/workflows/release-docs.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Release Webware for Python 3 documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
jobs:
9+
build:
10+
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v1
15+
- name: Set up Python 3.7
16+
uses: actions/setup-python@v1
17+
with:
18+
python-version: 3.7
19+
- name: Install dependencies
20+
run: |
21+
python -m pip install --upgrade pip
22+
pip install .[docs]
23+
- name: Create docs with Sphinx
24+
run: |
25+
cd docs
26+
make html
27+
touch _build/html/.nojekyll
28+
- name: Deploy docs to GitHub pages
29+
uses: peaceiris/actions-gh-pages@v2
30+
env:
31+
ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
32+
PUBLISH_BRANCH: gh-pages
33+
PUBLISH_DIR: docs/_build/html
34+
with:
35+
emptyCommits: false
36+
forceOrphan: true

setup.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,16 @@
1313
requireDev = [
1414
'Pygments>=2,<3', 'waitress>=1.3,<2', 'hupper>=1.9,<2', 'WebTest>=2,<3'
1515
]
16+
requireDocs = [
17+
'Sphinx>=2.2,<3', 'sphinx_rtd_theme>=0.4'
18+
]
1619
requireExamples = [
1720
'Pygments>=2,<3', 'Pillow>=6,<7', 'dominate>=2,<3', 'yattag>=1,<2'
1821
]
1922
requireTest = [
2023
'psutil>=5,<6', 'flake8>=3.7,<4', 'pylint>=2.4,<3', 'tox>=3.14,<4',
2124
'pywin32>=227,<300;platform_system=="Windows"'
22-
] + requireDev + requireExamples
25+
] + requireDev + requireDocs + requireExamples
2326

2427

2528
setuptools.setup(
@@ -49,6 +52,7 @@
4952
],
5053
extras_require={
5154
'dev': requireDev,
55+
'docs': requireDocs,
5256
'examples': requireExamples,
5357
'test': requireTest,
5458
},

0 commit comments

Comments
 (0)