docs: Refactor docs directory hierarchy

Split docs folder into two subfolders. All the main docs content lives in `docs/docs`. Dynamically generated content lives in `docs/docs-res`. This split prevents the MkDocs live reloading from entering an infinite loop when generating data files, images, or pages, for the documentation.
pola-rs · Sep 20, 2024 · cd12eec · cd12eec
1 parent b7e5e09
commit cd12eec
Show file tree

Hide file tree

Showing 200 changed files with 180 additions and 161 deletions.
diff --git a/.github/workflows/docs-global.yml b/.github/workflows/docs-global.yml
@@ -21,7 +21,7 @@ jobs:
           ref: ${{ github.event.client_payload.sha }}
       - uses: gaurav-nelson/github-action-markdown-link-check@v1
         with:
-          config-file: docs/mlc-config.json
+          config-file: docs/docs/mlc-config.json
           folder-path: docs
 
   lint:
@@ -39,13 +39,13 @@ jobs:
 
       - uses: chartboost/ruff-action@v1
         with:
-          src: docs/
+          src: docs/docs/
           version: ${{ steps.version.outputs.version }}
           args: check --no-fix
 
       - uses: chartboost/ruff-action@v1
         with:
-          src: docs/
+          src: docs/docs/
           version: ${{ steps.version.outputs.version }}
           args: format --diff
 
@@ -69,7 +69,7 @@ jobs:
           echo "VIRTUAL_ENV=$GITHUB_WORKSPACE/.venv" >> $GITHUB_ENV
 
       - name: Install Python dependencies
-        run: uv pip install -r py-polars/requirements-dev.txt -r docs/requirements.txt
+        run: uv pip install -r py-polars/requirements-dev.txt -r docs/docs/requirements.txt
 
       - name: Set up Rust
         run: rustup show

