Skip to content

docs: Add more public classes and functions to the reference docs#3409

Open
edgarrmondragon wants to merge 6 commits intomainfrom
docs/more-reference-docs
Open

docs: Add more public classes and functions to the reference docs#3409
edgarrmondragon wants to merge 6 commits intomainfrom
docs/more-reference-docs

Conversation

@edgarrmondragon
Copy link
Collaborator

@edgarrmondragon edgarrmondragon commented Dec 11, 2025

Related

Summary by Sourcery

Expand and reorganize the public API reference documentation for singer_sdk.

Documentation:

  • Add reference pages for additional public classes, exceptions, helpers, metrics, schema sources, Singer library objects, and testing utilities in singer_sdk.
  • Introduce documentation redirects for re-exported schema and testing classes and for the deprecated JSONLines batch encoder path to maintain link compatibility.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 11, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Expands the Sphinx reference documentation to cover many additional public SDK classes and functions, and adds redirects to keep existing reference URLs working after reorganizing schema source and testing docs and moving the JSONLines batcher to contrib.

File-Level Changes

Change Details Files
Extend Sphinx API reference coverage to many additional public SDK classes, helpers, metrics, schema utilities, Singer protocol objects, and testing utilities.
  • Create new per-class .rst reference stubs under docs/classes for about formatters, batchers, filesystem contrib streams and taps, exception types, capability helpers, JSONPath helper, metrics objects, schema source types, Singer catalog and schema utilities, Singer message types and helpers, and extensive testing components (configs, factories, runners, suites, templates, and individual tap/target tests).
  • Ensure these new docs follow the existing naming/layout convention (one .rst per public symbol under docs/classes/singer_sdk.*).
