api-docs: add overwrites for external packages

This commit is contained in:
Hidde Beydals 2020-09-15 15:19:53 +02:00
parent e46add39ed
commit 118dcbb9d8
2 changed files with 12 additions and 3 deletions

View File

@ -72,7 +72,9 @@ KustomizationSpec
<td>
<code>dependsOn</code><br>
<em>
[]github.com/fluxcd/pkg/runtime/dependency.CrossNamespaceDependencyReference
<a href="https://godoc.org/github.com/fluxcd/pkg/runtime/dependency#CrossNamespaceDependencyReference">
[]Runtime dependency.CrossNamespaceDependencyReference
</a>
</em>
</td>
<td>
@ -519,7 +521,9 @@ Kubernetes core/v1.LocalObjectReference
<td>
<code>dependsOn</code><br>
<em>
[]github.com/fluxcd/pkg/runtime/dependency.CrossNamespaceDependencyReference
<a href="https://godoc.org/github.com/fluxcd/pkg/runtime/dependency#CrossNamespaceDependencyReference">
[]Runtime dependency.CrossNamespaceDependencyReference
</a>
</em>
</td>
<td>

View File

@ -14,11 +14,16 @@
{
"typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/",
"docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}"
},
{
"typeMatchPrefix": "^github.com/fluxcd/pkg/runtime/dependency\\.CrossNamespaceDependencyReference$",
"docsURLTemplate": "https://godoc.org/github.com/fluxcd/pkg/runtime/dependency#CrossNamespaceDependencyReference"
}
],
"typeDisplayNamePrefixOverrides": {
"k8s.io/api/": "Kubernetes ",
"k8s.io/apimachinery/pkg/apis/": "Kubernetes "
"k8s.io/apimachinery/pkg/apis/": "Kubernetes ",
"github.com/fluxcd/pkg/runtime/": "Runtime "
},
"markdownDisabled": false
}