From 012fd1cc2ff4f283eb3b9bf1df0c22aff1dc7e15 Mon Sep 17 00:00:00 2001 From: Pablo Hoffman Date: Fri, 21 Aug 2009 16:29:23 -0300 Subject: [PATCH] moved api-stability.rst doc to root and updated it --HG-- rename : docs/misc/api-stability.rst => docs/api-stability.rst --- docs/{misc => }/api-stability.rst | 9 +++------ docs/contents.rst | 3 ++- docs/misc/index.rst | 12 ------------ docs/reference.rst | 2 +- 4 files changed, 6 insertions(+), 20 deletions(-) rename docs/{misc => }/api-stability.rst (67%) delete mode 100644 docs/misc/index.rst diff --git a/docs/misc/api-stability.rst b/docs/api-stability.rst similarity index 67% rename from docs/misc/api-stability.rst rename to docs/api-stability.rst index c43fcd3cb..48429a3ca 100644 --- a/docs/misc/api-stability.rst +++ b/docs/api-stability.rst @@ -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 diff --git a/docs/contents.rst b/docs/contents.rst index 6a748f364..a13eb38d5 100644 --- a/docs/contents.rst +++ b/docs/contents.rst @@ -8,6 +8,7 @@ Scrapy documentation contents intro/index topics/index - reference faq experimental/index + reference + api-stability diff --git a/docs/misc/index.rst b/docs/misc/index.rst deleted file mode 100644 index ab548e08a..000000000 --- a/docs/misc/index.rst +++ /dev/null @@ -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 diff --git a/docs/reference.rst b/docs/reference.rst index 16897148e..d9e3e8a01 100644 --- a/docs/reference.rst +++ b/docs/reference.rst @@ -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`