diff --git a/docs/README.md b/docs/README.md index a6f4998c8..6d8b2d57d 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 3f24f8eec..7e8bb0b54 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 2af563587..8eb744968 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 a3e7e24df..a5d65433d 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