run_sphinx_autogen.py

# Licensed to the Software Freedom Conservancy (SFC) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The SFC 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.

"""Wrapper to run sphinx-autogen for generating autodoc stub pages."""

import os
import sys

from sphinx.ext.autosummary.generate import main as autogen_main

if __name__ == "__main__":
    # Support running via bazel run (uses BUILD_WORKSPACE_DIRECTORY)
    workspace = os.environ.get("BUILD_WORKSPACE_DIRECTORY", "")
    base_dir = os.path.join(workspace, "py") if workspace else "."
    os.chdir(base_dir)

    sys.exit(autogen_main(["docs/source/api.rst"]))