You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by al...@apache.org on 2017/05/10 19:19:22 UTC
[2/3] beam git commit: [BEAM-2250] remove experimental and internal
things from pydoc
[BEAM-2250] remove experimental and internal things from pydoc
Project: http://git-wip-us.apache.org/repos/asf/beam/repo
Commit: http://git-wip-us.apache.org/repos/asf/beam/commit/4ba330a5
Tree: http://git-wip-us.apache.org/repos/asf/beam/tree/4ba330a5
Diff: http://git-wip-us.apache.org/repos/asf/beam/diff/4ba330a5
Branch: refs/heads/release-2.0.0
Commit: 4ba330a5a22e9b9f0aec49dcd6cb51f303ebbd9b
Parents: 6602cd3
Author: Sourabh Bajaj <so...@google.com>
Authored: Wed May 10 12:04:20 2017 -0700
Committer: Sourabh Bajaj <so...@google.com>
Committed: Wed May 10 12:13:57 2017 -0700
----------------------------------------------------------------------
sdks/python/generate_pydoc.sh | 15 +++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/beam/blob/4ba330a5/sdks/python/generate_pydoc.sh
----------------------------------------------------------------------
diff --git a/sdks/python/generate_pydoc.sh b/sdks/python/generate_pydoc.sh
index 6039942..1fea6f1 100755
--- a/sdks/python/generate_pydoc.sh
+++ b/sdks/python/generate_pydoc.sh
@@ -31,21 +31,24 @@ rm -rf target/docs/*
mkdir -p target/docs/source
-# Exclude autogenerated API message definition files that aren't part of SDK.
-excluded_internal_clients=(
+# Exclude internal/experimental files from the documentation.
+excluded_internal_code=(
+ apache_beam/examples/
apache_beam/internal/clients/
apache_beam/io/gcp/internal/clients/
+ apache_beam/runners/api/
+ apache_beam/runners/test/
+ apache_beam/runners/portability/
+ apache_beam/runners/worker/
apache_beam/runners/dataflow/internal/clients/
- apache_beam/examples/complete/juliaset/setup.py)
+ apache_beam/testing/data/)
python $(type -p sphinx-apidoc) -f -o target/docs/source apache_beam \
- "${excluded_internal_clients[@]}" "*_test.py"
+ "${excluded_internal_code[@]}" "*_test.py"
# Remove Cython modules from doc template; they won't load
sed -i -e '/.. automodule:: apache_beam.coders.stream/d' \
target/docs/source/apache_beam.coders.rst
-sed -i -e '/.. automodule:: apache_beam.runners.worker.statesampler/d' \
- target/docs/source/apache_beam.runners.worker.rst
# Create the configuration and index files
cat > target/docs/source/conf.py <<'EOF'