From 978fcd2b7bb3e515158752063136838b71ecdaf7 Mon Sep 17 00:00:00 2001 From: Ioannis Bonatakis Date: Sat, 15 Mar 2025 12:55:35 +0100 Subject: [PATCH 1/3] Add Read the Docs configuration for OpenQA Project --- .readthedocs.yaml | 33 +++++++++++++++++++++++++++++++++ docs/conf.py | 27 +++++++++++++++++++++++++++ docs/requirements.txt | 2 ++ 3 files changed, 62 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 docs/conf.py create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000000..a44ca9da257 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,33 @@ +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version, and other tools you might need +build: + os: ubuntu-24.04 + tools: + python: "3.13" + #jobs: + # post_create_environment: + # - pip install asciidoctor + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally, but recommended, +# declare the Python requirements required to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +# python: +# install: +# - requirements: docs/requirements.txt + +formats: + - pdf + - htmlzip +python: + install: + - requirements: docs/requirements.txt + diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000000..603df6cc6be --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,27 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'OpenQA' +copyright = '2025, b10n1k' +author = 'b10n1k' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [] + +templates_path = ['_templates'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'alabaster' +html_static_path = ['_static'] diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000000..1529536401e --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +asciidoc +sphinx-asciidoc From 2a6712e4d4642185af89c120851103b9c2606ade Mon Sep 17 00:00:00 2001 From: Ioannis Bonatakis Date: Sun, 18 May 2025 10:32:17 +0200 Subject: [PATCH 2/3] create a commit to gerrit Change-Id: Ic867932246cd1de492a9f219a56aecd955e039de --- text.txt | 1 + 1 file changed, 1 insertion(+) create mode 100644 text.txt diff --git a/text.txt b/text.txt new file mode 100644 index 00000000000..214404aa6c2 --- /dev/null +++ b/text.txt @@ -0,0 +1 @@ +hi from me From 681cd4b7ed07585302d1221270f6e0686fd211a2 Mon Sep 17 00:00:00 2001 From: Ioannis Bonatakis Date: Sun, 18 May 2025 10:53:14 +0200 Subject: [PATCH 3/3] create a commit to gerrit Change-Id: Ifd8bf44c31b636393b61418f6c894c25bcd4743e --- text.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/text.txt b/text.txt index 214404aa6c2..bcaeeacd05f 100644 --- a/text.txt +++ b/text.txt @@ -1 +1,2 @@ hi from me +hi from me 2