name: Deploy Docs
on:
  workflow_run:
    workflows:
      - Build Docs
    types:
      - completed

jobs:
  deploy-docs:
    runs-on: ubuntu-latest
    steps:
      - name: Dump GitHub context
        env:
          GITHUB_CONTEXT: ${{ toJson(github) }}
        run: echo "$GITHUB_CONTEXT"
      - uses: actions/checkout@v4
      - name: Clean site
        run: |
          rm -rf ./site
          mkdir ./site

# go doc --help
! go doc --help
stderr 'go doc'
stderr 'go doc <pkg>'
stderr 'go doc <sym>\[\.<methodOrField>\]'
stderr 'go doc \[<pkg>\.\]<sym>\[\.<methodOrField>\]'
stderr 'go doc \[<pkg>\.\]\[<sym>\.\]<methodOrField>'
stderr 'go doc <pkg> <sym>\[\.<methodOrField>\]'

# go help doc
go help doc
stdout 'go doc'
stdout 'go doc <pkg>'
stdout 'go doc <sym>\[\.<methodOrField>\]'
stdout 'go doc \[<pkg>\.\]<sym>\[\.<methodOrField>\]'

# immediately before exporting docs. We do not want to check these documents in
# by default.

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

KUBE_HACK_ROOT=$(dirname "${BASH_SOURCE[0]}")

echo "WARNING: hack/generate-docs.sh is an alias for hack/update-generated-docs.sh"
echo "and will be removed in a future version."

import org.gradle.api.tasks.TaskAction
import gradlebuild.docs.BuildableDOMCategory
import gradlebuild.docs.DocGenerationException
import gradlebuild.docs.XIncludeAwareXmlProvider
import gradlebuild.docs.dsl.links.ClassLinkMetaData
import gradlebuild.docs.dsl.links.LinkMetaData
import gradlebuild.docs.dsl.source.model.ClassMetaData
import gradlebuild.docs.model.ClassMetaDataRepository
import gradlebuild.docs.model.SimpleClassMetaDataRepository

package p

/*
Doc comment.
  - List1.

  - List2.
*/
var X int

/* erroneous doc comment */
var Y int

/*
 * Another erroneous
 * doc comment.
 */

// license that can be found in the LICENSE file.

// Package doc extracts source code documentation from a Go AST.
package doc

import (
	"fmt"
	"go/ast"
	"go/doc/comment"
	"go/token"
	"strings"
)

// Package is the documentation for an entire package.
type Package struct {
	Doc        string
	Name       string
	ImportPath string
	Imports    []string
	Filenames  []string

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

-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

// license that can be found in the LICENSE file.

// Package race implements data race detection logic.
// No public interface is provided.
// For details about the race detector see
// https://golang.org/doc/articles/race_detector.html
package race

// limitations under the License.

// Package config is a common, top-level folder for aggregating Istio-wide config related libraries and utilities.
// More details can be found here: https://docs.google.com/document/d/1atY5vDHy5sXJP7qIaFQS3ixQZvOxUciPgULH5qTPX_8/