Commit 3824ed9
authored
docs: docgen proto with
fixes #555
utilizes https://github.com/pseudomuto/protoc-gen-doc
to generate the needed docs ready to upload to the homepage.
> [!NOTE]
> did not setup a proper template, yet. used the default one for now, so
we can track template-related changes in future PRs
> But the template has been foreseen, it is expected to go into the
folder `docgen/proto/template`.
> See template docs here:
<https://github.com/pseudomuto/protoc-gen-doc/wiki/Custom-Templates>
CI run:
https://github.com/CycloneDX/specification/actions/runs/12536710058/job/34960006706
CI result:
https://github.com/CycloneDX/specification/actions/runs/12536710058/artifacts/2369477602
structure:
```text
docgen/proto/docs
├── 1.3
│ └── index.html
├── 1.4
│ └── index.html
├── 1.5
│ └── index.html
└── 1.6
└── index.html
```
----
might rework the resutling structure in regards to
#568
---------
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>protoc-gen-doc (#557)1 parent 1f42698 commit 3824ed9
File tree
4 files changed
+503
-0
lines changed- .github/workflows
- docgen/proto
- templates
4 files changed
+503
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
59 | 59 | | |
60 | 60 | | |
61 | 61 | | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
0 commit comments