Skip to content

Commit 95ec606

Browse files
committed
add readthedocs config; add doc link in readme
1 parent 263aa89 commit 95ec606

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

.readthedocs.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
version: 2
2+
3+
# Build environment
4+
build:
5+
os: ubuntu-22.04
6+
tools:
7+
python: "3.11"
8+
9+
# Build documentation with Sphinx
10+
sphinx:
11+
configuration: docs/source/conf.py
12+
builder: html
13+
fail_on_warning: false
14+
15+
# Python environment
16+
python:
17+
install:
18+
- method: pip
19+
path: .
20+
extra_requirements:
21+
- docs
22+

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![PyPI version](https://badge.fury.io/py/varlord.svg)](https://badge.fury.io/py/varlord)
44
[![Python 3.7+](https://img.shields.io/badge/python-3.7+-blue.svg)](https://www.python.org/downloads/)
55
[![License](https://img.shields.io/badge/license-Apache%202.0-green.svg)](LICENSE)
6+
[![Documentation](https://readthedocs.org/projects/varlord/badge/?version=latest)](https://varlord.readthedocs.io)
67

78
**Varlord** is a powerful Python configuration management library that provides a unified interface for loading configuration from multiple sources with customizable priority ordering and optional dynamic updates via etcd.
89

@@ -173,6 +174,9 @@ class AppConfig:
173174

174175
Full documentation is available at [https://varlord.readthedocs.io](https://varlord.readthedocs.io)
175176

177+
- **Latest**: [https://varlord.readthedocs.io/en/latest/](https://varlord.readthedocs.io/en/latest/)
178+
- **Stable**: [https://varlord.readthedocs.io/en/stable/](https://varlord.readthedocs.io/en/stable/)
179+
176180
## 🎯 Key Concepts
177181

178182
### Configuration Model

0 commit comments

Comments
 (0)