# Usage: `hack/verify-generated-docs.sh`.

set -o errexit
set -o nounset
set -o pipefail

KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
source "${KUBE_ROOT}/hack/lib/verify-generated.sh"

  genman "${dest}/docs/man/man1/" "kube-apiserver"
  genman "${dest}/docs/man/man1/" "kube-controller-manager"
  genman "${dest}/docs/man/man1/" "kube-proxy"
  genman "${dest}/docs/man/man1/" "kube-scheduler"
  genman "${dest}/docs/man/man1/" "kubelet"
  genman "${dest}/docs/man/man1/" "kubectl"
  genman "${dest}/docs/man/man1/" "kubeadm"

  mkdir -p "${dest}/docs/yaml/kubectl/"
  genyaml "${dest}/docs/yaml/kubectl/"

# See the License for the specific language governing permissions and
# limitations under the License.

# This script checks API-related files for mismatch in docs and field names,
# and outputs a list of fields that their docs and field names are mismatched.
# Usage: `hack/verify-fieldname-docs.sh`.

set -o errexit
set -o nounset
set -o pipefail

KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
source "${KUBE_ROOT}/hack/lib/init.sh"

-e .
-r requirements-docs-tests.txt
mkdocs-material==9.5.18
mdx-include >=1.4.1,<2.0.0
mkdocs-redirects>=1.2.1,<1.3.0
typer >=0.12.0
pyyaml >=5.3.1,<7.0.0
# For Material for MkDocs, Chinese search
jieba==0.42.1
# For image processing by Material for MkDocs
pillow==10.3.0
# For image processing by Material for MkDocs
cairosvg==2.7.0
mkdocstrings[python]==0.24.3
griffe-typingdoc==0.2.2
# For griffe, it formats with black
black==24.3.0

options ndots:-1...

options ndots:16...

kind: feature
area: documentation
releaseNotes:
  - |
    **Added** The locality load balancing docs have been re-written into a
    formal traffic management task. The new docs describe in more detail
    how locality load balancing works as well as how to configure both
    failover and weighted distribution. In addition, the new docs are now

apiVersion: release-notes/v2
kind: feature
area: documentation
releaseNotes:
  - |
    **Added** Multicluster install docs have been re-written based on current
    best practices, incorporating recent updates to onboarding tooling. In
    particular, the multi-primary configuration (formerly known as
    "replicated control planes") no longer relies on manually configuring the
    `.global` stub domain, preferring instead to use `*.svc.cluster.local` for

# 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.

# Script to generate docs from the latest swagger spec.

set -o errexit
set -o nounset
set -o pipefail

cd /build

# gendocs takes "input.json" as the input swagger spec.
# $1 is expected to be <group>_<version>

### Disable the automatic docs

The first step is to disable the automatic docs, as by default, those use the default CDN.

To disable them, set their URLs to `None` when creating your `FastAPI` app:

```Python hl_lines="8"
{!../../../docs_src/custom_docs_ui/tutorial001.py!}
```

### Include the custom docs

Now you can create the *path operations* for the custom docs.