[arrow-datafusion-python] branch main updated: Fix documentation generation in CI (#315)

[ag...@apache.org]

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/arrow-datafusion-python.git


The following commit(s) were added to refs/heads/main by this push:
     new 31418b5  Fix documentation generation in CI (#315)
31418b5 is described below

commit 31418b5f5cdc876142c34a3b15bbd89fe3a34a04
Author: Andy Grove <an...@gmail.com>
AuthorDate: Thu Apr 6 07:56:33 2023 -0600

    Fix documentation generation in CI (#315)
    
    * install protoc in docs workflow
    
    * fix docs gen
---
 docs/README.md        | 6 +++---
 docs/build.sh         | 2 --
 docs/requirements.txt | 2 +-
 docs/source/api.rst   | 2 +-
 4 files changed, 5 insertions(+), 7 deletions(-)

diff --git a/docs/README.md b/docs/README.md
index a6f4998..6d8b2d5 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -20,8 +20,8 @@
 # DataFusion Documentation
 
 This folder contains the source content of the [python api](./source/api).
-These are both published to https://arrow.apache.org/datafusion/ 
-as part of the release process.
+This is published to https://arrow.apache.org/datafusion-python/ by a GitHub action 
+when changes are merged to the main branch.
 
 ## Dependencies
 
@@ -29,7 +29,7 @@ It's recommended to install build dependencies and build the documentation
 inside a Python virtualenv.
 
 - Python
-- `pip install -r requirements.txt`
+- `pip3 install -r requirements.txt`
 
 ## Build & Preview
 
diff --git a/docs/build.sh b/docs/build.sh
index 3f24f8e..7e8bb0b 100755
--- a/docs/build.sh
+++ b/docs/build.sh
@@ -23,6 +23,4 @@ rm -rf build 2> /dev/null
 rm -rf temp 2> /dev/null
 mkdir temp
 cp -rf source/* temp/
-# replace relative URLs with absolute URLs
-#sed -i 's/\.\.\/\.\.\/\.\.\//https:\/\/github.com\/apache\/arrow-datafusion\/blob\/master\//g' temp/contributor-guide/index.md
 make SOURCEDIR=`pwd`/temp html
\ No newline at end of file
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 2af5635..8eb7449 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-sphinx
+sphinx==5.3.0
 pydata-sphinx-theme==0.8.0
 myst-parser
 maturin
diff --git a/docs/source/api.rst b/docs/source/api.rst
index a3e7e24..a5d6543 100644
--- a/docs/source/api.rst
+++ b/docs/source/api.rst
@@ -27,6 +27,6 @@ API Reference
    api/config
    api/dataframe
    api/execution_context
-   api/expr
+   api/expression
    api/functions
    api/object_store