diff --git a/content/docs/languages/android/_index.md b/content/docs/languages/android/_index.md index 003d98e..9d39bd6 100644 --- a/content/docs/languages/android/_index.md +++ b/content/docs/languages/android/_index.md @@ -1,9 +1,10 @@ --- title: Android Java +api_path: grpc-java/javadoc --- These language-specific pages are available: - [Quick start](quickstart) - [Basics tutorial](basics) -- [API reference](https://grpc.github.io/grpc-java/javadoc) +- [API reference](api/{{< param api_path >}}) diff --git a/content/docs/languages/android/api.md b/content/docs/languages/android/api.md new file mode 100644 index 0000000..ad19bbb --- /dev/null +++ b/content/docs/languages/android/api.md @@ -0,0 +1,7 @@ +--- +title: API reference +short: API +path: grpc-java/javadoc +weight: 90 +# Note: this is a placeholder page. The URL to this page redirects elsewhere. +--- diff --git a/content/docs/languages/cpp/_index.md b/content/docs/languages/cpp/_index.md index f5a6fe7..7de5651 100644 --- a/content/docs/languages/cpp/_index.md +++ b/content/docs/languages/cpp/_index.md @@ -7,6 +7,4 @@ These language-specific pages are available: - [Quick start](quickstart) - [Basics tutorial](basics) - [Asynchronous-API tutorial](async) -- API reference: - - [gRPC C++](https://grpc.github.io/grpc/cpp) - - [gRPC core](https://grpc.github.io/grpc/core) +- [API reference](api) diff --git a/content/docs/languages/cpp/api.md b/content/docs/languages/cpp/api.md new file mode 100644 index 0000000..ea8f670 --- /dev/null +++ b/content/docs/languages/cpp/api.md @@ -0,0 +1,6 @@ +--- +title: API reference +short: API +weight: 90 +# Note: this is a placeholder page. The URL to this page redirects elsewhere. +--- diff --git a/content/docs/languages/cpp/async.md b/content/docs/languages/cpp/async.md index 5befd4f..ed7ab37 100644 --- a/content/docs/languages/cpp/async.md +++ b/content/docs/languages/cpp/async.md @@ -1,5 +1,7 @@ --- title: Asynchronous-API Tutorial +short: Async-API Tutorial +weight: 60 --- This tutorial shows you how to write a simple server and client in C++ using diff --git a/content/docs/languages/csharp/_index.md b/content/docs/languages/csharp/_index.md index b697725..36eff15 100644 --- a/content/docs/languages/csharp/_index.md +++ b/content/docs/languages/csharp/_index.md @@ -1,5 +1,6 @@ --- title: C# / .NET +api_path: api/Grpc.Core --- There are two official implementations of gRPC for C#. The original [gRPC @@ -7,7 +8,7 @@ core-library][core-library] implementation is covered here: - [Quick start](quickstart) - [Basics tutorial](basics) -- [API reference](https://grpc.github.io/grpc/csharp/api/Grpc.Core) +- [API reference](api/{{< param api_path >}}) For details concerning the newer gRPC for .NET implementation, see [gRPC for .NET](dotnet). diff --git a/content/docs/languages/csharp/api.md b/content/docs/languages/csharp/api.md new file mode 100644 index 0000000..ea8f670 --- /dev/null +++ b/content/docs/languages/csharp/api.md @@ -0,0 +1,6 @@ +--- +title: API reference +short: API +weight: 90 +# Note: this is a placeholder page. The URL to this page redirects elsewhere. +--- diff --git a/content/docs/languages/csharp/dotnet.md b/content/docs/languages/csharp/dotnet.md index ad8ffb4..993bb93 100644 --- a/content/docs/languages/csharp/dotnet.md +++ b/content/docs/languages/csharp/dotnet.md @@ -1,5 +1,6 @@ --- title: gRPC for .NET +weight: 60 --- The following pages cover the C# implementation of gRPC for .NET @@ -7,7 +8,7 @@ The following pages cover the C# implementation of gRPC for .NET - [Introduction to gRPC on .NET Core](https://docs.microsoft.com/aspnet/core/grpc) - [Tutorial: Create a gRPC client and server in ASP.NET Core][tutorial] -- [API reference](https://grpc.github.io/grpc/csharp-dotnet/api/Grpc.Core) +- [API reference](../api/grpc/csharp-dotnet/api/Grpc.Core) Several sample applications are available from the [examples][] folder in the [grpc-dotnet][] repository. diff --git a/content/docs/languages/dart/_index.md b/content/docs/languages/dart/_index.md index 58c39a2..cdab681 100644 --- a/content/docs/languages/dart/_index.md +++ b/content/docs/languages/dart/_index.md @@ -1,9 +1,10 @@ --- title: Dart +api_path: pub.dev/documentation/grpc?ext=1 --- These language-specific pages are available: - [Quick start](quickstart) - [Basics tutorial](basics) -- [API reference](https://pub.dev/documentation/grpc) +- [API reference](api/{{< param api_path >}}) diff --git a/content/docs/languages/dart/api.md b/content/docs/languages/dart/api.md new file mode 100644 index 0000000..ea8f670 --- /dev/null +++ b/content/docs/languages/dart/api.md @@ -0,0 +1,6 @@ +--- +title: API reference +short: API +weight: 90 +# Note: this is a placeholder page. The URL to this page redirects elsewhere. +--- diff --git a/content/docs/languages/go/_index.md b/content/docs/languages/go/_index.md index 7d5215d..14839fd 100644 --- a/content/docs/languages/go/_index.md +++ b/content/docs/languages/go/_index.md @@ -1,5 +1,6 @@ --- title: Go +api_path: pkg.go.dev/google.golang.org/grpc?ext=1 --- These language-specific pages are available: @@ -7,4 +8,4 @@ These language-specific pages are available: - [Quick start](quickstart) - [Basics tutorial](basics) - [Generated-code reference](generated-code) -- [API reference](https://godoc.org/google.golang.org/grpc) +- [API reference](api/{{< param api_path >}}) diff --git a/content/docs/languages/go/api.md b/content/docs/languages/go/api.md new file mode 100644 index 0000000..ea8f670 --- /dev/null +++ b/content/docs/languages/go/api.md @@ -0,0 +1,6 @@ +--- +title: API reference +short: API +weight: 90 +# Note: this is a placeholder page. The URL to this page redirects elsewhere. +--- diff --git a/content/docs/languages/go/generated-code.md b/content/docs/languages/go/generated-code.md index 48a9df3..1a5d3af 100644 --- a/content/docs/languages/go/generated-code.md +++ b/content/docs/languages/go/generated-code.md @@ -1,6 +1,7 @@ --- title: Go Generated-code Reference short: Generated Code +weight: 80 --- This page describes the code generated with the [grpc plugin](https://godoc.org/github.com/golang/protobuf/protoc-gen-go/grpc) to `protoc-gen-go` diff --git a/content/docs/languages/java/_index.md b/content/docs/languages/java/_index.md index cb3f662..ae5d7e3 100644 --- a/content/docs/languages/java/_index.md +++ b/content/docs/languages/java/_index.md @@ -1,5 +1,6 @@ --- title: Java +api_path: grpc-java/javadoc --- These language-specific pages are available: @@ -7,4 +8,4 @@ These language-specific pages are available: - [Quick start](quickstart) - [Basics tutorial](basics) - [Generated-code reference](generated-code) -- [API reference](https://grpc.github.io/grpc-java/javadoc) +- [API reference](api/{{< param api_path >}}) diff --git a/content/docs/languages/java/api.md b/content/docs/languages/java/api.md new file mode 100644 index 0000000..ea8f670 --- /dev/null +++ b/content/docs/languages/java/api.md @@ -0,0 +1,6 @@ +--- +title: API reference +short: API +weight: 90 +# Note: this is a placeholder page. The URL to this page redirects elsewhere. +--- diff --git a/content/docs/languages/java/generated-code.md b/content/docs/languages/java/generated-code.md index 78b4b64..9e1c78d 100644 --- a/content/docs/languages/java/generated-code.md +++ b/content/docs/languages/java/generated-code.md @@ -1,6 +1,7 @@ --- title: Java Generated-code Reference short: Generated Code +weight: 80 --- ## Packages diff --git a/content/docs/languages/kotlin/_index.md b/content/docs/languages/kotlin/_index.md index cebff19..be1844e 100644 --- a/content/docs/languages/kotlin/_index.md +++ b/content/docs/languages/kotlin/_index.md @@ -1,9 +1,10 @@ --- title: Kotlin/JVM +api_path: javadocs.dev/io.grpc/grpc-kotlin-stub/latest?ext=1 --- These language-specific pages are available: - [Quick start](quickstart) - [Basics tutorial](basics) -- [API reference](https://javadocs.dev/io.grpc/grpc-kotlin-stub/latest) +- [API reference](api/{{< param api_path >}}) diff --git a/content/docs/languages/kotlin/api.md b/content/docs/languages/kotlin/api.md new file mode 100644 index 0000000..ea8f670 --- /dev/null +++ b/content/docs/languages/kotlin/api.md @@ -0,0 +1,6 @@ +--- +title: API reference +short: API +weight: 90 +# Note: this is a placeholder page. The URL to this page redirects elsewhere. +--- diff --git a/content/docs/languages/node/_index.md b/content/docs/languages/node/_index.md index 65d860f..d40fd12 100644 --- a/content/docs/languages/node/_index.md +++ b/content/docs/languages/node/_index.md @@ -6,4 +6,4 @@ These language-specific pages are available: - [Quick start](quickstart) - [Basics tutorial](basics) -- [API reference](https://grpc.github.io/grpc/node) +- [API reference](api) diff --git a/content/docs/languages/node/api.md b/content/docs/languages/node/api.md new file mode 100644 index 0000000..ea8f670 --- /dev/null +++ b/content/docs/languages/node/api.md @@ -0,0 +1,6 @@ +--- +title: API reference +short: API +weight: 90 +# Note: this is a placeholder page. The URL to this page redirects elsewhere. +--- diff --git a/content/docs/languages/objective-c/_index.md b/content/docs/languages/objective-c/_index.md index 02aa784..df2c33a 100644 --- a/content/docs/languages/objective-c/_index.md +++ b/content/docs/languages/objective-c/_index.md @@ -1,5 +1,6 @@ --- title: Objective-C +api_path: grpc/objc --- These language-specific pages are available: @@ -7,4 +8,4 @@ These language-specific pages are available: - [Quick start](quickstart) - [Basics tutorial](basics) - [OAuth2 tutorial](oauth2) -- [API reference](https://grpc.github.io/grpc/objc) +- [API reference](api/{{< param api_path >}}) diff --git a/content/docs/languages/objective-c/api.md b/content/docs/languages/objective-c/api.md new file mode 100644 index 0000000..ea8f670 --- /dev/null +++ b/content/docs/languages/objective-c/api.md @@ -0,0 +1,6 @@ +--- +title: API reference +short: API +weight: 90 +# Note: this is a placeholder page. The URL to this page redirects elsewhere. +--- diff --git a/content/docs/languages/objective-c/oauth2.md b/content/docs/languages/objective-c/oauth2.md index 1b3952e..a31dc66 100644 --- a/content/docs/languages/objective-c/oauth2.md +++ b/content/docs/languages/objective-c/oauth2.md @@ -1,5 +1,6 @@ --- title: OAuth2 +weight: 60 --- This example demonstrates how to use OAuth2 on gRPC to make diff --git a/content/docs/languages/php/_index.md b/content/docs/languages/php/_index.md index 645d29f..6cea1d6 100644 --- a/content/docs/languages/php/_index.md +++ b/content/docs/languages/php/_index.md @@ -1,9 +1,10 @@ --- title: PHP +api_path: namespace-Grpc --- These language-specific pages are available: - [Quick start](quickstart) - [Basics tutorial](basics) -- [API reference](https://grpc.github.io/grpc/php/namespace-Grpc) +- [API reference](api/{{< param api_path >}}) diff --git a/content/docs/languages/php/api.md b/content/docs/languages/php/api.md new file mode 100644 index 0000000..ea8f670 --- /dev/null +++ b/content/docs/languages/php/api.md @@ -0,0 +1,6 @@ +--- +title: API reference +short: API +weight: 90 +# Note: this is a placeholder page. The URL to this page redirects elsewhere. +--- diff --git a/content/docs/languages/python/_index.md b/content/docs/languages/python/_index.md index a7f34a2..fca4b69 100644 --- a/content/docs/languages/python/_index.md +++ b/content/docs/languages/python/_index.md @@ -7,4 +7,4 @@ These language-specific pages are available: - [Quick start](quickstart) - [Basics tutorial](basics) - [Generated-code reference](generated-code) -- [API reference](https://grpc.github.io/grpc/python) +- [API reference](api) diff --git a/content/docs/languages/python/api.md b/content/docs/languages/python/api.md new file mode 100644 index 0000000..ea8f670 --- /dev/null +++ b/content/docs/languages/python/api.md @@ -0,0 +1,6 @@ +--- +title: API reference +short: API +weight: 90 +# Note: this is a placeholder page. The URL to this page redirects elsewhere. +--- diff --git a/content/docs/languages/python/generated-code.md b/content/docs/languages/python/generated-code.md index a626c55..a81b02d 100644 --- a/content/docs/languages/python/generated-code.md +++ b/content/docs/languages/python/generated-code.md @@ -1,6 +1,7 @@ --- title: Python Generated-code Reference short: Generated Code +weight: 80 --- ## Introduction diff --git a/content/docs/languages/ruby/_index.md b/content/docs/languages/ruby/_index.md index 5c136cb..ea141e8 100644 --- a/content/docs/languages/ruby/_index.md +++ b/content/docs/languages/ruby/_index.md @@ -1,9 +1,10 @@ --- title: Ruby +api_path: rubydoc.info/gems/grpc?ext=1 --- These language-specific pages are available: - [Quick start](quickstart) - [Basics tutorial](basics) -- [API reference](https://www.rubydoc.info/gems/grpc) +- [API reference](api/{{< param api_path >}}) diff --git a/content/docs/languages/ruby/api.md b/content/docs/languages/ruby/api.md new file mode 100644 index 0000000..ea8f670 --- /dev/null +++ b/content/docs/languages/ruby/api.md @@ -0,0 +1,6 @@ +--- +title: API reference +short: API +weight: 90 +# Note: this is a placeholder page. The URL to this page redirects elsewhere. +--- diff --git a/layouts/_default/_markup/render-link.html b/layouts/_default/_markup/render-link.html index a2af0fe..294a162 100644 --- a/layouts/_default/_markup/render-link.html +++ b/layouts/_default/_markup/render-link.html @@ -1,4 +1,4 @@ -{{ $isExternal := hasPrefix .Destination "http" -}} +{{ $isExternal := or (hasPrefix .Destination "http") (findRE "^(|../|/docs/languages/.+?/)api(/.*)?(\\?.*)?$" .Destination) -}} {{ range $children -}} {{ $isActive := eq $here .RelPermalink -}} + {{ $isApi := findRE "^/docs/languages/.+?/api(/.*)?(\\?.*)?$" .RelPermalink -}} + {{ $isExternal := or (hasPrefix .RelPermalink "http") $isApi -}} + {{ $href := .RelPermalink -}} + {{ if and $isApi .Parent.Params.api_path -}} + {{ $href = printf "%s%s" $href .Parent.Params.api_path -}} + {{ end -}}
  • - - {{ .Params.short | default .Title }} + + {{- .Params.short | default .Title -}} + {{ if $isExternal -}} + + {{- end -}}
    • {{ end -}}