mirror of
https://github.com/ArchiveBox/ArchiveBox.git
synced 2026-09-12 19:50:57 +05:00
46 lines
1.4 KiB
YAML
46 lines
1.4 KiB
YAML
# 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
|