Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add API document and its generating util #1929

Merged
merged 11 commits into from
Mar 16, 2020
Merged

Add API document and its generating util #1929

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
222a107
add api ref util
Mar 15, 2020
0247c08
update util
Mar 15, 2020
1d4bd93
revise template
Mar 15, 2020
62ec919
revise api doc util
Mar 16, 2020
fda1447
Update hack/update-crd-groups.sh
Yisaer Mar 16, 2020
93a189a
Update hack/lib.sh
Yisaer Mar 16, 2020
07a14c7
fix by comment
Mar 16, 2020
d3bf14c
Merge branch 'api_reference_tool' of https://github.com/Yisaer/tidb-o…
Mar 16, 2020
a56bcf9
Merge branch 'master' into api_reference_tool
Yisaer Mar 16, 2020
8a08922
fix error script
Mar 16, 2020
4214999
Merge branch 'api_reference_tool' of https://github.com/Yisaer/tidb-o…
Mar 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
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
View file
Open in desktop
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