From a2e950d705a6e787482abf520dafd765c2e9fcd4 Mon Sep 17 00:00:00 2001 From: Eirini Koutsaniti Date: Tue, 14 Mar 2023 10:04:05 +0100 Subject: [PATCH 1/3] Add readthedocs configuration file --- .readthedocs.yaml | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000000..d5a686b81f --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,26 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +formats: + - pdf + - epub + +# Optionally declare the Python requirements required to build your docs +python: + install: + - requirements: docs/requirements.txt From 4e76c69c3867e060eb718516bc429a1a7c64a548 Mon Sep 17 00:00:00 2001 From: Eirini Koutsaniti Date: Thu, 16 Mar 2023 09:44:36 +0100 Subject: [PATCH 2/3] Remove comments and add copyright --- .readthedocs.yaml | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index d5a686b81f..a1d88bb9d5 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,26 +1,22 @@ -# .readthedocs.yaml -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details +# Copyright 2016-2023 Swiss National Supercomputing Centre (CSCS/ETH Zurich) +# ReFrame Project Developers. See the top-level LICENSE file for details. +# +# SPDX-License-Identifier: BSD-3-Clause -# Required version: 2 -# Set the version of Python and other tools you might need build: os: ubuntu-22.04 tools: python: "3.11" -# Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/conf.py -# If using Sphinx, optionally build your docs in additional formats such as PDF formats: - pdf - epub -# Optionally declare the Python requirements required to build your docs python: install: - requirements: docs/requirements.txt From bc8ebd37b2893b40116ea90195f3d541cdea5a8f Mon Sep 17 00:00:00 2001 From: Eirini Koutsaniti Date: Thu, 16 Mar 2023 09:55:23 +0100 Subject: [PATCH 3/3] Remove pdf from readthedocs --- .readthedocs.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index a1d88bb9d5..afdb9972da 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -14,7 +14,6 @@ sphinx: configuration: docs/conf.py formats: - - pdf - epub python: