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

airbyte-lib: Generate docs #33997

Merged
merged 7 commits into from
Jan 9, 2024
Merged

airbyte-lib: Generate docs #33997

merged 7 commits into from
Jan 9, 2024

Conversation

flash1293
Copy link
Contributor

This PR generates documentation for the public interface of airbyte-lib. It will be integrated into our documentation system in a separate PR.

  • Use a python script using pdoc to generate the documentation (without any chrome so it can easily be embedded)
  • Add a unit test that checks whether re-running the doc generation will generate a git diff (to enforce committing docs changes)

Copy link

vercel bot commented Jan 8, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
airbyte-docs ⬜️ Ignored (Inspect) Visit Preview Jan 9, 2024 1:02pm

Copy link
Collaborator

@aaronsteers aaronsteers Jan 9, 2024

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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice. 👍

Copy link
Collaborator

@aaronsteers aaronsteers left a 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?

@flash1293 flash1293 changed the title air-lib: Generate docs airbyte-lib: Generate docs Jan 9, 2024
@flash1293
Copy link
Contributor Author

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

@flash1293 flash1293 merged commit b4ddfb8 into master Jan 9, 2024
19 checks passed
@flash1293 flash1293 deleted the flash1293/airbyte-lib-docs branch January 9, 2024 14:29
jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 26, 2024
jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 26, 2024
jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants