docs/.readthedocs.yaml at master · ArchiveBox/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# Read the Docs configuration file for ArchiveBox docs
# See https://docs.readthedocs.io/en/stable/config-file/v2.html
#
# RTD Version Strategy:
#   - "stable" alias -> latest tag with no pre-release suffix (PEP 440)
#   - "latest" alias -> default branch (master) = current dev docs
#   - Tagged versions (v0.9.10, v0.8.6, v0.7.3, etc.) build from git tags
#
# This is fully automatic via PEP 440 version detection:
#   - pyproject.toml version = "0.9.10"      -> stable release
#   - pyproject.toml version = "0.9.10rc1"   -> pre-release (dev)
#   - pyproject.toml version = "0.9.10.dev1" -> dev release
#   - RTD "latest" from master branch        -> always dev
#
# RTD Admin Settings (configure in RTD dashboard once):
#   - Default version: "stable"
#   - "latest" version: visible, shows dev docs with warning banner
#   - Enable "build on tag push" for automatic versioned releases
#
# To publish a new stable release:
#   1. Set version = "0.9.10" in pyproject.toml (no rc/dev/alpha suffix)
#   2. git tag v0.9.10 && git push wiki v0.9.10
#   3. RTD auto-builds and "stable" alias updates to this version
#
# To access dev docs:
#   https://archivebox.readthedocs.io/en/latest/

version: 2

build:
  os: ubuntu-24.04
  tools:
    python: "3.13"

sphinx:
  configuration: conf.py

python:
  install:
    - requirements: requirements.txt
    # Install archivebox so autodoc2 can introspect the source
    - method: pip
      path: ..
      extra_requirements:
        - dev