This is an automated email from the ASF dual-hosted git repository.
agrove pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion-python.git
The following commit(s) were added to refs/heads/main by this push:
new 7d4a40c Fix Docs (#676)
7d4a40c is described below
commit 7d4a40cc73c37bcf41ccd3c6480627b03c9f93cc
Author: Michael J Ward <[email protected]>
AuthorDate: Sat May 11 13:32:01 2024 -0500
Fix Docs (#676)
---
.github/workflows/docs.yaml | 6 ++++++
docs/source/api/object_store.rst | 2 +-
docs/source/user-guide/common-operations/functions.rst | 3 +--
docs/source/user-guide/configuration.rst | 4 ++--
4 files changed, 10 insertions(+), 5 deletions(-)
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
index 1193d78..8551648 100644
--- a/.github/workflows/docs.yaml
+++ b/.github/workflows/docs.yaml
@@ -4,6 +4,9 @@ on:
- main
tags-ignore:
- "**-rc**"
+ pull_request:
+ branches:
+ - main
name: Deploy DataFusion Python site
@@ -13,6 +16,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Set target branch
+ if: github.event_name == 'push' && github.ref == 'refs/heads/main'
id: target-branch
run: |
set -x
@@ -27,6 +31,7 @@ jobs:
- name: Checkout docs sources
uses: actions/checkout@v3
- name: Checkout docs target branch
+ if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: actions/checkout@v3
with:
fetch-depth: 0
@@ -64,6 +69,7 @@ jobs:
make html
- name: Copy & push the generated HTML
+ if: github.event_name == 'push' && github.ref == 'refs/heads/main'
run: |
set -x
cd docs-target
diff --git a/docs/source/api/object_store.rst b/docs/source/api/object_store.rst
index eeb6c43..8d78f07 100644
--- a/docs/source/api/object_store.rst
+++ b/docs/source/api/object_store.rst
@@ -19,7 +19,7 @@
.. currentmodule:: datafusion.object_store
ObjectStore
-=========
+===========
.. autosummary::
:toctree: ../generated/
diff --git a/docs/source/user-guide/common-operations/functions.rst
b/docs/source/user-guide/common-operations/functions.rst
index 7e5c592..50b4930 100644
--- a/docs/source/user-guide/common-operations/functions.rst
+++ b/docs/source/user-guide/common-operations/functions.rst
@@ -92,13 +92,12 @@ DataFusion offers a range of helpful options.
f.left(col('"Name"'), literal(4)).alias("code")
)
-This also includes the functions for regular expressions
:func:`.regexp_replace` and :func:`.regexp_match`
+This also includes the functions for regular expressions like
:func:`.regexp_match`
.. ipython:: python
df.select(
f.regexp_match(col('"Name"'), literal("Char")).alias("dragons"),
- f.regexp_replace(col('"Name"'), literal("saur"),
literal("fleur")).alias("flowers")
)
diff --git a/docs/source/user-guide/configuration.rst
b/docs/source/user-guide/configuration.rst
index 63b0dc3..0c1a481 100644
--- a/docs/source/user-guide/configuration.rst
+++ b/docs/source/user-guide/configuration.rst
@@ -16,7 +16,7 @@
.. under the License.
Configuration
-========
+=============
Let's look at how we can configure DataFusion. When creating a
:code:`SessionContext`, you can pass in
a :code:`SessionConfig` and :code:`RuntimeConfig` object. These two cover a
wide range of options.
@@ -48,4 +48,4 @@ a :code:`SessionConfig` and :code:`RuntimeConfig` object.
These two cover a wide
You can read more about available :code:`SessionConfig` options `here
<https://arrow.apache.org/datafusion/user-guide/configs.html>`_,
-and about :code:`RuntimeConfig` options `here
https://docs.rs/datafusion/latest/datafusion/execution/runtime_env/struct.RuntimeConfig.html`_.
+and about :code:`RuntimeConfig` options `here
<https://docs.rs/datafusion/latest/datafusion/execution/runtime_env/struct.RuntimeConfig.html>`_.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
