Skip to content

Commit 2dbd101

Browse files
committed
Add readthedocs config
1 parent 3af9a29 commit 2dbd101

File tree

3 files changed

+30
-1
lines changed

3 files changed

+30
-1
lines changed

.readthedocs.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
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+
13+
mkdocs:
14+
configuration: mkdocs.yml
15+
fail_on_warning: false
16+
17+
python:
18+
install:
19+
- method: pip
20+
path: .
21+
extra_requirements:
22+
- docs

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Frontend module and a Raspberry Pi Pico (Zero).
2929

3030
## API Documentation
3131

32-
See [API Reference](https://readthedocs.com/bofh69/pn5180_tagomatic/).
32+
See [API Reference](https://pn5180-tagomatic.readthedocs.io/en/latest/).
3333

3434
## Installation
3535

pyproject.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,13 @@ dev = [
5151
"types-pyserial>=3.5.0",
5252
]
5353

54+
docs = [
55+
"mkdocs>=1.6.1",
56+
"mkdocs-material>=9.7.1",
57+
"mkdocs-material-extensions>=1.3.1",
58+
"mkdocstrings-python>=2.0.1",
59+
]
60+
5461
[project.urls]
5562
Homepage = "https://github.com/bofh69/PN5180-tagomatic"
5663
Repository = "https://github.com/bofh69/PN5180-tagomatic"

0 commit comments

Comments
 (0)