Skip to content

Commit

Permalink
Publish API docs only as a md file (#521)
Browse files Browse the repository at this point in the history
* Publish API docs only as a md file

Signed-off-by: Pavol Loffay <p.loffay@gmail.com>

* Fix

Signed-off-by: Pavol Loffay <p.loffay@gmail.com>

---------

Signed-off-by: Pavol Loffay <p.loffay@gmail.com>
  • Loading branch information
pavolloffay authored Jul 25, 2023
1 parent 32246d6 commit 1e7414d
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 90 deletions.
4 changes: 0 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -450,10 +450,6 @@ api-docs: docs/operator/api.md docs/operator/feature-gates.md
TYPES_TARGET := $(shell find apis/tempo -type f -iname "*_types.go")
docs/operator/api.md: $(TYPES_TARGET) gen-crd-api-reference-docs
$(GEN_CRD) -api-dir "github.com/grafana/tempo-operator/apis/tempo/" -config "$(PWD)/config/docs/config.json" -template-dir "$(PWD)/config/docs/templates" -out-file "$(PWD)/$@"
sed -i 's/+docs:/ docs:/' $@
sed -i 's/+parent:/ parent:/' $@
sed -i 's/##/\n##/' $@
sed -i 's/+newline/\n/' $@


FEATURE_GATES_TARGET := $(shell find apis/config -type f -iname "*_types.go")
Expand Down
12 changes: 0 additions & 12 deletions config/docs/templates/pkg.tpl
Original file line number Diff line number Diff line change
@@ -1,16 +1,4 @@
{{ define "packages" }}
---
title: "API"
description: "Generated API docs for the Tempo Operator"
lead: ""
draft: false
images: []
menu:
+docs:
+parent: "operator"
weight: 1000
toc: true
---

This Document contains the types introduced by the Tempo Operator to be consumed by users.

Expand Down
Loading

0 comments on commit 1e7414d

Please sign in to comment.