Skip to content

Commit

Permalink
Fix Docs (#676)
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael-J-Ward authored May 11, 2024
1 parent c6bdc9f commit 7d4a40c
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 5 deletions.
6 changes: 6 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ on:
- main
tags-ignore:
- "**-rc**"
pull_request:
branches:
- main

name: Deploy DataFusion Python site

Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/object_store.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
.. currentmodule:: datafusion.object_store

ObjectStore
=========
===========

.. autosummary::
:toctree: ../generated/
Expand Down
3 changes: 1 addition & 2 deletions docs/source/user-guide/common-operations/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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")
)
Expand Down
4 changes: 2 additions & 2 deletions docs/source/user-guide/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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>`_.

0 comments on commit 7d4a40c

Please sign in to comment.