Skip to content

Commit 978fcd2

Browse files
committed
Add Read the Docs configuration for OpenQA Project
1 parent baca1fd commit 978fcd2

File tree

3 files changed

+62
-0
lines changed

3 files changed

+62
-0
lines changed

.readthedocs.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Read the Docs configuration file
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
# Required
5+
version: 2
6+
7+
# Set the OS, Python version, and other tools you might need
8+
build:
9+
os: ubuntu-24.04
10+
tools:
11+
python: "3.13"
12+
#jobs:
13+
# post_create_environment:
14+
# - pip install asciidoctor
15+
16+
# Build documentation in the "docs/" directory with Sphinx
17+
sphinx:
18+
configuration: docs/conf.py
19+
20+
# Optionally, but recommended,
21+
# declare the Python requirements required to build your documentation
22+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
23+
# python:
24+
# install:
25+
# - requirements: docs/requirements.txt
26+
27+
formats:
28+
- pdf
29+
- htmlzip
30+
python:
31+
install:
32+
- requirements: docs/requirements.txt
33+

docs/conf.py

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# For the full list of built-in configuration values, see the documentation:
4+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
5+
6+
# -- Project information -----------------------------------------------------
7+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8+
9+
project = 'OpenQA'
10+
copyright = '2025, b10n1k'
11+
author = 'b10n1k'
12+
13+
# -- General configuration ---------------------------------------------------
14+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
15+
16+
extensions = []
17+
18+
templates_path = ['_templates']
19+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
20+
21+
22+
23+
# -- Options for HTML output -------------------------------------------------
24+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
25+
26+
html_theme = 'alabaster'
27+
html_static_path = ['_static']

docs/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
asciidoc
2+
sphinx-asciidoc

0 commit comments

Comments
 (0)