index.rst

reader

Features

Quickstart

What does it look like? Here is an example of reader in use:

User guide

This part of the documentation guides you through all of the library’s usage patterns.

.. toctree::
    :maxdepth: 2

    why
    install
    tutorial
    guide

API reference

If you are looking for information on a specific function, class, or method, this part of the documentation is for you.

.. toctree::
    :maxdepth: 2

    api
    internal

Unstable features

The following are optional features that are still being worked on. They may become their own packages, get merged into the main library, or be removed in the future.

.. toctree::
    :maxdepth: 2

    cli
    app
    config
    plugins

Project information

reader is released under the :gh:`BSD <LICENSE>` license, its documentation lives at Read the Docs, the code on GitHub, and the latest release on PyPI. It is rigorously tested on Python |min_python|+ and PyPy.

.. toctree::
    :maxdepth: 2

    contributing
    dev
    changelog

Indices and tables

• :ref:`genindex`
• :ref:`search`