Skip to content

Commit 4f1b611

Browse files
committed
docs: add ReadTheDocs configuration
- Add .readthedocs.yaml for RTD build configuration - Add docs/requirements.txt with minimal dependencies for docs build - Configure Python 3.11 and Ubuntu 22.04 build environment - Enable MkDocs documentation building on ReadTheDocs
1 parent a66bfae commit 4f1b611

2 files changed

Lines changed: 31 additions & 0 deletions

File tree

.readthedocs.yaml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Read the Docs configuration file for hier-config-cli
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
version: 2
5+
6+
# Build documentation in the "docs/" directory with MkDocs
7+
mkdocs:
8+
configuration: mkdocs.yml
9+
fail_on_warning: false
10+
11+
# Set the version of Python
12+
build:
13+
os: ubuntu-22.04
14+
tools:
15+
python: "3.11"
16+
jobs:
17+
post_checkout:
18+
# Generate any build-time dependencies or files here
19+
- echo "Building hier-config-cli documentation"
20+
post_install:
21+
# Show installed packages for debugging
22+
- pip list
23+
24+
# Python dependencies required to build the docs
25+
python:
26+
install:
27+
# Install Poetry
28+
- requirements: docs/requirements.txt

docs/requirements.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Documentation build requirements for ReadTheDocs
2+
mkdocs>=1.5.3
3+
mkdocs-material>=9.5.3

0 commit comments

Comments
 (0)