chore: Update links to API references

.github/ISSUE_TEMPLATE/documentation.yml

@@ -18,6 +18,6 @@ body:
       label: Link
       description: >
         Provide a link to the existing documentation, if applicable.
-      placeholder: ex. https://docs.pola.rs/docs/python/dev/...
+      placeholder: ex. https://docs.pola.rs/api/python/dev/...
     validations:
       required: false

.github/workflows/docs-python.yml

@@ -55,7 +55,7 @@ jobs:
         uses: JamesIves/github-pages-deploy-action@v4
         with:
           folder: py-polars/docs/build/html
-          target-folder: docs/python/dev
+          target-folder: api/python/dev
           single-commit: true
 
       - name: Parse the tag to find the major/minor version of Polars
@@ -74,14 +74,13 @@ jobs:
         uses: JamesIves/github-pages-deploy-action@v4
         with:
           folder: py-polars/docs/build/html
-          target-folder: docs/python/version/${{ steps.version.outputs.version }}
+          target-folder: api/python/version/${{ steps.version.outputs.version }}
           single-commit: true
 
       - name: Deploy Python docs for latest release version - stable
         if: github.event_name == 'repository_dispatch'
         uses: JamesIves/github-pages-deploy-action@v4
         with:
           folder: py-polars/docs/build/html
-          # Keeping this folder for backwards compatibility
-          target-folder: py-polars/html
+          target-folder: api/python/stable
           single-commit: true

.github/workflows/docs-rust.yml

@@ -46,7 +46,7 @@ jobs:
         uses: JamesIves/github-pages-deploy-action@v4
         with:
           folder: target/doc
-          target-folder: docs/rust/dev
+          target-folder: api/rust/dev
           single-commit: true
 
       # Make sure documentation artifacts are not cached

README.md

@@ -23,7 +23,7 @@
 
 <p align="center">
   <b>Documentation</b>:
-  <a href="https://docs.pola.rs/py-polars/html/reference/index.html">Python</a>
+  <a href="https://docs.pola.rs/api/python/stable/reference/index.html">Python</a>
   -
   <a href="https://docs.rs/polars/latest/polars/">Rust</a>
   -

docs/api/index.md

@@ -11,7 +11,7 @@ It's the best place to look if you need information on a specific function.
 ## Python
 
 The Python API reference is built using Sphinx.
-It's available in [our docs](https://docs.pola.rs/py-polars/html/reference/index.html).
+It's available in [our docs](https://docs.pola.rs/api/python/stable/reference/index.html).
 
 ## Rust
 

docs/development/contributing/index.md

@@ -257,7 +257,7 @@ Before committing, install `dprint` (see above) and run `dprint fmt` from the `d
 
 ### API reference
 
-Polars has separate API references for [Rust](https://docs.pola.rs/docs/rust/dev/polars/) and [Python](https://docs.pola.rs/docs/python/dev/reference/index.html).
+Polars has separate API references for [Rust](https://docs.pola.rs/api/rust/dev/polars/) and [Python](https://docs.pola.rs/api/python/dev/reference/index.html).
 These are generated directly from the codebase, so in order to contribute, you will have to follow the steps outlined in [this section](#contributing-to-the-codebase) above.
 
 #### Rust

docs/development/versioning.md

@@ -33,7 +33,7 @@ We know it takes time and energy for our users to keep up with new releases but,
 
 **A breaking change occurs when an existing component of the public API is changed or removed.**
 
-A feature is part of the public API if it is documented in the [API reference](https://docs.pola.rs/py-polars/html/reference/index.html).
+A feature is part of the public API if it is documented in the [API reference](https://docs.pola.rs/api/python/stable/reference/index.html).
 
 Examples of breaking changes:
 

docs/user-guide/expressions/functions.md

@@ -40,9 +40,9 @@ You can change the output name of an expression by using the `alias` function
 In case of multiple columns for example when using `all()` or `col(*)` you can apply a mapping function `name.map` to change the original column name into something else. In case you want to add a suffix (`name.suffix()`) or prefix (`name.prefix()`) these are also built in.
 
 === ":fontawesome-brands-python: Python"
-[:material-api: `name.prefix`](https://docs.pola.rs/py-polars/html/reference/expressions/api/polars.Expr.name.prefix.html)
-[:material-api: `name.suffix`](https://docs.pola.rs/py-polars/html/reference/expressions/api/polars.Expr.name.suffix.html)
-[:material-api: `name.map`](https://docs.pola.rs/py-polars/html/reference/expressions/api/polars.Expr.name.map.html)
+[:material-api: `name.prefix`](https://docs.pola.rs/api/python/stable/reference/expressions/api/polars.Expr.name.prefix.html)
+[:material-api: `name.suffix`](https://docs.pola.rs/api/python/stable/reference/expressions/api/polars.Expr.name.suffix.html)
+[:material-api: `name.map`](https://docs.pola.rs/api/python/stable/reference/expressions/api/polars.Expr.name.map.html)
 
 ## Count unique values
 

docs/user-guide/expressions/plugins.md

@@ -126,7 +126,7 @@ df = pl.DataFrame(
 out = df.with_columns(pig_latin=pig_latinnify("convert"))
 ```
 
