Skip to content

Commit

Permalink
ci[python]: Separate docs requirements (#4739)
Browse files Browse the repository at this point in the history
  • Loading branch information
stinodego committed Sep 6, 2022
1 parent a231449 commit 5a7c141
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 23 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: 3.9
python-version: "3.10"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r py-polars/build.requirements.txt
pip install -r py-polars/docs/requirements-docs.txt
- name: Build python reference
run: |
cd py-polars/docs
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/docs_check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: 3.9
python-version: "3.10"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r py-polars/build.requirements.txt
pip install -r py-polars/docs/requirements-docs.txt
- name: Build python reference
run: |
cd py-polars/docs
Expand Down
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ You have to follow these steps:
- from [./py-polars](./py-polars) run `$ pip3 install -r build.requirements.txt`
- **tests:** from [./py-polars](./py-polars) run `$ make test`
- **formatting + linting:** from [./py-polars](./py-polars) run `$ make pre-commit` before committing.
- **docs:** from [./py-polars/docs](./py-polars/docs) run `$ pip3 install -r requirements-docs.txt` followed by `make html`

`make test` installs a (slow) development build in your current environment and runs `pytest`.

Expand Down
1 change: 1 addition & 0 deletions py-polars/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ venv: ## Set up virtual environment
clean: ## Clean up caches and build artifacts
@rm -rf venv/
@rm -rf docs/build/
@rm -rf docs/source/reference/api/
@rm -rf .hypothesis/
@rm -rf .mypy_cache/
@rm -rf .pytest_cache/
Expand Down
26 changes: 7 additions & 19 deletions py-polars/build.requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,33 +10,21 @@ pytz
types-pytz

# Tooling
maturin==0.13.0
pytest==7.1.2
maturin==0.13.2
pytest==7.1.3
pytest-cov==3.0.0
hypothesis==6.49.1
black==22.6.0
blackdoc==0.3.5
hypothesis==6.54.5
black==22.8.0
blackdoc==0.3.6
isort==5.10.1
mypy==0.971
flake8==5.0.2
flake8-bugbear==22.7.1
flake8==5.0.4
flake8-bugbear==22.8.23
flake8-comprehensions==3.10.0
flake8-docstrings==1.6.0
flake8-simplify==0.19.3
flake8-tidy-imports==4.8.0
pyupgrade==2.37.3
ghp-import==2.1.0
sphinx==4.3.2
pydata-sphinx-theme==0.9.0
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
sphinxcontrib-napoleon==0.7
commonmark==0.9.1
numpydoc==1.4.0

# Stub files
pandas-stubs==1.2.0.61
14 changes: 14 additions & 0 deletions py-polars/docs/requirements-docs.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
hypothesis==6.54.5

ghp-import==2.1.0
sphinx==4.3.2
pydata-sphinx-theme==0.10.1
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
sphinxcontrib-napoleon==0.7
commonmark==0.9.1
numpydoc==1.4.0

0 comments on commit 5a7c141

Please sign in to comment.