Skip to content

Commit

Permalink
update .readthedocs configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
tedil committed Jan 13, 2025
1 parent fc36c72 commit 3347b2f
Show file tree
Hide file tree
Showing 3 changed files with 226 additions and 6 deletions.
25 changes: 25 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# .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 version of Python and other tools you might need
build:
os: ubuntu-22.04
jobs:
post_create_environment:
- pip install uv
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH uv pip install --upgrade pip setuptools
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH uv pip install --upgrade sphinx readthedocs-sphinx-ext
post_install:
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH uv sync --all-extras --group docs
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH uv pip install '.[all]'
build:
html:
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH uv run sphinx-build --fail-on-warning --show-traceback --keep-going -D language=de docs_manual $READTHEDOCS_OUTPUT/html

## Build documentation in the docs/ directory with Sphinx
#sphinx:
# configuration: docs_manual/conf.py
8 changes: 6 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ pythonpath = [
snappy = [
"snappy-pipeline @ git+https://github.com/bihealth/snappy-pipeline@5d11f311357e75516ba2d7045cc0c1bd61201e14",
]
all = ["cubi-tk[snappy]"]

[dependency-groups]
dev = [
Expand All @@ -72,8 +73,11 @@ dev = [
"setuptools>=75.8.0",
"tox>=4.23",
]
all = [
"cubi-tk[dev,snappy]"
docs = [
"sphinx>=1.7.0",
"sphinx-rtd-theme>=0.4.3",
"sphinx-argparse>=0.2.5",
"recommonmark>=0.6.0",
]

[tool.ruff]
Expand Down
199 changes: 195 additions & 4 deletions uv.lock

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

0 comments on commit 3347b2f

Please sign in to comment.