docs: explain optional boolean args in from_native (#1421)

narwhals-dev · Nov 22, 2024 · 6946e26 · 6946e26
1 parent 8901ec3
commit 6946e26
Show file tree

Hide file tree

Showing 4 changed files with 256 additions and 188 deletions.
diff --git a/.github/workflows/check_docs_build.yml b/.github/workflows/check_docs_build.yml
@@ -31,7 +31,9 @@ jobs:
       - name: local-install
         run: uv pip install -e . --system
       - name: check-no-errors
-        run: python -m mkdocs build > output.txt 2>&1
+        run: |
+          python -m mkdocs build 2>&1 | tee output.txt
+          cat output.txt
       - name: assert-no-errors
         run: python utils/check_for_no_build_errors.py
       - name: strict-docs-build

diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
@@ -1,6 +1,8 @@
 black  # required by mkdocstrings_handlers
 jinja2
 duckdb
+# Hopefully temporary until https://github.com/mkdocstrings/mkdocstrings/issues/716
+git+https://github.com/MarcoGorelli/griffe.git@no-overloads
 markdown-exec[ansi]
 mkdocs
 mkdocs-autorefs