Skip to content

Commit

Permalink
docs: Pinned docs dependencies and use PEP 735 for them
Browse files Browse the repository at this point in the history
  • Loading branch information
edgarrmondragon committed Feb 19, 2025
1 parent c96f361 commit 37c437d
Show file tree
Hide file tree
Showing 7 changed files with 1,415 additions and 596 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ __pycache__/
*.so

# Distribution / packaging
requirements.txt
.Python
build/
develop-eggs/
Expand Down
3 changes: 3 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@ repos:
hooks:
- id: uv-lock
- id: uv-sync
- id: uv-export
args: ["--frozen", "--no-dev", "--group", "docs", "--output-file=docs/requirements.txt"]


- repo: https://github.com/codespell-project/codespell
rev: v2.4.1
Expand Down
6 changes: 1 addition & 5 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,4 @@ sphinx:

python:
install:
# - requirements: docs/requirements.txt
- method: pip
path: .
extra_requirements:
- docs
- requirements: docs/requirements.txt
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ de-facto open source standard for extract and load pipelines.
<a href="https://results.pre-commit.ci/latest/github/meltano/sdk/main">
<img alt="pre-commit.ci status" src="https://results.pre-commit.ci/badge/github/meltano/sdk/main.svg"/>
</a>
<a href="https://github.com/astral-sh/uv">
<img alt="uv" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json"/>
</a>
</div>

---
Expand Down
710 changes: 710 additions & 0 deletions docs/requirements.txt

Large diffs are not rendered by default.

25 changes: 12 additions & 13 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -58,19 +58,6 @@ dependencies = [
]

[project.optional-dependencies]
# Sphinx dependencies installed as optional 'docs' extras
# https://github.com/readthedocs/readthedocs.org/issues/4912#issuecomment-664002569
docs = [
"furo>=2024.5.6",
"myst-parser>=3",
"pytest>=7.2.1",
"sphinx>=7",
"sphinx-copybutton>=0.5.2",
"sphinx-inline-tabs>=2023.4.21",
"sphinx-notfound-page>=1.0.0",
"sphinx-reredirects>=0.1.5",
]

# File storage dependencies installed as optional 'filesystem' extras
s3 = [
"fs-s3fs>=1.1.1",
Expand Down Expand Up @@ -116,6 +103,8 @@ Documentation = "https://sdk.meltano.com/en/latest/"

[dependency-groups]
dev = [
{"include-group" = "docs"},
{"include-group" = "typing"},
"coverage[toml]>=7.4",
"deptry>=0.15.0",
"duckdb>=0.8.0",
Expand All @@ -132,6 +121,16 @@ dev = [
"time-machine>=2.10.0",
"xdoctest>=1.1.1",
]
docs = [
"furo>=2024.5.6",
"myst-parser>=3",
"pytest>=7.2.1",
"sphinx>=7",
"sphinx-copybutton>=0.5.2",
"sphinx-inline-tabs>=2023.4.21",
"sphinx-notfound-page>=1.0.0",
"sphinx-reredirects>=0.1.5",
]
typing = [
"mypy>=1.9",
"types-jsonschema>=4.17.0.6",
Expand Down
1,263 changes: 686 additions & 577 deletions uv.lock

Large diffs are not rendered by default.

0 comments on commit 37c437d

Please sign in to comment.