Skip to content

Commit e67b15e

Browse files
authored
Merge pull request #19 from RECETOX/copilot/add-readthedocs-page
Add ReadTheDocs documentation page
2 parents e3a9f51 + b5abb51 commit e67b15e

5 files changed

Lines changed: 41 additions & 0 deletions

File tree

.readthedocs.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
version: 2
2+
3+
build:
4+
os: ubuntu-22.04
5+
tools:
6+
python: "3.11"
7+
8+
sphinx:
9+
configuration: docs/conf.py
10+
11+
python:
12+
install:
13+
- requirements: requirements/docs.txt

docs/_static/.gitkeep

Whitespace-only changes.

docs/conf.py

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
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+
project = "specdatri_reporting"
8+
copyright = "2024, RECETOX"
9+
author = "RECETOX"
10+
11+
# -- General configuration ---------------------------------------------------
12+
extensions = [
13+
"myst_parser",
14+
]
15+
16+
templates_path = ["_templates"]
17+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
18+
19+
# -- Options for HTML output -------------------------------------------------
20+
html_theme = "sphinx_rtd_theme"
21+
html_static_path = ["_static"]

docs/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# specdatri_reporting
2+
3+
```{include} ../README.md
4+
```

requirements/docs.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
sphinx==8.1.3
2+
sphinx-rtd-theme==3.0.2
3+
myst-parser==4.0.0

0 commit comments

Comments
 (0)