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.

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

docs: docgen proto with protoc-gen-doc #557

Merged
merged 4 commits into from
Jan 11, 2025
Merged

Conversation

jkowalleck
Copy link
Member

@jkowalleck jkowalleck commented Dec 29, 2024

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:

docgen/proto/docs
├── 1.3/proto
│   └── index.html
├── 1.4/proto
│   └── index.html
├── 1.5/proto
│   └── index.html
└── 1.6/proto
    └── index.html

might rework the resutling structure in regards to #568

Copy link
Contributor

@andreas-hilti andreas-hilti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @jkowalleck! Looks good to me.

Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
@jkowalleck jkowalleck merged commit 3824ed9 into master Jan 11, 2025
12 checks passed
@jkowalleck jkowalleck deleted the docs/docgen-proto branch January 11, 2025 14:07
jkowalleck added a commit that referenced this pull request Jan 11, 2025
theme for #557

---------

Signed-off-by: Jan Kowalleck <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE]: Generate a browsable documentation for the protobuf specification
2 participants