Skip to content

Documentation

Documentation #1

# DO NOT EDIT THIS FILE!
#
# It's auto-generated by sonata-project/dev-kit package.
name: Documentation
on:
push:
branches:
- 1.x
- master
pull_request:
env:
ACTIONS_ALLOW_UNSECURE_COMMANDS: true
jobs:
build:
name: Sphinx build
runs-on: [ 'lendable-medium-dind-x64-linux' ]
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Set up Python 3.7
uses: actions/setup-python@v1
with:
python-version: '3.7'
- name: Display Python version
run: python -c "import sys; print(sys.version)"
- name: Install Sphinx dependencies
run: sudo apt-get install python-dev build-essential
- name: Cache pip
uses: actions/cache@v2
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}
restore-keys: ${{ runner.os }}-pip-
- name: Install custom requirements via pip
run: pip install -r docs/requirements.txt
- name: Build documentation
run: make docs
doctor-rst:
name: DOCtor-RST
runs-on: [ 'lendable-medium-dind-x64-linux' ]
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Run DOCtor-RST
uses: docker://oskarstark/doctor-rst
with:
args: --short --error-format=github
env:
DOCS_DIR: 'docs/'