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

chore(docs): purge sphinx documentation and related dependencies #129

Merged
merged 4 commits into from
Dec 5, 2024

Conversation

arr-ee
Copy link
Contributor

@arr-ee arr-ee commented Dec 5, 2024

Fixes #123.

Please note that poetry.lock includes changes from #126 since I can't preserve its being out of sync.

I assume that whatever job was publishing these docs only existed in the previous incarnation of this repo since I can't find any traces of it in git log, so there might be more cleanup needed to remove previously published docs.

Summary by CodeRabbit

  • Chores
    • Removed the sphinx-docs extra dependency from the project configuration.
    • Deleted various documentation files related to the Airbyte CDK, including API references and configuration files for documentation generation.
    • Improved formatting and readability of the project configuration file.

These changes enhance the overall organization and clarity of the project documentation, although some documentation resources have been removed.

Copy link
Contributor

coderabbitai bot commented Dec 5, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

This pull request involves the removal of Sphinx-related documentation and dependencies from the project. Key changes include the deletion of the reference_docs directory, which contained various documentation files, and the removal of the sphinx-docs.md file. Additionally, the pyproject.toml file has been modified to remove the sphinx-docs extra dependency and to improve the formatting of existing entries for clarity and consistency.

Changes

File Path Change Summary
pyproject.toml Removed sphinx-docs from poetry_extras, reformatted dependencies and tasks for consistency.
reference_docs/Makefile File deleted.
reference_docs/_source/api/*.rst Multiple API documentation files deleted.
reference_docs/_source/conf.py Configuration file deleted.
reference_docs/_source/index.rst Introductory documentation file deleted.
reference_docs/_source/templates/*.rst_t Template files deleted.
generate_rst_schema.py Documentation generation script deleted.
sphinx-docs.md Comprehensive Sphinx documentation file deleted.
reference_docs/_source/api/modules.rst File deleted.

Assessment against linked issues

Objective Addressed Explanation
Clean out sphinx-related docs generation (#123)
Delete sphinx-related dependencies (#123)
Delete sphinx-docs.md (#123)
Delete reference_docs directory (#123)
General loose ends cleanup (#123)

Possibly related PRs

Suggested labels

dependencies, chore


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 622aff5 and 8f17ba1.

⛔ Files ignored due to path filters (2)
  • poetry.lock is excluded by !**/*.lock
  • reference_docs/_static/img/airbyte_new_logo.svg is excluded by !**/*.svg
📒 Files selected for processing (42)
  • pyproject.toml (1 hunks)
  • reference_docs/Makefile (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.destinations.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.models.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.auth.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.checks.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.datetime.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.decoders.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.extractors.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.interpolation.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.parsers.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.error_handlers.backoff_strategies.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.error_handlers.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.paginators.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.paginators.strategies.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.request_headers.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.request_options.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.retriers.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.retrievers.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.schema.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.states.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.stream_slicers.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.transformations.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.deprecated.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.singer.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.streams.http.auth.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.streams.http.requests_native_auth.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.streams.http.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.streams.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.sources.utils.rst (0 hunks)
  • reference_docs/_source/api/airbyte_cdk.utils.rst (0 hunks)
  • reference_docs/_source/api/modules.rst (0 hunks)
  • reference_docs/_source/conf.py (0 hunks)
  • reference_docs/_source/index.rst (0 hunks)
  • reference_docs/_source/templates/master_doc.rst_t (0 hunks)
  • reference_docs/_source/templates/package.rst_t (0 hunks)
  • reference_docs/generate_rst_schema.py (0 hunks)
  • sphinx-docs.md (0 hunks)
💤 Files with no reviewable changes (41)
  • reference_docs/_source/templates/master_doc.rst_t
  • reference_docs/_source/api/airbyte_cdk.models.rst
  • reference_docs/_source/index.rst
  • reference_docs/_source/api/modules.rst
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.paginators.strategies.rst
  • reference_docs/_source/api/airbyte_cdk.sources.streams.http.auth.rst
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.decoders.rst
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.rst
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.datetime.rst
  • reference_docs/_source/api/airbyte_cdk.sources.streams.rst
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.paginators.rst
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.states.rst
  • reference_docs/_source/api/airbyte_cdk.destinations.rst
  • reference_docs/_source/conf.py
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.schema.rst
  • reference_docs/_source/api/airbyte_cdk.sources.singer.rst
  • reference_docs/_source/api/airbyte_cdk.sources.streams.http.rst
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.request_options.rst
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.auth.rst
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.retriers.rst
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.checks.rst
  • sphinx-docs.md
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.transformations.rst
  • reference_docs/_source/api/airbyte_cdk.utils.rst
  • reference_docs/generate_rst_schema.py
  • reference_docs/_source/api/airbyte_cdk.sources.rst
  • reference_docs/_source/api/airbyte_cdk.sources.deprecated.rst
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.parsers.rst
  • reference_docs/Makefile
  • reference_docs/_source/api/airbyte_cdk.rst
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.error_handlers.rst
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.extractors.rst
  • reference_docs/_source/api/airbyte_cdk.sources.utils.rst
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.retrievers.rst
  • reference_docs/_source/api/airbyte_cdk.sources.streams.http.requests_native_auth.rst
  • reference_docs/_source/templates/package.rst_t
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.error_handlers.backoff_strategies.rst
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.stream_slicers.rst
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.interpolation.rst
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.request_headers.rst
  • reference_docs/_source/api/airbyte_cdk.sources.declarative.rst
🚧 Files skipped from review as they are similar to previous changes (1)
  • pyproject.toml

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@natikgadzhi
Copy link
Contributor

I've nuked the corresponding readthedocs site. They didn't have options to setup a proper redirect, and we didn't have any traffic there. Good riddance.

@natikgadzhi
Copy link
Contributor

/cc @marcosmarxm, can you take a look at our core docs site and list out a few guides where we link to our CDK, so we can point it to the new docs?

@aaronsteers
Copy link
Contributor

aaronsteers commented Dec 5, 2024

/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.

Resolving dependencies... changes
@aaronsteers aaronsteers enabled auto-merge (squash) December 5, 2024 22:53
Copy link
Contributor

@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.

NICE! :shipit:

@aaronsteers aaronsteers merged commit 89defe1 into airbytehq:main Dec 5, 2024
14 of 15 checks passed
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.

Clean out sphinx-related deps and old reference docs.
3 participants