Skip to content

Commit

Permalink
Add API document and its generating util (pingcap#1929)
Browse files Browse the repository at this point in the history
  • Loading branch information
Yisaer authored and Song Gao committed Mar 16, 2020
1 parent ab3424d commit 86bdd93
Show file tree
Hide file tree
Showing 9 changed files with 12,665 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,5 @@ kubeconfig
/output/
# kubetest2 default artifacts directory
/_artifacts/

.DS_Store
29 changes: 29 additions & 0 deletions docs/api-references/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"hideMemberFields": [
"TypeMeta"
],
"hideTypePatterns": [
"ParseError$",
"List$",
"DataResource"
],
"externalPackages": [
{
"typeMatchPrefix": "^k8s\\.io/apimachinery/pkg/apis/meta/v1\\.Duration$",
"docsURLTemplate": "https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"
},
{
"typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/",
"docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.13/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}"
},
{
"typeMatchPrefix": "^github\\.com/knative/pkg/apis/duck/",
"docsURLTemplate": "https://godoc.org/github.com/knative/pkg/apis/duck/{{arrIndex .PackageSegments -1}}#{{.TypeIdentifier}}"
}
],
"typeDisplayNamePrefixOverrides": {
"k8s.io/api/": "Kubernetes ",
"k8s.io/apimachinery/pkg/apis/": "Kubernetes "
},
"markdownDisabled": false
}
Loading

0 comments on commit 86bdd93

Please sign in to comment.