From 9348ccfc6ace3a731e6a36375cca0afccf3af2e4 Mon Sep 17 00:00:00 2001 From: Rik Helsen Date: Thu, 14 Oct 2021 20:13:57 +0200 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Added=20`docs.yml`=20&=20`.readthed?= =?UTF-8?q?ocs.yaml`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/docs.yml | 15 +++++++++++++++ .readthedocs.yaml | 15 +++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 .github/workflows/docs.yml create mode 100644 .readthedocs.yaml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..cd38394 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,15 @@ +docs_check: +runs-on: ubuntu-20.04 +steps: +- uses: actions/checkout@v2 + +- name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: 3.8 + + - name: Documentation build + run: | + pip install -r Documentation/requirements-docs.txt + pip install mkdocs + mkdocs build diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..10e52e8 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,15 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +mkdocs: + configuration: mkdocs.yml + fail_on_warning: false + +python: + version: "3.8" + install: + - requirements: Documentation/requirements-docs.txt