Skip to content

Commit 4e52026

Browse files
committed
add independent sphinx tree for api
1 parent be815dd commit 4e52026

File tree

4 files changed

+27
-3
lines changed

4 files changed

+27
-3
lines changed

doc/CMakeLists.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,5 @@ sphinx_add_target(paddle_docs_cn
4747
${SPHINX_CACHE_DIR_CN}
4848
${CMAKE_CURRENT_SOURCE_DIR}
4949
${SPHINX_HTML_DIR_CN})
50+
51+
add_subdirectory(api)

doc/api/CMakeLists.txt

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# configured documentation tools and intermediate build results
2+
set(BINARY_BUILD_DIR_EN "${CMAKE_CURRENT_BINARY_DIR}/en/_build")
3+
4+
# Sphinx cache with pickled ReST documents
5+
set(SPHINX_CACHE_DIR_EN "${CMAKE_CURRENT_BINARY_DIR}/en/_doctrees")
6+
7+
# HTML output director
8+
set(SPHINX_HTML_DIR_EN "${CMAKE_CURRENT_BINARY_DIR}/en/html")
9+
10+
configure_file(
11+
"${CMAKE_CURRENT_SOURCE_DIR}/../templates/conf.py.en.in"
12+
"${BINARY_BUILD_DIR_EN}/conf.py"
13+
@ONLY)
14+
15+
sphinx_add_target(paddle_api_docs
16+
html
17+
${BINARY_BUILD_DIR_EN}
18+
${SPHINX_CACHE_DIR_EN}
19+
${CMAKE_CURRENT_SOURCE_DIR}
20+
${SPHINX_HTML_DIR_EN})

paddle/scripts/docker/build.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ EOF
117117
-DWITH_STYLE_CHECK=OFF
118118
make -j `nproc` gen_proto_py
119119
make -j `nproc` paddle_python
120-
make -j `nproc` paddle_docs paddle_docs_cn
120+
make -j `nproc` paddle_docs paddle_docs_cn paddle_api_docs
121121
make -j `nproc` print_operators_doc
122122
paddle/pybind/print_operators_doc > doc/en/html/operators.json
123123
popd

paddle/scripts/travis/build_doc.sh

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,14 @@ cd $TRAVIS_BUILD_DIR/build
99
cmake .. -DCMAKE_BUILD_TYPE=Debug -DWITH_GPU=OFF -DWITH_MKL=OFF -DWITH_DOC=ON
1010
make -j `nproc` gen_proto_py
1111
make -j `nproc` paddle_python
12-
make -j `nproc` paddle_docs paddle_docs_cn
12+
make -j `nproc` paddle_docs paddle_docs_cn paddle_api_docs
1313
make -j `nproc` print_operators_doc
1414
paddle/pybind/print_operators_doc > doc/en/html/operators.json
1515

1616
# check websites for broken links
1717
linkchecker doc/en/html/index.html
1818
linkchecker doc/cn/html/index.html
19+
linkchecker doc/api/en/html/index.html
1920

2021
# Parse Github URL
2122
REPO=`git config remote.origin.url`
@@ -54,10 +55,11 @@ function deploy_docs() {
5455
mkdir -p ${DIR}
5556
# remove old docs. mv new docs.
5657
set +e
57-
rm -rf ${DIR}/doc ${DIR}/doc_cn
58+
rm -rf ${DIR}/doc ${DIR}/doc_cn ${DIR}/api_doc
5859
set -e
5960
cp -r ../doc/cn/html ${DIR}/doc_cn
6061
cp -r ../doc/en/html ${DIR}/doc
62+
cp -r ../doc/api/en/html ${DIR}/api_doc
6163
git add .
6264
}
6365

0 commit comments

Comments
 (0)