-Alternatively, you can [register a custom namespace](https://docs.pola.rs/py-polars/html/reference/api/polars.api.register_expr_namespace.html#polars.api.register_expr_namespace), which enables you to write:
+Alternatively, you can [register a custom namespace](https://docs.pola.rs/api/python/stable/reference/api/polars.api.register_expr_namespace.html#polars.api.register_expr_namespace), which enables you to write:
 
 ```python
 out = df.with_columns(

docs/user-guide/expressions/user-defined-functions.md

@@ -25,7 +25,7 @@ Use cases for `map_batches` are for instance passing the `Series` in an expressi
 we could use `map_batches` to pass an expression column to a neural network model.
 
 === ":fontawesome-brands-python: Python"
-[:material-api: `map_batches`](https://docs.pola.rs/py-polars/html/reference/expressions/api/polars.Expr.map_batches.html)
+[:material-api: `map_batches`](https://docs.pola.rs/api/python/stable/reference/expressions/api/polars.Expr.map_batches.html)
 
 ```python
 df.with_columns([
@@ -90,7 +90,7 @@ That is:
 So with `map_elements` we should be able to fix our example:
 
 === ":fontawesome-brands-python: Python"
-[:material-api: `map_elements`](https://docs.pola.rs/py-polars/html/reference/expressions/api/polars.Expr.map_elements.html)
+[:material-api: `map_elements`](https://docs.pola.rs/api/python/stable/reference/expressions/api/polars.Expr.map_elements.html)
 
 {{code_block('user-guide/expressions/user-defined-functions','map_elements',[])}}
 

py-polars/docs/source/_static/version_switcher.json

@@ -2,22 +2,22 @@
   {
     "name": "dev",
     "version": "dev",
-    "url": "https://docs.pola.rs/docs/python/dev/"
+    "url": "https://docs.pola.rs/api/python/dev/"
   },
   {
     "name": "0.20 (stable)",
     "version": "0.20",
-    "url": "https://docs.pola.rs/py-polars/html/",
+    "url": "https://docs.pola.rs/api/python/stable/",
     "preferred": true
   },
   {
     "name": "0.19",
     "version": "0.19",
-    "url": "https://docs.pola.rs/docs/python/version/0.19/"
+    "url": "https://docs.pola.rs/api/python/version/0.19/"
   },
   {
     "name": "0.18",
     "version": "0.18",
-    "url": "https://docs.pola.rs/docs/python/version/0.18/"
+    "url": "https://docs.pola.rs/api/python/version/0.18/"
   }
 ]

py-polars/docs/source/conf.py

@@ -155,7 +155,7 @@
         "image_dark": f"{static_assets_root}/logos/polars-logo-dimmed-medium.png",
     },
     "switcher": {
-        "json_url": f"{web_root}/docs/python/dev/_static/version_switcher.json",
+        "json_url": f"{web_root}/api/python/dev/_static/version_switcher.json",
         "version_match": switcher_version,
     },
     "show_version_warning_banner": False,

py-polars/pyproject.toml

@@ -33,7 +33,7 @@ classifiers = [
 
 [project.urls]
 Homepage = "https://www.pola.rs/"
-Documentation = "https://docs.pola.rs/py-polars/html/reference/index.html"
+Documentation = "https://docs.pola.rs/api/python/stable/reference/index.html"
 Repository = "https://github.com/pola-rs/polars"
 Changelog = "https://github.com/pola-rs/polars/releases"