mirror of
https://github.com/apache/arrow.git
synced 2026-10-29 00:56:31 +08:00
Add doc generation to docker-compose
This commit is contained in:
1 parent
185cba8fb4
commit
7aeff65efa
5 files changed
+50
-10
No files matched your search
@@ -37,6 +37,7 @@ MANIFEST
|
||||
*.iml
|
||||
|
||||
cpp/.idea/
|
||||
cpp/apidoc/xml/
|
||||
python/.eggs/
|
||||
.vscode
|
||||
.idea/
|
||||
|
||||
@@ -23,3 +23,9 @@ pytest
|
||||
python
|
||||
setuptools
|
||||
setuptools_scm
|
||||
# Requirements for building the documentation
|
||||
breathe
|
||||
ipython
|
||||
recommonmark
|
||||
sphinx
|
||||
sphinx_rtd_theme
|
||||
Executable
+33
@@ -0,0 +1,33 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# Licensed to the Apache Software Foundation (ASF) under one or more
|
||||
# contributor license agreements. See the NOTICE file distributed with
|
||||
# this work for additional information regarding copyright ownership.
|
||||
# The ASF licenses this file to You under the Apache License, Version 2.0
|
||||
# (the "License"); you may not use this file except in compliance with
|
||||
# the License. You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
#
|
||||
|
||||
set -ex
|
||||
|
||||
arrow/ci/docker_build_cpp.sh
|
||||
arrow/ci/docker_build_python.sh
|
||||
|
||||
pushd /arrow/cpp/apidoc
|
||||
doxygen
|
||||
popd
|
||||
|
||||
pushd /arrow/python
|
||||
python setup.py build_sphinx -s ../doc/source --build-dir ../doc/_build
|
||||
popd
|
||||
|
||||
mkdir -p /arrow/site/asf-site/docs/latest
|
||||
rsync -r /arrow/doc/_build/html/ /arrow/site/asf-site/docs/latest/
|
||||
@@ -87,15 +87,6 @@ rsync -r doc/parquet-glib/html/ ../../site/asf-site/docs/c_glib/parquet-glib
|
||||
popd
|
||||
popd
|
||||
|
||||
# Now Python documentation can be built
|
||||
pushd arrow/python
|
||||
python setup.py build_ext --build-type=$ARROW_BUILD_TYPE \
|
||||
--with-plasma --with-parquet --inplace
|
||||
python setup.py build_sphinx -s ../doc/source
|
||||
mkdir -p ../site/asf-site/docs/python
|
||||
rsync -r doc/_build/html/ ../site/asf-site/docs/python
|
||||
popd
|
||||
|
||||
# Make C++ documentation
|
||||
pushd arrow/cpp/apidoc
|
||||
rm -rf html/*
|
||||
|
||||
+10
-1
@@ -152,7 +152,7 @@ services:
|
||||
######################### Tools and Linters #################################
|
||||
|
||||
# TODO(kszucs): site
|
||||
# TODO(kszucs): apidoc
|
||||
# TODO(kszucs): {cpp,java,glib,js}-apidoc
|
||||
|
||||
lint:
|
||||
# Usage:
|
||||
@@ -186,6 +186,15 @@ services:
|
||||
command: arrow/dev/lint/run_clang_format.sh
|
||||
volumes: *ubuntu-volumes
|
||||
|
||||
docs:
|
||||
# Usage:
|
||||
# docker-compose build cpp
|
||||
# docker-compose build python
|
||||
# docker-compose run docs
|
||||
image: arrow:python-3.6
|
||||
command: arrow/dev/docs/run_doc.sh
|
||||
volumes: *volumes
|
||||
|
||||
######################### Integration Tests #################################
|
||||
|
||||
# impala:
|
||||
|
||||
Reference in new issue
Block a user