diff --git a/.github/workflows/lint-rust.yml b/.github/workflows/lint-rust.yml
@@ -4,7 +4,7 @@ on:
   pull_request:
     paths:
       - crates/**
-      - docs/src/rust/**
+      - docs/docs/src/rust/**
       - examples/**
       - py-polars/src/**
       - py-polars/Cargo.toml
@@ -15,7 +15,7 @@ on:
       - main
     paths:
       - crates/**
-      - docs/src/rust/**
+      - docs/docs/src/rust/**
       - examples/**
       - py-polars/src/**
       - py-polars/Cargo.toml

diff --git a/.github/workflows/test-python.yml b/.github/workflows/test-python.yml
@@ -5,7 +5,7 @@ on:
     paths:
       - Cargo.lock
       - py-polars/**
-      - docs/src/python/**
+      - docs/docs/src/python/**
       - crates/**
       - .github/workflows/test-python.yml
   push:
@@ -14,7 +14,7 @@ on:
     paths:
       - Cargo.lock
       - crates/**
-      - docs/src/python/**
+      - docs/docs/src/python/**
       - py-polars/**
       - .github/workflows/test-python.yml
 

diff --git a/.gitignore b/.gitignore
@@ -39,6 +39,5 @@ target/
 *.tbl
 
 # Project
-/docs/data/
-/docs/images/
-/docs/people.md
+/docs/docs-res/data/
+/docs/docs-res/people.md
diff --git a/Cargo.toml b/Cargo.toml
@@ -2,7 +2,7 @@
 resolver = "2"
 members = [
   "crates/*",
-  "docs/src/rust",
+  "docs/docs/src/rust",
   # "examples/*",
   "py-polars",
 ]

diff --git a/Makefile b/Makefile
@@ -25,7 +25,7 @@ requirements: .venv  ## Install/refresh Python project requirements
 	   -r py-polars/requirements-dev.txt \
 	   -r py-polars/requirements-lint.txt \
 	   -r py-polars/docs/requirements-docs.txt \
-	   -r docs/requirements.txt
+	   -r docs/docs/requirements.txt
 
 .PHONY: requirements-all
 requirements-all: .venv  ## Install/refresh all Python requirements (including those needed for CI tests)

diff --git a/README.md b/README.md
@@ -102,7 +102,7 @@ shape: (5, 8)
 ## SQL
 
 ```python
->>> df = pl.scan_csv("docs/data/iris.csv")
+>>> df = pl.scan_csv("docs/docs-res/data/iris.csv")
 >>> ## OPTION 1
 >>> # run SQL queries on frame-level
 >>> df.sql("""
@@ -141,14 +141,14 @@ SQL commands can also be run directly from your terminal using the Polars CLI:
 
 ```bash
 # run an inline SQL query
-> polars -c "SELECT species, AVG(sepal_length) AS avg_sepal_length, AVG(sepal_width) AS avg_sepal_width FROM read_csv('docs/data/iris.csv') GROUP BY species;"
+> polars -c "SELECT species, AVG(sepal_length) AS avg_sepal_length, AVG(sepal_width) AS avg_sepal_width FROM read_csv('docs/docs-res/data/iris.csv') GROUP BY species;"
 
 # run interactively
 > polars
 Polars CLI v0.3.0
 Type .help for help.
 
-> SELECT species, AVG(sepal_length) AS avg_sepal_length, AVG(sepal_width) AS avg_sepal_width FROM read_csv('docs/data/iris.csv') GROUP BY species;
+> SELECT species, AVG(sepal_length) AS avg_sepal_length, AVG(sepal_width) AS avg_sepal_width FROM read_csv('docs/docs-res/data/iris.csv') GROUP BY species;
 ```
 
 Refer to the [Polars CLI repository](https://github.com/pola-rs/polars-cli) for more information.

diff --git a/crates/polars/tests/it/io/parquet/arrow/read.rs b/crates/polars/tests/it/io/parquet/arrow/read.rs
@@ -10,7 +10,7 @@ fn all_types() -> PolarsResult<()> {
     use crate::io::parquet::read::file::FileReader;
 
     let dir = env!("CARGO_MANIFEST_DIR");
-    let path = PathBuf::from(dir).join("../../docs/data/alltypes_plain.parquet");
+    let path = PathBuf::from(dir).join("../../docs/docs-res/data/alltypes_plain.parquet");
 
     let mut reader = std::fs::File::open(path)?;
 
@@ -55,7 +55,7 @@ fn all_types_chunked() -> PolarsResult<()> {
 
     use crate::io::parquet::read::file::FileReader;
     let dir = env!("CARGO_MANIFEST_DIR");
-    let path = PathBuf::from(dir).join("../../docs/data/alltypes_plain.parquet");
+    let path = PathBuf::from(dir).join("../../docs/docs-res/data/alltypes_plain.parquet");
     let mut reader = std::fs::File::open(path)?;
 
     let metadata = read_metadata(&mut reader)?;

diff --git a/crates/polars/tests/it/io/parquet/read/mod.rs b/crates/polars/tests/it/io/parquet/read/mod.rs
@@ -34,7 +34,7 @@ pub fn hybrid_rle_iter(d: HybridRleDecoder) -> ParquetResult<std::vec::IntoIter<
 
 pub fn get_path() -> PathBuf {
     let dir = env!("CARGO_MANIFEST_DIR");
-    PathBuf::from(dir).join("../../docs/data")
+    PathBuf::from(dir).join("../../docs/docs-res/data")
 }
 
 /// Reads a page into an [`Array`].

diff --git a/docs/data/alltypes_plain.parquet → docs/docs-res/data/alltypes_plain.parquet b/docs/data/alltypes_plain.parquet → docs/docs-res/data/alltypes_plain.parquet
diff --git a/docs/data/apple_stock.csv → docs/docs-res/data/apple_stock.csv b/docs/data/apple_stock.csv → docs/docs-res/data/apple_stock.csv
diff --git a/docs/data/iris.csv → docs/docs-res/data/iris.csv b/docs/data/iris.csv → docs/docs-res/data/iris.csv
diff --git a/docs/data/reddit.csv → docs/docs-res/data/reddit.csv b/docs/data/reddit.csv → docs/docs-res/data/reddit.csv
diff --git a/docs/docs-res/images/.gitignore b/docs/docs-res/images/.gitignore
@@ -0,0 +1,2 @@
+*
+!.gitignore
diff --git a/docs/_build/API_REFERENCE_LINKS.yml → docs/docs/_build/API_REFERENCE_LINKS.yml b/docs/_build/API_REFERENCE_LINKS.yml → docs/docs/_build/API_REFERENCE_LINKS.yml
diff --git a/docs/_build/assets/logo.png → docs/docs/_build/assets/logo.png b/docs/_build/assets/logo.png → docs/docs/_build/assets/logo.png
diff --git a/docs/_build/css/extra.css → docs/docs/_build/css/extra.css b/docs/_build/css/extra.css → docs/docs/_build/css/extra.css
diff --git a/docs/_build/overrides/404.html → docs/docs/_build/overrides/404.html b/docs/_build/overrides/404.html → docs/docs/_build/overrides/404.html
diff --git a/docs/_build/scripts/macro.py → docs/docs/_build/scripts/macro.py b/docs/_build/scripts/macro.py → docs/docs/_build/scripts/macro.py
@@ -22,7 +22,7 @@
 )
 
 # Load all links to reference docs
-with open("docs/_build/API_REFERENCE_LINKS.yml", "r") as f:
+with open("docs/docs/_build//API_REFERENCE_LINKS.yml", "r") as f:
     API_REFERENCE_LINKS = yaml.load(f, Loader=yaml.CLoader)
 
 
@@ -39,7 +39,7 @@ def create_feature_flag_link(feature_name: str) -> str:
 
 
 def create_feature_flag_links(language: str, api_functions: List[str]) -> List[str]:
-    """Generate markdown feature flags for the code tas based on the api_functions.
+    """Generate markdown feature flags for the code tabs based on the api_functions.
         It checks for the key feature_flag in the configuration yaml for the function and if it exists print out markdown
 
     Args:
@@ -165,7 +165,7 @@ def code_block(
 
         for language, info in LANGUAGES.items():
             base_path = f"{language}/{path}{info['extension']}"
-            full_path = "docs/src/" + base_path
+            full_path = "docs/docs/src/" + base_path
             # Check if file exists for the language
             if os.path.exists(full_path):
                 result.append(code_tab(base_path, section, info, api_functions))

diff --git a/docs/_build/scripts/people.py → docs/docs/_build/scripts/people.py b/docs/_build/scripts/people.py → docs/docs/_build/scripts/people.py
@@ -8,10 +8,11 @@
 
 ICON_TEMPLATE = '<a href="{html_url}"><img alt="{login}" class="contributor_icon" src="{avatar_url}&s=40" loading="lazy" /></a>'
 
+
 def get_people_md():
     repo = g.get_repo("pola-rs/polars")
     contributors = repo.get_contributors()
-    with open("./docs/people.md", "w") as f:
+    with open("./docs/docs-res/people.md", "w") as f:
         for c in itertools.islice(contributors, 50):
             # We love dependabot, but he doesn't need a spot on our website
             if c.login == "dependabot[bot]":
@@ -28,11 +29,11 @@ def get_people_md():
 
 
 def on_startup(command, dirty):
-    """Mkdocs hook to autogenerate docs/people.md on startup"""
+    """Mkdocs hook to autogenerate docs/docs/people.md on startup"""
     try:
         get_people_md()
     except Exception as e:
-        msg = f"WARNING:{__file__}: Could not generate docs/people.md. Got error: {str(e)}"
+        msg = f"WARNING:{__file__}: Could not generate docs/docs/people.md. Got error: {str(e)}"
         print(msg)
 
 

diff --git a/docs/_build/snippets/under_construction.md → ...ocs/_build/snippets/under_construction.md b/docs/_build/snippets/under_construction.md → ...ocs/_build/snippets/under_construction.md
diff --git a/docs/api/index.md → docs/docs/api/index.md b/docs/api/index.md → docs/docs/api/index.md
diff --git a/docs/development/contributing/ci.md → docs/docs/development/contributing/ci.md b/docs/development/contributing/ci.md → docs/docs/development/contributing/ci.md
diff --git a/docs/development/contributing/code-style.md → ...cs/development/contributing/code-style.md b/docs/development/contributing/code-style.md → ...cs/development/contributing/code-style.md
diff --git a/docs/development/contributing/ide.md → docs/docs/development/contributing/ide.md b/docs/development/contributing/ide.md → docs/docs/development/contributing/ide.md
@@ -51,7 +51,7 @@ This guide shows how to set up a debugging environment that makes debugging Rust
 Start by installing the CodeLLDB extension (see above).
 Then add the following two configurations to your `launch.json` file.
 This file is usually found in the `.vscode` folder of your project root.
-See the [official VSCode documentation](https://code.visualstudio.com/docs/editor/debugging#_launch-configurations) for more information about the `launch.json` file.
+See the [official VSCode documentation](https://code.visualstudio.com/docs/docs/editor/debugging#_launch-configurations) for more information about the `launch.json` file.
 
 <details><summary><code><b>launch.json</b></code></summary>
 

diff --git a/docs/development/contributing/index.md → docs/docs/development/contributing/index.md b/docs/development/contributing/index.md → docs/docs/development/contributing/index.md
diff --git a/docs/development/contributing/test.md → docs/docs/development/contributing/test.md b/docs/development/contributing/test.md → docs/docs/development/contributing/test.md
diff --git a/docs/development/versioning.md → docs/docs/development/versioning.md b/docs/development/versioning.md → docs/docs/development/versioning.md
diff --git a/docs/index.md → docs/docs/index.md b/docs/index.md → docs/docs/index.md
@@ -57,7 +57,7 @@ A more extensive introduction can be found in the [next chapter](user-guide/gett
 
 Polars has a very active community with frequent releases (approximately weekly). Below are some of the top contributors to the project:
 
---8<-- "docs/people.md"
+--8<-- "docs/docs-res/people.md"
 
 ## Contributing
 

diff --git a/docs/mlc-config.json → docs/docs/mlc-config.json b/docs/mlc-config.json → docs/docs/mlc-config.json
diff --git a/docs/pyproject.toml → docs/docs/pyproject.toml b/docs/pyproject.toml → docs/docs/pyproject.toml
diff --git a/docs/releases/changelog.md → docs/docs/releases/changelog.md b/docs/releases/changelog.md → docs/docs/releases/changelog.md
diff --git a/docs/releases/upgrade/0.19.md → docs/docs/releases/upgrade/0.19.md b/docs/releases/upgrade/0.19.md → docs/docs/releases/upgrade/0.19.md
diff --git a/docs/releases/upgrade/0.20.md → docs/docs/releases/upgrade/0.20.md b/docs/releases/upgrade/0.20.md → docs/docs/releases/upgrade/0.20.md
diff --git a/docs/releases/upgrade/1.md → docs/docs/releases/upgrade/1.md b/docs/releases/upgrade/1.md → docs/docs/releases/upgrade/1.md
diff --git a/docs/releases/upgrade/index.md → docs/docs/releases/upgrade/index.md b/docs/releases/upgrade/index.md → docs/docs/releases/upgrade/index.md
diff --git a/docs/requirements.txt → docs/docs/requirements.txt b/docs/requirements.txt → docs/docs/requirements.txt
diff --git a/docs/src/python/home/example.py → docs/docs/src/python/home/example.py b/docs/src/python/home/example.py → docs/docs/src/python/home/example.py
@@ -2,7 +2,7 @@
 import polars as pl
 
 q = (
-    pl.scan_csv("docs/data/iris.csv")
+    pl.scan_csv("docs/docs-res/data/iris.csv")
     .filter(pl.col("sepal_length") > 5)
     .group_by("species")
     .agg(pl.all().sum())

diff --git a/...rc/python/user-guide/concepts/contexts.py → ...rc/python/user-guide/concepts/contexts.py b/...rc/python/user-guide/concepts/contexts.py → ...rc/python/user-guide/concepts/contexts.py
diff --git a/...on/user-guide/concepts/data-structures.py → ...on/user-guide/concepts/data-structures.py b/...on/user-guide/concepts/data-structures.py → ...on/user-guide/concepts/data-structures.py
diff --git a/...guide/concepts/data-types/categoricals.py → ...guide/concepts/data-types/categoricals.py b/...guide/concepts/data-types/categoricals.py → ...guide/concepts/data-types/categoricals.py
diff --git a/...python/user-guide/concepts/expressions.py → ...python/user-guide/concepts/expressions.py b/...python/user-guide/concepts/expressions.py → ...python/user-guide/concepts/expressions.py
diff --git a/...thon/user-guide/concepts/lazy-vs-eager.py → ...thon/user-guide/concepts/lazy-vs-eager.py b/...thon/user-guide/concepts/lazy-vs-eager.py → ...thon/user-guide/concepts/lazy-vs-eager.py
@@ -2,15 +2,15 @@
 
 # --8<-- [start:eager]
 
-df = pl.read_csv("docs/data/iris.csv")
+df = pl.read_csv("docs/docs-res/data/iris.csv")
 df_small = df.filter(pl.col("sepal_length") > 5)
 df_agg = df_small.group_by("species").agg(pl.col("sepal_width").mean())
 print(df_agg)
 # --8<-- [end:eager]
 
 # --8<-- [start:lazy]
 q = (
-    pl.scan_csv("docs/data/iris.csv")
+    pl.scan_csv("docs/docs-res/data/iris.csv")
     .filter(pl.col("sepal_length") > 5)
     .group_by("species")
     .agg(pl.col("sepal_width").mean())

diff --git a/...c/python/user-guide/concepts/streaming.py → ...c/python/user-guide/concepts/streaming.py b/...c/python/user-guide/concepts/streaming.py → ...c/python/user-guide/concepts/streaming.py
@@ -1,10 +1,11 @@
 # --8<-- [start:import]
 import polars as pl
+
 # --8<-- [end:import]
 
 # --8<-- [start:streaming]
 q1 = (
-    pl.scan_csv("docs/data/iris.csv")
+    pl.scan_csv("docs/docs-res/data/iris.csv")
     .filter(pl.col("sepal_length") > 5)
     .group_by("species")
     .agg(pl.col("sepal_width").mean())
@@ -18,7 +19,7 @@
 # --8<-- [end:example]
 
 # --8<-- [start:example2]
-q2 = pl.scan_csv("docs/data/iris.csv").with_columns(
+q2 = pl.scan_csv("docs/docs-res/data/iris.csv").with_columns(
     pl.col("sepal_length").mean().over("species")
 )
 

diff --git a/...hon/user-guide/expressions/aggregation.py → ...hon/user-guide/expressions/aggregation.py b/...hon/user-guide/expressions/aggregation.py → ...hon/user-guide/expressions/aggregation.py
diff --git a/.../python/user-guide/expressions/casting.py → .../python/user-guide/expressions/casting.py b/.../python/user-guide/expressions/casting.py → .../python/user-guide/expressions/casting.py
diff --git a/...er-guide/expressions/column-selections.py → ...er-guide/expressions/column-selections.py b/...er-guide/expressions/column-selections.py → ...er-guide/expressions/column-selections.py
diff --git a/...rc/python/user-guide/expressions/folds.py → ...rc/python/user-guide/expressions/folds.py b/...rc/python/user-guide/expressions/folds.py → ...rc/python/user-guide/expressions/folds.py
diff --git a/...ython/user-guide/expressions/functions.py → ...ython/user-guide/expressions/functions.py b/...ython/user-guide/expressions/functions.py → ...ython/user-guide/expressions/functions.py
diff --git a/...rc/python/user-guide/expressions/lists.py → ...rc/python/user-guide/expressions/lists.py b/...rc/python/user-guide/expressions/lists.py → ...rc/python/user-guide/expressions/lists.py
diff --git a/...on/user-guide/expressions/missing-data.py → ...on/user-guide/expressions/missing-data.py b/...on/user-guide/expressions/missing-data.py → ...on/user-guide/expressions/missing-data.py
diff --git a/...n/user-guide/expressions/numpy-example.py → ...n/user-guide/expressions/numpy-example.py b/...n/user-guide/expressions/numpy-example.py → ...n/user-guide/expressions/numpy-example.py
diff --git a/...ython/user-guide/expressions/operators.py → ...ython/user-guide/expressions/operators.py b/...ython/user-guide/expressions/operators.py → ...ython/user-guide/expressions/operators.py
diff --git a/.../python/user-guide/expressions/strings.py → .../python/user-guide/expressions/strings.py b/.../python/user-guide/expressions/strings.py → .../python/user-guide/expressions/strings.py
diff --git a/.../python/user-guide/expressions/structs.py → .../python/user-guide/expressions/structs.py b/.../python/user-guide/expressions/structs.py → .../python/user-guide/expressions/structs.py
diff --git a/...ide/expressions/user-defined-functions.py → ...ide/expressions/user-defined-functions.py b/...ide/expressions/user-defined-functions.py → ...ide/expressions/user-defined-functions.py
diff --git a/...c/python/user-guide/expressions/window.py → ...c/python/user-guide/expressions/window.py b/...c/python/user-guide/expressions/window.py → ...c/python/user-guide/expressions/window.py
diff --git a/...user-guide/getting-started/expressions.py → ...user-guide/getting-started/expressions.py b/...user-guide/getting-started/expressions.py → ...user-guide/getting-started/expressions.py
diff --git a/...ython/user-guide/getting-started/joins.py → ...ython/user-guide/getting-started/joins.py b/...ython/user-guide/getting-started/joins.py → ...ython/user-guide/getting-started/joins.py
diff --git a/...-guide/getting-started/reading-writing.py → ...-guide/getting-started/reading-writing.py b/...-guide/getting-started/reading-writing.py → ...-guide/getting-started/reading-writing.py
@@ -19,24 +19,24 @@
 # --8<-- [end:dataframe]
 
 # --8<-- [start:csv]
-df.write_csv("docs/data/output.csv")
-df_csv = pl.read_csv("docs/data/output.csv")
+df.write_csv("docs/docs-res/data/output.csv")
+df_csv = pl.read_csv("docs/docs-res/data/output.csv")
 print(df_csv)
 # --8<-- [end:csv]
 
 # --8<-- [start:csv2]
-df_csv = pl.read_csv("docs/data/output.csv", try_parse_dates=True)
+df_csv = pl.read_csv("docs/docs-res/data/output.csv", try_parse_dates=True)
 print(df_csv)
 # --8<-- [end:csv2]
 
 # --8<-- [start:json]
-df.write_json("docs/data/output.json")
-df_json = pl.read_json("docs/data/output.json")
+df.write_json("docs/docs-res/data/output.json")
+df_json = pl.read_json("docs/docs-res/data/output.json")
 print(df_json)
 # --8<-- [end:json]
 
 # --8<-- [start:parquet]
-df.write_parquet("docs/data/output.parquet")
-df_parquet = pl.read_parquet("docs/data/output.parquet")
+df.write_parquet("docs/docs-res/data/output.parquet")
+df_parquet = pl.read_parquet("docs/docs-res/data/output.parquet")
 print(df_parquet)
 # --8<-- [end:parquet]
diff --git a/docs/src/python/user-guide/io/bigquery.py → ...docs/src/python/user-guide/io/bigquery.py b/docs/src/python/user-guide/io/bigquery.py → ...docs/src/python/user-guide/io/bigquery.py
diff --git a/...src/python/user-guide/io/cloud-storage.py → ...src/python/user-guide/io/cloud-storage.py b/...src/python/user-guide/io/cloud-storage.py → ...src/python/user-guide/io/cloud-storage.py
diff --git a/docs/src/python/user-guide/io/csv.py → docs/docs/src/python/user-guide/io/csv.py b/docs/src/python/user-guide/io/csv.py → docs/docs/src/python/user-guide/io/csv.py
@@ -5,15 +5,15 @@
 
 """
 # --8<-- [start:read]
-df = pl.read_csv("docs/data/path.csv")
+df = pl.read_csv("docs/docs-res/data/path.csv")
 # --8<-- [end:read]
 """
 
 # --8<-- [start:write]
 df = pl.DataFrame({"foo": [1, 2, 3], "bar": [None, "bak", "baz"]})
-df.write_csv("docs/data/path.csv")
+df.write_csv("docs/docs-res/data/path.csv")
 # --8<-- [end:write]
 
 # --8<-- [start:scan]
-df = pl.scan_csv("docs/data/path.csv")
+df = pl.scan_csv("docs/docs-res/data/path.csv")
 # --8<-- [end:scan]
diff --git a/docs/src/python/user-guide/io/database.py → ...docs/src/python/user-guide/io/database.py b/docs/src/python/user-guide/io/database.py → ...docs/src/python/user-guide/io/database.py
diff --git a/docs/src/python/user-guide/io/excel.py → docs/docs/src/python/user-guide/io/excel.py b/docs/src/python/user-guide/io/excel.py → docs/docs/src/python/user-guide/io/excel.py
@@ -5,22 +5,22 @@
 
 """
 # --8<-- [start:read]
-df = pl.read_excel("docs/data/path.xlsx")
+df = pl.read_excel("docs/docs-res/data/path.xlsx")
 # --8<-- [end:read]
 
 # --8<-- [start:read_sheet_name]
-df = pl.read_excel("docs/data/path.xlsx", sheet_name="Sales")
+df = pl.read_excel("docs/docs-res/data/path.xlsx", sheet_name="Sales")
 # --8<-- [end:read_sheet_name]
 """
 
 # --8<-- [start:write]
 df = pl.DataFrame({"foo": [1, 2, 3], "bar": [None, "bak", "baz"]})
-df.write_excel("docs/data/path.xlsx")
+df.write_excel("docs/docs-res/data/path.xlsx")
 # --8<-- [end:write]
 
 """
 # --8<-- [start:write_sheet_name]
 df = pl.DataFrame({"foo": [1, 2, 3], "bar": [None, "bak", "baz"]})
-df.write_excel("docs/data/path.xlsx", worksheet="Sales")
+df.write_excel("docs/docs-res/data/path.xlsx", worksheet="Sales")
 # --8<-- [end:write_sheet_name]
 """