Skip to content

Re-setup docs generation from code #202

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

Merged
merged 5 commits into from
Dec 14, 2024
Merged

Re-setup docs generation from code #202

merged 5 commits into from
Dec 14, 2024

Conversation

milindl
Copy link
Contributor

@milindl milindl commented Dec 10, 2024

This got way too big for my liking but jsdoc needed many, many things to work. There is no (reasonable) way to make the import() statement work so errors relating to that are just filtered out.

It's split into 3 commits

  1. Makefile and config setup.
  2. Changes to code files to make jsdoc run without error. This is the biggest part but it should be okay because it's mostly just restructuring the comments. There are very minor code changes to facilitate some documentation (Object.freeze moved later, etc).
  3. Add docs pipeline to semaphore so no future code changes break it.

@milindl milindl requested review from a team as code owners December 10, 2024 07:14
@confluent-cla-assistant
Copy link

🎉 All Contributor License Agreements have been signed. Ready to merge.
Please push an empty commit if you would like to re-run the checks to verify CLA status for all contributors.

Copy link
Contributor

@emasab emasab left a comment

Choose a reason for hiding this comment

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

LGTM for documentation generation, pending review of the docstrings

@milindl milindl requested a review from emasab December 14, 2024 15:13
@milindl milindl merged commit 2471567 into master Dec 14, 2024
2 checks passed
@milindl milindl deleted the dev_docs branch December 14, 2024 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants