From f3dd9ac2b82e4c6915e32877cd7e035b899524f7 Mon Sep 17 00:00:00 2001 From: Geraint Ballinger Date: Mon, 21 Nov 2022 12:42:42 +0000 Subject: [PATCH] Setup readthedocs --- .readthedocs.yaml | 14 ++++++++++++++ docs/requirements.txt | 1 + mkdocs.yml | 2 +- 3 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 .readthedocs.yaml create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..6fd8be7 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,14 @@ +version: 2 + +build: + os: "ubuntu-22.04" + tools: + python: "3.9" + +mkdocs: + configuration: mkdocs.yml + fail_on_warning: false + +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..e517ad5 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +mkdocs==1.4.2 diff --git a/mkdocs.yml b/mkdocs.yml index 22eb7e0..8f94c64 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,7 +3,7 @@ theme: readthedocs site_url: https://pythonhosted.org/sense-hat/ repo_url: https://github.com/RPi-Distro/python-sense-hat site_description: Python module to control the Raspberry Pi Sense HAT used in the Astro Pi mission -site_author: David Honess +site_author: Raspberry Pi Foundation site_dir: pythonhosted #google_analytics: ['UA-46270871-5', 'pythonhosted.org/sense-hat'] nav: