Merge pull request #36 from maykinmedia/update-ci-configuration

Update CI configuration

.github/workflows/code_quality.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        toxenv: [isort, black, flake8, docs]
+        toxenv: [isort, black, flake8]
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5

.github/workflows/documentation.yml

@@ -0,0 +1,29 @@
+name: Documentation checks
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - '*'
+    paths:
+      - 'docs/**'
+  pull_request:
+    paths:
+      - 'docs/**'
+  workflow_dispatch:
+
+jobs:
+  linting:
+    name: Documentation-quality check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - name: Install dependencies
+        run: pip install tox
+      - run: tox
+        env:
+          TOXENV: docs

docs/quickstart.rst

@@ -35,5 +35,8 @@ Then you can initialize sentry by adding the following line to ``base.py``:
     init_sentry()
 
 
-After that, compare the settings from ``open_api_framework.conf.base`` to the settings
-defined in the project's `base.py <open_api_framework/conf/base.py>`_ and remove settings from the latter to make use of the generic settings (if this is desired).
+After that, compare the settings from `open_api_framework.conf.base`_ to the settings
+defined in the project's ``base.py`` and remove settings from the latter to make use of the generic settings (if this is desired).
+
+
+.. _open_api_framework.conf.base: https://github.com/maykinmedia/open-api-framework/blob/main/open_api_framework/conf/base.py