Skip to content

Commit

Permalink
CI: Add RTD configuration file
Browse files Browse the repository at this point in the history
RTD will soon be requiring a configuration file for builds.
Additionally, they will soon stop honoring the unshallow feature flag
that they have on the repository and to get an unshallow checkout we
must do so via the config file

Issue: RELENG-4815
Signed-off-by: Andrew Grimberg <[email protected]>
Change-Id: I41ae572570dcfb1b82a8457a5f008cb736ca3c0b
  • Loading branch information
tykeal committed Jul 21, 2023
1 parent 85fdad9 commit dc2972b
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml

# Optionally build your docs in additional formats such as PDF
formats:
- pdf

build:
os: ubuntu-22.04
tools:
python: "3.11"
jobs:
post_checkout:
- git fetch --unshallow || true

python:
install:
- requirements: requirements-docs.txt
- {path: ., method: pip}

0 comments on commit dc2972b

Please sign in to comment.