Skip to content

Commit

Permalink
[Docs] Fix readthedocs builds
Browse files Browse the repository at this point in the history
Requires using updated configuration with git unshallow so that version
can be identified from git tags.

Closes: #434
  • Loading branch information
cas-- committed Sep 18, 2023
1 parent 7082d9c commit ed1366d
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@
# Required
version: 2

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

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py
Expand All @@ -14,9 +22,8 @@ formats: all

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
install:
- requirements: requirements.txt
- requirements: docs/requirements.txt
- method: setuptools
- method: pip
path: .

0 comments on commit ed1366d

Please sign in to comment.