Skip to content

Commit

Permalink
add readthedocs.yaml for build documentations correct
Browse files Browse the repository at this point in the history
  • Loading branch information
shtalinberg committed Nov 20, 2024
1 parent e65934b commit 3ab2449
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 0 deletions.
39 changes: 39 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.10"

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

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

# Optionally declare the Python requirements required to build your docs
python:
install:
- method: pip
path: .
extra_requirements:
- doc
- requirements: doc/requirements.txt

# Don't install the package in editable mode
# This ensures we're testing the actual installation
python:
install:
- method: pip
path: .
- requirements: doc/requirements.txt
13 changes: 13 additions & 0 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Documentation dependencies
sphinx>=5.0.0,<6.0.0
sphinx-rtd-theme>=1.0.0
sphinxcontrib-applehelp>=1.0.4
sphinxcontrib-devhelp>=1.0.2
sphinxcontrib-htmlhelp>=2.0.0
sphinxcontrib-serializinghtml>=1.1.5
sphinxcontrib-qthelp>=1.0.3
docutils>=0.17.1
jinja2>=3.0.0

# Project dependencies
django>=3.2.0
2 changes: 2 additions & 0 deletions release-requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
build>=1.0.0
twine>=4.0.0

0 comments on commit 3ab2449

Please sign in to comment.