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

Add documentation publish and preview workflows #42

Merged
merged 18 commits into from
Feb 17, 2024
Merged

Conversation

aaronsteers
Copy link
Contributor

@aaronsteers aaronsteers commented Feb 16, 2024

This PR does a bunch of things:

  1. Create new preview and publish workflows for the pdoc docs site.
    • The preview job attaches all html files to the GitHub action - which you can then download and review locally.
    • The publish job publishes the site to GitHub Pages. It runs on all commits to main and can be manually kicked off from the Actions tab as a manual workflow.
  2. Add a CONTRIBUTING.md page where I'm starting to collect all the info on how to maintain the repo.
  3. Sightly improve readme contents and replace instances of AirbyteLib with PyAirbyte.
  4. Fully remove the pattern of saving generated docs into the repo. The docs/generated path is now ignored by git.
  5. Remove viztracer dependency for now, because it was causing weird failures.

@aaronsteers
Copy link
Contributor Author

@bindipankhudi - FYI, I'm planning to go ahead and merge this but wanted to ping you so you're aware of the changes. Feel free to comment if you see anything that looks off, even if it is already merged. I'll come back and put review responses into the next iteration, as needed. Thanks!

@aaronsteers aaronsteers changed the title Add pydoc workflows Add documentation publish and preview workflows Feb 17, 2024
@bindipankhudi
Copy link
Contributor

bindipankhudi commented Feb 17, 2024 via email

@aaronsteers aaronsteers merged commit 633e1b4 into main Feb 17, 2024
5 checks passed
@aaronsteers aaronsteers deleted the pydoc-content branch February 17, 2024 01:47
@aaronsteers aaronsteers self-assigned this Mar 11, 2024
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