Skip to content

Commit

Permalink
Add Readthedocs config
Browse files Browse the repository at this point in the history
Signed-off-by: Aurélien Bompard <[email protected]>
  • Loading branch information
abompard committed Jul 12, 2024
1 parent 21aa0d5 commit 1b8ca59
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 3 deletions.
28 changes: 28 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3"

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

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

# Optionally set the version of Python and requirements required to build your docs
python:
install:
- method: pip
path: .
extra_requirements:
- docs
4 changes: 2 additions & 2 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,6 @@ pytest-cov = ">=3.0.0"
coverage = {extras = ["toml"], version = ">=7.0.0"}
ruff = ">=0.0.253"
sphinx = ">=6.1.3"
blinker = "^1.6.2"
sphinxcontrib-httpdomain = "^1.8.1"
cloud-sptheme = "^1.10.1.post20200504175005"
oidc-register = "^0.2.1"
Expand All @@ -97,6 +96,7 @@ mm2_mirrorlist-statistics = "mirrormanager2.utility.mirrorlist_statistics:main"

[tool.poetry.extras]
deploy = ["gunicorn", "psycopg2"]
docs = ["sphinx", "sphinxcontrib-httpdomain", "cloud-sptheme"]

[build-system]
requires = ["poetry-core>=1.0.0"]
Expand Down

0 comments on commit 1b8ca59

Please sign in to comment.