name: Check documentation status

on: push

jobs:

build:

runs-on: ubuntu-20.04

steps:

- uses: actions/checkout@v2

- name: Set up Python

uses: actions/setup-python@v2

with:

python-version: 3.7

- name: Install dependencies

run: |

- name: Check docs building

run: ./docs/res/check.sh

We use the [Google docstring format](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) for documenting the code.

We document every user-facing class or method, and enforce that using the flake8-docstrings library.

The documentation is then rendered from the docstrings in the code using Sphinx and some heavy post-processing and saved as `docs/docs.md`.

To generate the documentation, just run `./build_docs.sh`.

./docs/res/build.sh > /dev/null