From 928eb3e6a4c58b4ce549f09748a4ad1315b0b6b7 Mon Sep 17 00:00:00 2001 From: Sourabh Bajaj Date: Wed, 10 May 2017 12:04:20 -0700 Subject: [PATCH] [BEAM-2250] remove experimental and internal things from pydoc --- sdks/python/generate_pydoc.sh | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/sdks/python/generate_pydoc.sh b/sdks/python/generate_pydoc.sh index 6039942e7eda..1fea6f12a1c5 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'