Read the Docs

tap-readthedocs from edgarrmondragon

Read the Docs simplifies software documentation by automating building, versioning, and hosting of your docs for you.

The tap-readthedocs extractor pulls data from Read the Docs that can then be sent to a destination using a loader.

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-readthedocs extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-readthedocs
  3. Configure the tap-readthedocs settings using
    meltano config
    :
  4. meltano config tap-readthedocs set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-readthedocs test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-readthedocs may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • catalog
  • discover
  • state
  • about
  • stream-maps
  • schema-flattening

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-readthedocs settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

API Token (token)

  • Environment variable: TAP_READTHEDOCS_TOKEN

Personal Access Token that allows you to use the Read the Docs APIv3 being authenticated as yourself

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-readthedocs extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the
#plugins-general
channel.

Install

meltano add extractor tap-readthedocs

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Edgar Ramirez

Keywords

  • apimeltano_sdk