Skip to content

Commit

Permalink
Merge pull request #2573 from chaoss/dev
Browse files Browse the repository at this point in the history
Readthedocs.io Patch
  • Loading branch information
sgoggins authored Oct 30, 2023
2 parents f3b8bfe + 317fe42 commit 4434e98
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 1 deletion.
37 changes: 37 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
#SPDX-License-Identifier: MIT
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2
build:
os: ubuntu-22.04 # <- add this line
tools:
python: "3.10"

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

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

# Optionally build your docs in additional formats such as PDF and ePub
formats: all

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

# build:
# os: ubuntu-22.04
# tools:
# python:3.10
10 changes: 9 additions & 1 deletion readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@

# Required
version: 2
build:
os: ubuntu-22.04 # <- add this line
tools:
python: "3.10"

# Build documentation in the docs/ directory with Sphinx
sphinx:
Expand All @@ -19,11 +23,15 @@ formats: all

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.8
install:
- method: pip
path: .
extra_requirements:
- dev
- method: setuptools
path: .

# build:
# os: ubuntu-22.04
# tools:
# python:3.10

0 comments on commit 4434e98

Please sign in to comment.