forked from kubernetes-sigs/kubebuilder
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request kubernetes-sigs#15 from pwittrock/master
Add docs for generating docs
- Loading branch information
Showing
3 changed files
with
44 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Building reference documentation | ||
|
||
## Build reference documentation | ||
|
||
You may build Kubernetes style reference documentation for your APIs to `docs/reference/build/index.html` by | ||
running `kubebuilder docs`. | ||
|
||
**Note:** There is currently an issue where building docs does not work if multiple versions of APIs for the | ||
same group are defined. | ||
|
||
## Create an example for your API | ||
|
||
You may create an example that will be included in the reference documentation by running the following command | ||
and editing the newly created file: | ||
|
||
```sh | ||
kubebuilder create example --group <group> --version <version> --kind <kind> | ||
``` | ||
|
||
## Add overview or API group documentation | ||
|
||
You may add information about the API groups or creating an overview by editing the .md files | ||
under `docs/reference/static_includes`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters