Build and publish documentation

This commit is contained in:
Vladan Popovic 2020-09-06 04:42:26 +02:00
parent 2df73b76a8
commit eee471e9a7
7 changed files with 39 additions and 8 deletions

View file

@ -8,7 +8,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
python: [3.6, 3.7, 3.8]
python: [3.8]
steps:
- uses: actions/checkout@v2

28
.github/workflows/sphinx.yaml vendored Normal file
View file

@ -0,0 +1,28 @@
name: documentation
on:
push:
branches:
- master
jobs:
build-and-delpoy:
name: Build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Install Python
uses: actions/setup-python@v1
with:
python-version: 3.8
- name: Install Tox and any other packages
run: pip install tox
- name: Build Sphinx docs
run: tox -e docs
- name: Deploy
if: success()
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html/

View file

@ -1,9 +1,12 @@
============================
Website stats collector demo
============================
====================
Website checker demo
====================
.. image:: https://github.com/vladan/aiven-site-checker/workflows/chweb/badge.svg
:target: https://github.com/vladan/aiven-site-checker/actions?query=branch%3Amaster
.. image:: https://github.com/vladan/aiven-site-checker/workflows/build/badge.svg
:target: https://github.com/vladan/aiven-site-checker/actions?query=workflow%3Abuild+branch%3Amaster
.. image:: https://github.com/vladan/aiven-site-checker/workflows/documentation/badge.svg
:target: https://github.com/vladan/aiven-site-checker/actions?query=workflow%3Adocumentation+branch%3Amaster
CHWEB is a website checking tool.

View file

View file

View file

@ -7,7 +7,7 @@ from setuptools import setup # type: ignore
setup(
use_scm_version=True,
setup_requires=['setuptools_scm'],
python_requires='>=3.6, <4',
python_requires='>=3.8, <4',
install_requires=[
'aiokafka==0.6.0',
'asyncpg==0.21.0',

View file

@ -31,7 +31,7 @@ deps =
sphinx
sphinx-typlog-theme
commands =
sphinx-build -W -b html -E ./source/ ./build/
sphinx-build -W -b html -E ./source/ ./build/html/
[testenv:clean]
deps = coverage