docs/classes/singer_sdk.about.AboutFormatter.rst
docs/classes/singer_sdk.about.AboutInfo.rst
docs/classes/singer_sdk.about.JSONFormatter.rst
docs/classes/singer_sdk.about.MarkdownFormatter.rst
docs/classes/singer_sdk.batch.Batcher.rst
docs/classes/singer_sdk.contrib.batch_encoder_jsonl.JSONLinesBatcher.rst
docs/classes/singer_sdk.contrib.batch_encoder_parquet.ParquetBatcher.rst
docs/classes/singer_sdk.contrib.filesystem.stream.FileStream.rst
docs/classes/singer_sdk.contrib.filesystem.tap.FolderTap.rst
docs/classes/singer_sdk.exceptions.AbortedSyncExceptionBase.rst
docs/classes/singer_sdk.exceptions.AbortedSyncFailedException.rst
docs/classes/singer_sdk.exceptions.AbortedSyncPausedException.rst
docs/classes/singer_sdk.exceptions.ConformedNameClashException.rst
docs/classes/singer_sdk.exceptions.DiscoveryError.rst
docs/classes/singer_sdk.exceptions.InvalidJSONSchema.rst
docs/classes/singer_sdk.exceptions.InvalidRecord.rst
docs/classes/singer_sdk.exceptions.InvalidReplicationKeyException.rst
docs/classes/singer_sdk.exceptions.MissingKeyPropertiesError.rst
docs/classes/singer_sdk.exceptions.RequestedAbortException.rst
docs/classes/singer_sdk.helpers.capabilities.CapabilitiesEnum.rst
docs/classes/singer_sdk.helpers.capabilities.PluginCapabilities.rst
docs/classes/singer_sdk.helpers.capabilities.TapCapabilities.rst
docs/classes/singer_sdk.helpers.capabilities.TargetCapabilities.rst
docs/classes/singer_sdk.helpers.capabilities.TargetLoadMethods.rst
docs/classes/singer_sdk.helpers.jsonpath.extract_jsonpath.rst
docs/classes/singer_sdk.metrics.Metric.rst
docs/classes/singer_sdk.metrics.Point.rst
docs/classes/singer_sdk.metrics.Status.rst
docs/classes/singer_sdk.metrics.Tag.rst
docs/classes/singer_sdk.schema.source.OpenAPISchema.rst
docs/classes/singer_sdk.schema.source.SchemaDirectory.rst
docs/classes/singer_sdk.schema.source.SchemaSource.rst
docs/classes/singer_sdk.schema.source.StreamSchema.rst
docs/classes/singer_sdk.singerlib.catalog.Catalog.rst
docs/classes/singer_sdk.singerlib.catalog.CatalogEntry.rst
docs/classes/singer_sdk.singerlib.catalog.Metadata.rst
docs/classes/singer_sdk.singerlib.catalog.MetadataMapping.rst
docs/classes/singer_sdk.singerlib.catalog.SelectionMask.rst
docs/classes/singer_sdk.singerlib.catalog.StreamMetadata.rst
docs/classes/singer_sdk.singerlib.messages.ActivateVersionMessage.rst
docs/classes/singer_sdk.singerlib.messages.Message.rst
docs/classes/singer_sdk.singerlib.messages.RecordMessage.rst
docs/classes/singer_sdk.singerlib.messages.SchemaMessage.rst
docs/classes/singer_sdk.singerlib.messages.SingerMessageType.rst
docs/classes/singer_sdk.singerlib.messages.StateMessage.rst
docs/classes/singer_sdk.singerlib.messages.exclude_null_dict.rst
docs/classes/singer_sdk.singerlib.messages.format_message.rst
docs/classes/singer_sdk.singerlib.messages.write_message.rst
docs/classes/singer_sdk.singerlib.schema.Schema.rst
docs/classes/singer_sdk.singerlib.schema.resolve_schema_references.rst
docs/classes/singer_sdk.testing.config.SuiteConfig.rst
docs/classes/singer_sdk.testing.factory.get_tap_test_class.rst
docs/classes/singer_sdk.testing.factory.get_target_test_class.rst
docs/classes/singer_sdk.testing.runners.SingerTestRunner.rst
docs/classes/singer_sdk.testing.runners.TapTestRunner.rst
docs/classes/singer_sdk.testing.runners.TargetTestRunner.rst
docs/classes/singer_sdk.testing.suites.SingerTestSuite.rst
docs/classes/singer_sdk.testing.tap_tests.AttributeIsBooleanTest.rst
docs/classes/singer_sdk.testing.tap_tests.AttributeIsDateTimeTest.rst
docs/classes/singer_sdk.testing.tap_tests.AttributeIsIntegerTest.rst
docs/classes/singer_sdk.testing.tap_tests.AttributeIsNumberTest.rst
docs/classes/singer_sdk.testing.tap_tests.AttributeIsObjectTest.rst
docs/classes/singer_sdk.testing.tap_tests.AttributeNotNullTest.rst
docs/classes/singer_sdk.testing.tap_tests.StreamCatalogSchemaMatchesRecordTest.rst
docs/classes/singer_sdk.testing.tap_tests.StreamPrimaryKeysTest.rst
docs/classes/singer_sdk.testing.tap_tests.StreamRecordMatchesStreamSchema.rst
docs/classes/singer_sdk.testing.tap_tests.StreamRecordSchemaMatchesCatalogTest.rst
docs/classes/singer_sdk.testing.tap_tests.StreamReturnsRecordTest.rst
docs/classes/singer_sdk.testing.tap_tests.StreamSchemaIsValidTest.rst
docs/classes/singer_sdk.testing.tap_tests.TapCLIPrintsTest.rst
docs/classes/singer_sdk.testing.tap_tests.TapDiscoveryTest.rst
docs/classes/singer_sdk.testing.tap_tests.TapStreamConnectionTest.rst
docs/classes/singer_sdk.testing.tap_tests.TapValidFinalStateTest.rst
docs/classes/singer_sdk.testing.target_tests.TargetArrayData.rst
docs/classes/singer_sdk.testing.target_tests.TargetCamelcaseComplexSchema.rst
docs/classes/singer_sdk.testing.target_tests.TargetCamelcaseTest.rst
docs/classes/singer_sdk.testing.target_tests.TargetCliPrintsTest.rst
docs/classes/singer_sdk.testing.target_tests.TargetDuplicateRecords.rst
docs/classes/singer_sdk.testing.target_tests.TargetEncodedStringData.rst
docs/classes/singer_sdk.testing.target_tests.TargetInvalidSchemaTest.rst
docs/classes/singer_sdk.testing.target_tests.TargetMultipleStateMessages.rst
docs/classes/singer_sdk.testing.target_tests.TargetNoPrimaryKeys.rst
docs/classes/singer_sdk.testing.target_tests.TargetOptionalAttributes.rst
docs/classes/singer_sdk.testing.target_tests.TargetPrimaryKeyUpdates.rst
docs/classes/singer_sdk.testing.target_tests.TargetRecordBeforeSchemaTest.rst
docs/classes/singer_sdk.testing.target_tests.TargetRecordMissingKeyProperty.rst
docs/classes/singer_sdk.testing.target_tests.TargetRecordMissingOptionalFields.rst
docs/classes/singer_sdk.testing.target_tests.TargetSchemaNoProperties.rst
docs/classes/singer_sdk.testing.target_tests.TargetSchemaUpdates.rst
docs/classes/singer_sdk.testing.target_tests.TargetSpecialCharsInAttributes.rst
docs/classes/singer_sdk.testing.templates.AttributeTestTemplate.rst
docs/classes/singer_sdk.testing.templates.StreamTestTemplate.rst
docs/classes/singer_sdk.testing.templates.TapTestTemplate.rst
docs/classes/singer_sdk.testing.templates.TargetTestTemplate.rst
Update Sphinx redirects to preserve old documentation URLs after reorganizing schema source and testing docs and moving JSONLinesBatcher into contrib.
  • Add redirects for schema source classes re-exported from the top-level singer_sdk package to their canonical singer_sdk.schema.source.* docs.
  • Add a redirect for the deprecated JSONLinesBatcher from the old singer_sdk.batch path to the new singer_sdk.contrib.batch_encoder_jsonl path.
  • Add a redirect for SuiteConfig from the re-exported singer_sdk.testing namespace to its concrete singer_sdk.testing.config module path.
