Build godoc as part of odo.dev (#5184)

* Add badge linking to pkg.go.dev

* Build godoc as part of odo.dev

* Fix badge
This commit is contained in:
Philippe Martin
2021-10-28 07:34:23 +02:00
committed by GitHub
parent 0512d3a2cf
commit 3a36c28a14
3 changed files with 14 additions and 1 deletions

View File

@@ -6,6 +6,7 @@
https://github.com/openshift/odo/releases/latest[image:https://img.shields.io/github/v/release/openshift/odo?style=for-the-badge[GitHub release]]
image:https://img.shields.io/github/license/openshift/odo?style=for-the-badge[License]
https://odo.dev/godoc[image:https://img.shields.io/badge/godoc-reference-007d9c?logo=go&logoColor=white&style=for-the-badge[]]
https://app.netlify.com/sites/odo-docusaurus-preview/deploys[image:https://api.netlify.com/api/v1/badges/e07867b0-56a4-4905-92a9-a152ceab5f0d/deploy-status[![Netlify Status]]

12
docs/website/build_godoc.sh Executable file
View File

@@ -0,0 +1,12 @@
#!/bin/bash
cd ../..
go install golang.org/x/tools/cmd/godoc@latest
go install gitlab.com/tslocum/godoc-static@latest
export GOPATH=$(go env GOPATH)
PATH=$PATH:${GOPATH}/bin
mkdir -p docs/website/build/godoc
godoc-static -destination docs/website/build/godoc .

View File

@@ -5,7 +5,7 @@
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"build": "docusaurus build",
"build": "docusaurus build && ./build_godoc.sh",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",