-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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
airbyte-lib: Generate docs #33997
airbyte-lib: Generate docs #33997
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Ignored Deployment
|
airbyte-lib/.gitattributes
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love these git hints for hiding specific diffs! 🙏
Docs need to be generated via `poetry run generate-docs` and checked in to the repo. | ||
|
||
This test runs the docs generation and compares the output with the checked in docs. | ||
It will fail if there are any differences. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice. 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Any other action items to call out?
I noticed Vercel both appears to skip this PR as not relevant. Not sure if we should (eventually) have integration with Vercel - or else have another way to preview airbyte-lib docs. Wdyt?
This is configurable on the vercel side - after we actually merge the PR that's integrating the airbyte-lib docs in our doc system, I will adjust this config to also re-build if those generated docs change. Does that sound good? Alternatively we could create that integration now with a hidden page in our docs, but I would like to keep it clean if possible, to not accidentally render the wrong things |
…byte into flash1293/airbyte-lib-docs
This PR generates documentation for the public interface of airbyte-lib. It will be integrated into our documentation system in a separate PR.