Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation generation in CI #315

Merged
merged 3 commits into from
Apr 6, 2023
Merged

Fix documentation generation in CI #315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a0e6671
install protoc in docs workflow
andygrove Apr 6, 2023
a1ec145
fix docs gen
andygrove Apr 6, 2023
0af86e0
Merge remote-tracking branch 'apache/main' into fix-docs
andygrove Apr 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,16 @@
# 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

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

Expand Down
2 changes: 0 additions & 2 deletions docs/build.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
# specific language governing permissions and limitations
# under the License.

sphinx
sphinx==5.3.0
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the fix. We were picking up a 6.x.x version which is not compatible with our content

pydata-sphinx-theme==0.8.0
myst-parser
maturin
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ API Reference
api/config
api/dataframe
api/execution_context
api/expr
api/expression
api/functions
api/object_store