k8s.io/kubernetes@v1.31.0-alpha.0.0.20240520171757-56147500dadc/hack/generate-docs.sh (about)

     1  #!/usr/bin/env bash
     2  
     3  # Copyright 2014 The Kubernetes Authors.
     4  #
     5  # Licensed under the Apache License, Version 2.0 (the "License");
     6  # you may not use this file except in compliance with the License.
     7  # You may obtain a copy of the License at
     8  #
     9  #     http://www.apache.org/licenses/LICENSE-2.0
    10  #
    11  # Unless required by applicable law or agreed to in writing, software
    12  # distributed under the License is distributed on an "AS IS" BASIS,
    13  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14  # See the License for the specific language governing permissions and
    15  # limitations under the License.
    16  
    17  # This file is not intended to be run automatically. It is meant to be run
    18  # immediately before exporting docs. We do not want to check these documents in
    19  # by default.
    20  
    21  set -o errexit
    22  set -o nounset
    23  set -o pipefail
    24  
    25  KUBE_HACK_ROOT=$(dirname "${BASH_SOURCE[0]}")
    26  
    27  echo "WARNING: hack/generate-docs.sh is an alias for hack/update-generated-docs.sh"
    28  echo "and will be removed in a future version."
    29  
    30  "${KUBE_HACK_ROOT}"/update-generated-docs.sh