mirror of
https://github.com/apache/arrow.git
synced 2026-10-29 00:56:31 +08:00
Rename doc to docs
This commit is contained in:
1 parent
918e762443
commit
0b4dd33412
48 files changed
+46
-22
No files matched your search
+1
-1
@@ -17,6 +17,7 @@
|
||||
|
||||
.git
|
||||
docker_cache
|
||||
docs/_build
|
||||
|
||||
# IDE
|
||||
.vscode
|
||||
@@ -49,7 +50,6 @@ python/dist
|
||||
python/*.egg-info
|
||||
python/*.egg
|
||||
python/*.pyc
|
||||
python/doc/_build
|
||||
__pycache__/
|
||||
*/__pycache__/
|
||||
*/*/__pycache__/
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# 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.
|
||||
|
||||
# Requirements for building the documentation
|
||||
breathe
|
||||
doxygen
|
||||
ipython
|
||||
sphinx
|
||||
sphinx_rtd_theme
|
||||
@@ -18,16 +18,13 @@
|
||||
|
||||
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
|
||||
python setup.py build_sphinx -s ../docs/source --build-dir ../docs/_build
|
||||
popd
|
||||
|
||||
mkdir -p /arrow/site/asf-site/docs/latest
|
||||
rsync -r /arrow/doc/_build/html/ /arrow/site/asf-site/docs/latest/
|
||||
rsync -r /arrow/docs/_build/html/ /arrow/site/asf-site/docs/latest/
|
||||
@@ -35,7 +35,7 @@ SET(ARROW_FLIGHT_STATIC_LINK_LIBS
|
||||
# TODO(wesm): Protobuf shared vs static linking
|
||||
|
||||
set(FLIGHT_PROTO_PATH "${CMAKE_SOURCE_DIR}/../format")
|
||||
set(FLIGHT_PROTO ${CMAKE_SOURCE_DIR}/../doc/source/format/Flight.proto)
|
||||
set(FLIGHT_PROTO ${CMAKE_SOURCE_DIR}/../docs/source/format/Flight.proto)
|
||||
|
||||
set(FLIGHT_GENERATED_PROTO_FILES
|
||||
"${CMAKE_CURRENT_BINARY_DIR}/Flight.pb.cc"
|
||||
|
||||
@@ -52,10 +52,10 @@ set(FBS_OUTPUT_FILES
|
||||
"${OUTPUT_DIR}/feather_generated.h")
|
||||
|
||||
set(FBS_SRC
|
||||
${CMAKE_SOURCE_DIR}/../doc/source/format/Message.fbs
|
||||
${CMAKE_SOURCE_DIR}/../doc/source/format/File.fbs
|
||||
${CMAKE_SOURCE_DIR}/../doc/source/format/Schema.fbs
|
||||
${CMAKE_SOURCE_DIR}/../doc/source/format/Tensor.fbs
|
||||
${CMAKE_SOURCE_DIR}/../docs/source/format/Message.fbs
|
||||
${CMAKE_SOURCE_DIR}/../docs/source/format/File.fbs
|
||||
${CMAKE_SOURCE_DIR}/../docs/source/format/Schema.fbs
|
||||
${CMAKE_SOURCE_DIR}/../docs/source/format/Tensor.fbs
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/feather.fbs)
|
||||
|
||||
foreach(FIL ${FBS_SRC})
|
||||
|
||||
@@ -114,7 +114,7 @@ dev/tasks/linux-packages/debian/plasma-store-server.install
|
||||
dev/tasks/linux-packages/debian/rules
|
||||
dev/tasks/linux-packages/debian/source/format
|
||||
dev/tasks/linux-packages/debian/watch
|
||||
doc/requirements.txt
|
||||
docs/requirements.txt
|
||||
go/arrow/go.sum
|
||||
go/arrow/Gopkg.lock
|
||||
go/arrow/internal/cpu/*
|
||||
|
||||
+5
-2
@@ -190,9 +190,12 @@ services:
|
||||
# Usage:
|
||||
# docker-compose build cpp
|
||||
# docker-compose build python
|
||||
# docker-compose build docs
|
||||
# docker-compose run docs
|
||||
image: arrow:python-3.6
|
||||
command: arrow/dev/docs/run_doc.sh
|
||||
image: arrow:docs
|
||||
build:
|
||||
context: .
|
||||
dockerfile: docs/Dockerfile
|
||||
volumes: *volumes
|
||||
|
||||
######################### Integration Tests #################################
|
||||
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -30,6 +30,7 @@
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
import pyarrow
|
||||
import os
|
||||
import sys
|
||||
|
||||
@@ -105,9 +106,9 @@ author = u'Apache Software Foundation'
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = u''
|
||||
version = pyarrow.__version__
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = u''
|
||||
release = pyarrow.__version__
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
@@ -183,7 +184,7 @@ html_theme_options = {
|
||||
# The name for this set of Sphinx documents.
|
||||
# "<project> v<release> documentation" by default.
|
||||
#
|
||||
# html_title = u'Apache Arrow v0.1.0'
|
||||
html_title = u'Apache Arrow v{}'.format(version)
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
+1
-1
@@ -165,7 +165,7 @@
|
||||
<execution>
|
||||
<id>src</id>
|
||||
<configuration>
|
||||
<protoSourceRoot>${basedir}/../../doc/source/format/</protoSourceRoot>
|
||||
<protoSourceRoot>${basedir}/../../docs/source/format/</protoSourceRoot>
|
||||
<outputDirectory>${project.build.directory}/generated-sources/protobuf</outputDirectory>
|
||||
</configuration>
|
||||
<goals>
|
||||
|
||||
+4
-4
@@ -104,10 +104,10 @@
|
||||
<argument>-j</argument>
|
||||
<argument>-o</argument>
|
||||
<argument>${flatc.generated.files}</argument>
|
||||
<argument>../../doc/source/format/Schema.fbs</argument>
|
||||
<argument>../../doc/source/format/Tensor.fbs</argument>
|
||||
<argument>../../doc/source/format/File.fbs</argument>
|
||||
<argument>../../doc/source/format/Message.fbs</argument>
|
||||
<argument>../../docs/source/format/Schema.fbs</argument>
|
||||
<argument>../../docs/source/format/Tensor.fbs</argument>
|
||||
<argument>../../docs/source/format/File.fbs</argument>
|
||||
<argument>../../docs/source/format/Message.fbs</argument>
|
||||
</arguments>
|
||||
</configuration>
|
||||
</execution>
|
||||
|
||||
Reference in new issue
Block a user