generate-docs.sh 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. #!/bin/bash
  2. # Copyright 2014 The Kubernetes Authors.
  3. #
  4. # Licensed under the Apache License, Version 2.0 (the "License");
  5. # you may not use this file except in compliance with the License.
  6. # You may obtain a copy of the License at
  7. #
  8. # http://www.apache.org/licenses/LICENSE-2.0
  9. #
  10. # Unless required by applicable law or agreed to in writing, software
  11. # distributed under the License is distributed on an "AS IS" BASIS,
  12. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. # See the License for the specific language governing permissions and
  14. # limitations under the License.
  15. # This file is not intended to be run automatically. It is meant to be run
  16. # immediately before exporting docs. We do not want to check these documents in
  17. # by default.
  18. set -o errexit
  19. set -o nounset
  20. set -o pipefail
  21. KUBE_ROOT=$(dirname "${BASH_SOURCE}")/..
  22. source "${KUBE_ROOT}/hack/lib/init.sh"
  23. kube::golang::setup_env
  24. BINS=(
  25. cmd/gendocs
  26. cmd/genkubedocs
  27. cmd/genman
  28. cmd/genyaml
  29. federation/cmd/genfeddocs
  30. )
  31. make -C "${KUBE_ROOT}" WHAT="${BINS[*]}"
  32. kube::util::ensure-temp-dir
  33. kube::util::gen-docs "${KUBE_TEMP}"
  34. # remove all of the old docs
  35. kube::util::remove-gen-docs
  36. # Copy fresh docs into the repo.
  37. # the shopt is so that we get .generated_docs from the glob.
  38. shopt -s dotglob
  39. cp -af "${KUBE_TEMP}"/* "${KUBE_ROOT}"
  40. shopt -u dotglob
  41. echo "Generated docs have been placed in the repository tree. Running hack/update-munge-docs.sh."
  42. "${KUBE_ROOT}/hack/update-munge-docs.sh"