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.

Sign up for GitHub

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

Jump to bottom

docs: Migrate pdoc to mkdocs #277

Closed
wants to merge 12 commits into from
Closed

docs: Migrate pdoc to mkdocs #277

wants to merge 12 commits into from

Conversation

devin-ai-integration[bot]
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Jan 28, 2025 •
edited
Loading

Migrates documentation from pdoc to MkDocs with mkdocstrings for improved navigation and maintainability.

Key changes:

  • Replace pdoc with MkDocs and mkdocstrings
  • Add automatic API reference documentation
  • Update documentation generation scripts
  • Add GitHub Actions for docs preview and publishing

Link to Devin run: https://app.devin.ai/sessions/a9df87cc2bba4eb5a73d3bd941dcefd8

devin-ai-integration bot and others added 6 commits January 28, 2025 06:34
@devin-ai-integration @aaronsteers
docs: remove pdoc references and prepare for mkdocs migration
25ce55e 
Co-Authored-By: Aaron <AJ> Steers <aj@airbyte.io>
@devin-ai-integration @aaronsteers
deps: add mkdocs and related plugins
7be7a17 
Co-Authored-By: Aaron <AJ> Steers <aj@airbyte.io>
@devin-ai-integration @aaronsteers
docs: add mkdocs configuration and update generate script
bd4f8b2 
Co-Authored-By: Aaron <AJ> Steers <aj@airbyte.io>
@devin-ai-integration @aaronsteers
docs: add mkdocs documentation structure and content
b169534 
Co-Authored-By: Aaron <AJ> Steers <aj@airbyte.io>
@devin-ai-integration @aaronsteers
feat: migrate documentation from pdoc to mkdocs
2e088b8 
- Replace pdoc with MkDocs and mkdocstrings
- Update documentation generation script
- Integrate with main Airbyte docs
- Update contributing guide and README
- Add API reference documentation structure

This change improves the documentation system by:
1. Using MkDocs for better navigation and search
2. Integrating with the main Airbyte documentation
3. Providing a clearer separation between API docs and user guide
4. Adding better source code views and type information

Co-Authored-By: Aaron <AJ> Steers <aj@airbyte.io>
@devin-ai-integration @aaronsteers
style: format generate.py
3e632da 
Co-Authored-By: Aaron <AJ> Steers <aj@airbyte.io>
@devin-ai-integration Devin.ai Integration
Copy link
Contributor Author

Original prompt:

@Devin let's try a migration from pdoc to mkdocs in the CDK repo. Lmk before you start about any tradeoffs or necessary changes.

@devin-ai-integration Devin.ai Integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add "(aside)" to your comment to have me ignore it.
  • Look at CI failures and help fix them

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@aaronsteers
Copy link
Contributor

aaronsteers commented Jan 28, 2025 •
edited by github-actions bot
Loading

/poetry-lock

Poetry-Lock Job Info

This job attempts to re-lock dependencies using poetry lock command. If any changes
are made, those changes will be automatically committed and pushed back to the PR.

Note: This job can only be run by maintainers. On PRs from forks, this command requires
that the PR author has enabled the Allow edits from maintainers option.

poetry lock job started... Check job output.

❌ Job failed.

@github-actions github-actions bot added the docs label Jan 28, 2025
@aaronsteers
Copy link
Contributor

aaronsteers commented Jan 28, 2025 •
edited by github-actions bot
Loading

/poetry-lock

Poetry-Lock Job Info

This job attempts to re-lock dependencies using poetry lock command. If any changes
are made, those changes will be automatically committed and pushed back to the PR.

Note: This job can only be run by maintainers. On PRs from forks, this command requires
that the PR author has enabled the Allow edits from maintainers option.

poetry lock job started... Check job output.

✅ poetry lock applied successfully.

octavia-squidington-iii and others added 3 commits January 28, 2025 18:21
@aaronsteers aaronsteers deleted the devin/1738046549-migrate-to-mkdocs branch January 29, 2025 03:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aaronsteers aaronsteers Awaiting requested review from aaronsteers

@ian-at-airbyte ian-at-airbyte Awaiting requested review from ian-at-airbyte

Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@aaronsteers