moved api-stability.rst doc to root and updated it

--HG--
rename : docs/misc/api-stability.rst => docs/api-stability.rst
This commit is contained in:
Pablo Hoffman 2009-08-21 16:29:23 -03:00
parent 07c1f3b8d8
commit 012fd1cc2f
4 changed files with 6 additions and 20 deletions

View File

@ -1,12 +1,10 @@
.. _misc-api-stability:
.. _api-stability:
============================
Versioning and API Stability
============================
API stability is one of Scrapy major goals. We're currently working on
documenting and stabilizing the main parts of Scrapy towards the first official
release (version |version|).
API stability is one of Scrapy major goals.
Versioning
==========
@ -25,8 +23,7 @@ API Stability
Methods or functions that start with a single dash (``_``) are private and
should never be relied as stable. Besides those, the plan is to stabilize and
document the entire API, as we approach the 1.0 release. In the meantime,
you'll find here a list of the APIs that we consider already stable.
document the entire API, as we approach the 1.0 release.
Also, keep in mind that stable doesn't mean complete: stable APIs could grow
new methods or functionality but the existing methods should keep working the

View File

@ -8,6 +8,7 @@ Scrapy documentation contents
intro/index
topics/index
reference
faq
experimental/index
reference
api-stability

View File

@ -1,12 +0,0 @@
.. _misc-index:
Project information
===================
This section contains information about the Scrapy project that doesn't fit in
any other section.
.. toctree::
:maxdepth: 1
api-stability

View File

@ -3,7 +3,7 @@
API Reference
=============
This section documents the Scrapy |version| API. For more information see :ref:`misc-api-stability`.
This section documents the Scrapy |version| API. For more information see :ref:`api-stability`.
* :ref:`topics-request-response`
* :ref:`topics-spiders-ref`