Skip to content

Commit 4226f06

Browse files
committed
Setup for sphinx website generator
This patch introduces the documentation website for the testing library. ReadTheDocs is now used as host service for documentation.
1 parent c387672 commit 4226f06

File tree

5 files changed

+49
-0
lines changed

5 files changed

+49
-0
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@
1414
*.orig
1515
*.eml
1616
builddir
17+
.venv

.readthedocs.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
version: 2
2+
3+
build:
4+
os: "ubuntu-22.04"
5+
tools:
6+
python: "3.12"
7+
8+
# Build from the docs/ directory with Sphinx
9+
sphinx:
10+
configuration: docs/conf.py
11+
12+
# Explicitly set the version of Python and its requirements
13+
python:
14+
install:
15+
- requirements: docs/requirements.txt

docs/conf.py

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
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 = 'Linux Test Project Framework'
10+
copyright = '2023, Andrea Cervesato'
11+
author = 'Andrea Cervesato'
12+
release = '1.0'
13+
14+
# -- General configuration ---------------------------------------------------
15+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
16+
17+
extensions = ['myst_parser']
18+
source_suffix = ['.rst', '.md']
19+
20+
templates_path = ['_templates']
21+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
22+
23+
24+
25+
# -- Options for HTML output -------------------------------------------------
26+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
27+
28+
html_theme = 'renku'
29+
html_static_path = ['_static']

docs/index.rst

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.. include:: ../README.md
2+
:parser: myst_parser.sphinx_

docs/requirements.txt

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
myst-parser==0.16.1
2+
renku-sphinx-theme==0.3.0

0 commit comments

Comments
 (0)