docs/conf.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@read-the-docs-community
Copy link

read-the-docs-community bot commented Dec 11, 2025

Documentation build overview

📚 Meltano SDK | 🛠️ Build #31068007 | 📁 Comparing 6a9e5c6 against latest (b8b305c)


🔍 Preview build

Show files changed (125 files in total): 📝 25 modified | ➕ 100 added | ➖ 0 deleted
File Status
capabilities.html 📝 modified
genindex.html 📝 modified
reference.html 📝 modified
testing.html 📝 modified
typing.html 📝 modified
classes/singer_sdk.BatchSink.html 📝 modified
classes/singer_sdk.GraphQLStream.html 📝 modified
classes/singer_sdk.InlineMapper.html 📝 modified
classes/singer_sdk.OpenAPISchema.html ➕ added
classes/singer_sdk.RESTStream.html 📝 modified
classes/singer_sdk.RecordSink.html 📝 modified
classes/singer_sdk.SchemaDirectory.html ➕ added
classes/singer_sdk.SchemaSource.html ➕ added
classes/singer_sdk.Sink.html 📝 modified
classes/singer_sdk.Stream.html 📝 modified
classes/singer_sdk.StreamSchema.html ➕ added
classes/singer_sdk.Tap.html 📝 modified
classes/singer_sdk.Target.html 📝 modified
classes/singer_sdk.about.AboutFormatter.html ➕ added
classes/singer_sdk.about.AboutInfo.html ➕ added
classes/singer_sdk.about.JSONFormatter.html ➕ added
classes/singer_sdk.about.MarkdownFormatter.html ➕ added
classes/singer_sdk.batch.Batcher.html ➕ added
classes/singer_sdk.batch.JSONLinesBatcher.html 📝 modified
classes/singer_sdk.contrib.batch_encoder_jsonl.JSONLinesBatcher.html ➕ added
classes/singer_sdk.contrib.batch_encoder_parquet.ParquetBatcher.html ➕ added
classes/singer_sdk.contrib.filesystem.stream.FileStream.html ➕ added
classes/singer_sdk.contrib.filesystem.tap.FolderTap.html ➕ added
classes/singer_sdk.exceptions.AbortedSyncExceptionBase.html ➕ added
classes/singer_sdk.exceptions.AbortedSyncFailedException.html ➕ added
classes/singer_sdk.exceptions.AbortedSyncPausedException.html ➕ added
classes/singer_sdk.exceptions.ConformedNameClashException.html ➕ added
classes/singer_sdk.exceptions.DiscoveryError.html ➕ added
classes/singer_sdk.exceptions.InvalidJSONSchema.html ➕ added
classes/singer_sdk.exceptions.InvalidRecord.html ➕ added
classes/singer_sdk.exceptions.InvalidReplicationKeyException.html ➕ added
classes/singer_sdk.exceptions.MissingKeyPropertiesError.html ➕ added
classes/singer_sdk.exceptions.RequestedAbortException.html ➕ added
classes/singer_sdk.helpers.capabilities.CapabilitiesEnum.html ➕ added
classes/singer_sdk.helpers.capabilities.PluginCapabilities.html ➕ added
classes/singer_sdk.helpers.capabilities.TapCapabilities.html ➕ added
classes/singer_sdk.helpers.capabilities.TargetCapabilities.html ➕ added
classes/singer_sdk.helpers.capabilities.TargetLoadMethods.html ➕ added
classes/singer_sdk.helpers.jsonpath.extract_jsonpath.html ➕ added
classes/singer_sdk.metrics.Metric.html ➕ added
classes/singer_sdk.metrics.Point.html ➕ added
classes/singer_sdk.metrics.Status.html ➕ added
classes/singer_sdk.metrics.Tag.html ➕ added
classes/singer_sdk.schema.source.OpenAPISchema.html ➕ added
classes/singer_sdk.schema.source.SchemaDirectory.html ➕ added
classes/singer_sdk.schema.source.SchemaSource.html ➕ added
classes/singer_sdk.schema.source.StreamSchema.html ➕ added
classes/singer_sdk.singerlib.catalog.Catalog.html ➕ added
classes/singer_sdk.singerlib.catalog.CatalogEntry.html ➕ added
classes/singer_sdk.singerlib.catalog.Metadata.html ➕ added
classes/singer_sdk.singerlib.catalog.MetadataMapping.html ➕ added
classes/singer_sdk.singerlib.catalog.SelectionMask.html ➕ added
classes/singer_sdk.singerlib.catalog.StreamMetadata.html ➕ added
classes/singer_sdk.singerlib.messages.ActivateVersionMessage.html ➕ added
classes/singer_sdk.singerlib.messages.Message.html ➕ added
classes/singer_sdk.singerlib.messages.RecordMessage.html ➕ added
classes/singer_sdk.singerlib.messages.SchemaMessage.html ➕ added
classes/singer_sdk.singerlib.messages.SingerMessageType.html ➕ added
classes/singer_sdk.singerlib.messages.StateMessage.html ➕ added
classes/singer_sdk.singerlib.messages.exclude_null_dict.html ➕ added
classes/singer_sdk.singerlib.messages.format_message.html ➕ added
classes/singer_sdk.singerlib.messages.write_message.html ➕ added
classes/singer_sdk.singerlib.schema.Schema.html ➕ added
classes/singer_sdk.singerlib.schema.resolve_schema_references.html ➕ added
classes/singer_sdk.sql.SQLConnector.html 📝 modified
classes/singer_sdk.sql.SQLStream.html 📝 modified
classes/singer_sdk.sql.SQLTap.html 📝 modified
classes/singer_sdk.sql.SQLTarget.html 📝 modified
classes/singer_sdk.sql.connector.JSONSchemaToSQL.html 📝 modified
classes/singer_sdk.testing.SuiteConfig.html ➕ added
classes/singer_sdk.testing.config.SuiteConfig.html ➕ added
classes/singer_sdk.testing.factory.get_tap_test_class.html ➕ added
classes/singer_sdk.testing.factory.get_target_test_class.html ➕ added
classes/singer_sdk.testing.runners.SingerTestRunner.html ➕ added
classes/singer_sdk.testing.runners.TapTestRunner.html ➕ added
classes/singer_sdk.testing.runners.TargetTestRunner.html ➕ added
classes/singer_sdk.testing.suites.SingerTestSuite.html ➕ added
classes/singer_sdk.testing.tap_tests.AttributeIsBooleanTest.html ➕ added
classes/singer_sdk.testing.tap_tests.AttributeIsDateTimeTest.html ➕ added
classes/singer_sdk.testing.tap_tests.AttributeIsIntegerTest.html ➕ added
classes/singer_sdk.testing.tap_tests.AttributeIsNumberTest.html ➕ added
classes/singer_sdk.testing.tap_tests.AttributeIsObjectTest.html ➕ added
classes/singer_sdk.testing.tap_tests.AttributeNotNullTest.html ➕ added
classes/singer_sdk.testing.tap_tests.StreamCatalogSchemaMatchesRecordTest.html ➕ added
classes/singer_sdk.testing.tap_tests.StreamPrimaryKeysTest.html ➕ added
classes/singer_sdk.testing.tap_tests.StreamRecordMatchesStreamSchema.html ➕ added
classes/singer_sdk.testing.tap_tests.StreamRecordSchemaMatchesCatalogTest.html ➕ added
classes/singer_sdk.testing.tap_tests.StreamReturnsRecordTest.html ➕ added
classes/singer_sdk.testing.tap_tests.StreamSchemaIsValidTest.html ➕ added
classes/singer_sdk.testing.tap_tests.TapCLIPrintsTest.html ➕ added
classes/singer_sdk.testing.tap_tests.TapDiscoveryTest.html ➕ added
classes/singer_sdk.testing.tap_tests.TapStreamConnectionTest.html ➕ added
classes/singer_sdk.testing.tap_tests.TapValidFinalStateTest.html ➕ added
classes/singer_sdk.testing.target_tests.TargetArrayData.html ➕ added
classes/singer_sdk.testing.target_tests.TargetCamelcaseComplexSchema.html ➕ added
classes/singer_sdk.testing.target_tests.TargetCamelcaseTest.html ➕ added
classes/singer_sdk.testing.target_tests.TargetCliPrintsTest.html ➕ added
classes/singer_sdk.testing.target_tests.TargetDuplicateRecords.html ➕ added
classes/singer_sdk.testing.target_tests.TargetEncodedStringData.html ➕ added
classes/singer_sdk.testing.target_tests.TargetInvalidSchemaTest.html ➕ added
classes/singer_sdk.testing.target_tests.TargetMultipleStateMessages.html ➕ added
classes/singer_sdk.testing.target_tests.TargetNoPrimaryKeys.html ➕ added
classes/singer_sdk.testing.target_tests.TargetOptionalAttributes.html ➕ added
classes/singer_sdk.testing.target_tests.TargetPrimaryKeyUpdates.html ➕ added
classes/singer_sdk.testing.target_tests.TargetRecordBeforeSchemaTest.html ➕ added
classes/singer_sdk.testing.target_tests.TargetRecordMissingKeyProperty.html ➕ added
classes/singer_sdk.testing.target_tests.TargetRecordMissingOptionalFields.html ➕ added
classes/singer_sdk.testing.target_tests.TargetSchemaNoProperties.html ➕ added
classes/singer_sdk.testing.target_tests.TargetSchemaUpdates.html ➕ added
classes/singer_sdk.testing.target_tests.TargetSpecialCharsInAttributes.html ➕ added
classes/singer_sdk.testing.templates.AttributeTestTemplate.html ➕ added
classes/singer_sdk.testing.templates.StreamTestTemplate.html ➕ added
classes/singer_sdk.testing.templates.TapTestTemplate.html ➕ added
classes/singer_sdk.testing.templates.TargetTestTemplate.html ➕ added
classes/singer_sdk.testing.templates.TestTemplate.html ➕ added
classes/typing/singer_sdk.typing.ArrayType.html 📝 modified
classes/typing/singer_sdk.typing.ObjectType.html 📝 modified
classes/typing/singer_sdk.typing.OneOf.html 📝 modified
classes/typing/singer_sdk.typing.PropertiesList.html 📝 modified
classes/typing/singer_sdk.typing.Property.html 📝 modified

@edgarrmondragon edgarrmondragon marked this pull request as ready for review December 11, 2025 19:46
@edgarrmondragon edgarrmondragon requested review from a team as code owners December 11, 2025 19:46
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@edgarrmondragon edgarrmondragon self-assigned this Dec 11, 2025
@edgarrmondragon edgarrmondragon added the Documentation Improvements or additions to documentation label Dec 11, 2025
@edgarrmondragon edgarrmondragon added this to the v0.54 milestone Dec 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Document built-in tap and target tests docs: Classes reference source links broken

1 participant