scrapy/docs/index.rst

76 lines
1.5 KiB
ReStructuredText

.. _index:
==============================
Scrapy |version| documentation
==============================
Welcome! This is the documentation for Scrapy, a screen scraping framework for
Python.
For more information about the project visit the `Scrapy homepage
<http://scrapy.org>`_.
Getting started
===============
This section helps you get familiarized with Scrapy and its basic concepts.
.. toctree::
:maxdepth: 2
intro/index
Using Scrapy
============
This section explains all key concepts of Scrapy.
.. toctree::
:maxdepth: 2
topics/index
API reference
=============
This section documents the :ref:`Scrapy API <ref-index>`. See also
:ref:`misc-api-stability`.
.. toctree::
:maxdepth: 2
ref/index
Frequently asked questions
==========================
.. toctree::
:maxdepth: 2
faq
Experimental features
=====================
This section documents experimental features that may become stable in future
Scrapy releases, but whose API is not yet stable. Use them with caution, and
subscribe to the `mailing lists <http://scrapy.org/community/>`_ to be notified
of any changes.
.. toctree::
:maxdepth: 1
topics/adaptors
Proposed documentation
======================
This section contains documentation which is not yet completed, or which
overlaps with existing documentation and needs to be manually merged. It may
also contain outdated information, as it's not revised so frequently.
.. toctree::
:maxdepth: 2
proposed/index