From a98bfbd61b911541777dc043e365e49ac1d196cc Mon Sep 17 00:00:00 2001 From: takam Date: Tue, 11 Oct 2022 11:12:18 +0100 Subject: [PATCH] Updated to get docs to build on readthedocs --- mkdocs.yml | 4 ++-- readthedocs.yml | 16 ++++++++++++++++ requirements.txt | 2 ++ 3 files changed, 20 insertions(+), 2 deletions(-) create mode 100644 readthedocs.yml diff --git a/mkdocs.yml b/mkdocs.yml index 4daabdb..020a180 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,7 @@ site_name: pyControl site_url: https://pycontrol.readthedocs.io/ site_description: Open source, Python based, behavioural experiment control. -site_author: Champalimaud Foundation +site_author: Thomas Akam theme: name: readthedocs @@ -23,5 +23,5 @@ nav: - Release Notes: about/release-notes.md - License: about/license.md -copyright: Copyright © 2016 - 2019 Thomas Akam +copyright: Copyright © 2016 - 2022 Thomas Akam diff --git a/readthedocs.yml b/readthedocs.yml new file mode 100644 index 0000000..bb8225b --- /dev/null +++ b/readthedocs.yml @@ -0,0 +1,16 @@ +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-20.04 + tools: + python: "3.9" + +mkdocs: + configuration: mkdocs.yml + +# Optionally declare the Python requirements required to build your docs +python: + install: + - requirements: requirements.txt \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index e69de29..970ac11 100644 --- a/requirements.txt +++ b/requirements.txt @@ -0,0 +1,2 @@ +mkdocs==1.3.0 +jinja2==3.1.2 \ No newline at end of file