Repository: beam Updated Branches: refs/heads/master 298ca2592 -> df04303ec
[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/ab6824d3 Tree: http://git-wip-us.apache.org/repos/asf/beam/tree/ab6824d3 Diff: http://git-wip-us.apache.org/repos/asf/beam/diff/ab6824d3 Branch: refs/heads/master Commit: ab6824d35ce3be481f98efed4b65a8dd264652d6 Parents: 298ca25 Author: Sourabh Bajaj <[email protected]> Authored: Wed May 10 12:04:20 2017 -0700 Committer: Ahmet Altay <[email protected]> Committed: Wed May 10 12:10:50 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/ab6824d3/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'
