Skip to content

Commit 4cd8a30

Browse files
authored
docs: remove griffe fork to build docs (#2080)
chore: remove griffe fork to build docs
1 parent eb60314 commit 4cd8a30

File tree

3 files changed

+5
-15
lines changed

3 files changed

+5
-15
lines changed

.github/workflows/mkdocs.yml

+4-6
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,7 @@ jobs:
2626
path: .cache
2727
restore-keys: |
2828
mkdocs-material-
29-
- name: griffe
30-
# hopefully temporary until https://github.com/mkdocstrings/mkdocstrings/issues/716
31-
run: pip install git+https://github.com/MarcoGorelli/griffe.git@no-overloads
32-
- run: pip install -e .[docs,dask,duckdb]
33-
34-
- run: mkdocs gh-deploy --force
29+
- name: Install dependencies
30+
run: pip install -e .[docs,dask,duckdb]
31+
- name: Deploy docs
32+
run: mkdocs gh-deploy --force

CONTRIBUTING.md

-9
Original file line numberDiff line numberDiff line change
@@ -111,15 +111,6 @@ If you want to run PySpark-related tests, you'll need to have Java installed. Re
111111
If you also want to test other libraries like Dask , PySpark, and Modin, you can install them too with
112112
`uv pip install -e ".[dev, core, docs, dask, pyspark, modin]"`.
113113
114-
3. Install a fork of griffe:
115-
116-
```terminal
117-
uv pip install git+https://github.com/MarcoGorelli/griffe.git@no-overloads
118-
```
119-
120-
This is hopefully temporary until [mkdocstrings#716](https://github.com/mkdocstrings/mkdocstrings/issues/716)
121-
is addressed.
122-
123114
You should also install pre-commit:
124115
125116
```terminal

pyproject.toml

+1
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ docs = [
7676
"mkdocs-autorefs",
7777
"mkdocs-material",
7878
"mkdocstrings[python]",
79+
"mkdocstrings-python>=1.16",
7980
"pandas",
8081
"polars>=1.0.0",
8182
"pyarrow",

0 commit comments

Comments
 (0)