From 5c39d173a54bba39defc0db874e20c053b8c01f7 Mon Sep 17 00:00:00 2001 From: Pablo Hoffman Date: Mon, 13 Jul 2009 22:15:54 -0300 Subject: [PATCH] merged proposed and experimental documentation, as it didn't make sense to keep two separate sections --HG-- rename : docs/proposed/_images/scrapy_architecture.odg => docs/experimental/_images/scrapy_architecture.odg rename : docs/proposed/_images/scrapy_architecture.png => docs/experimental/_images/scrapy_architecture.png rename : docs/proposed/index.rst => docs/experimental/index.rst rename : docs/proposed/newitem-fields.rst => docs/experimental/newitem-fields.rst rename : docs/proposed/newitem.rst => docs/experimental/newitem.rst --- docs/_templates/index.html | 12 ++++----- docs/contents.rst | 3 +-- docs/experimental.rst | 15 ----------- .../_images/scrapy_architecture.odg | Bin .../_images/scrapy_architecture.png | Bin docs/experimental/index.rst | 24 ++++++++++++++++++ .../newitem-fields.rst | 0 docs/{proposed => experimental}/newitem.rst | 0 docs/proposed/index.rst | 22 ---------------- 9 files changed, 30 insertions(+), 46 deletions(-) delete mode 100644 docs/experimental.rst rename docs/{proposed => experimental}/_images/scrapy_architecture.odg (100%) rename docs/{proposed => experimental}/_images/scrapy_architecture.png (100%) create mode 100644 docs/experimental/index.rst rename docs/{proposed => experimental}/newitem-fields.rst (100%) rename docs/{proposed => experimental}/newitem.rst (100%) delete mode 100644 docs/proposed/index.rst diff --git a/docs/_templates/index.html b/docs/_templates/index.html index e6840aa9d..67270fdc6 100644 --- a/docs/_templates/index.html +++ b/docs/_templates/index.html @@ -6,17 +6,15 @@

Getting started
for an overview and tutorial

-

API Reference
- all details about Scrapy stable API

-

Experimental Features
- use with caution

-

Using Scrapy
usage guide and key concepts

+

API Reference
+ all details about Scrapy stable API

+

Frequently Asked Questions
for common questions

-

Proposed documentation
- documentation in progress or unstable features

+

Experimental Features
+ use with caution

diff --git a/docs/contents.rst b/docs/contents.rst index 73a97b801..bb243c840 100644 --- a/docs/contents.rst +++ b/docs/contents.rst @@ -11,5 +11,4 @@ Scrapy documentation contents ref/index faq topics/adaptors - experimental - proposed/index + experimental/index diff --git a/docs/experimental.rst b/docs/experimental.rst deleted file mode 100644 index 1bc4ebea8..000000000 --- a/docs/experimental.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _ref-experimental: - -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 `_ to be notified -of any changes. - -.. toctree:: - :maxdepth: 1 - - topics/adaptors - diff --git a/docs/proposed/_images/scrapy_architecture.odg b/docs/experimental/_images/scrapy_architecture.odg similarity index 100% rename from docs/proposed/_images/scrapy_architecture.odg rename to docs/experimental/_images/scrapy_architecture.odg diff --git a/docs/proposed/_images/scrapy_architecture.png b/docs/experimental/_images/scrapy_architecture.png similarity index 100% rename from docs/proposed/_images/scrapy_architecture.png rename to docs/experimental/_images/scrapy_architecture.png diff --git a/docs/experimental/index.rst b/docs/experimental/index.rst new file mode 100644 index 000000000..12e5e697a --- /dev/null +++ b/docs/experimental/index.rst @@ -0,0 +1,24 @@ +.. _experimental-index: + +Experimental features +===================== + +This section documents experimental features that may become stable in the +future, but whose API is not yet stable. Use them with caution, and subscribe +to the `mailing lists `_ to be notified of any +changes. + +This section may also contain documentation which is outdated or incomplete (as +it's not revised so frequently), or documentation which overlaps with existing +(stable) documentation and needs to be manually merged, use at your own risk. + +.. warning:: + + This documentation is a work in progress, use at your own risk. + +.. toctree:: + :maxdepth: 1 + + newitem + newitem-fields + diff --git a/docs/proposed/newitem-fields.rst b/docs/experimental/newitem-fields.rst similarity index 100% rename from docs/proposed/newitem-fields.rst rename to docs/experimental/newitem-fields.rst diff --git a/docs/proposed/newitem.rst b/docs/experimental/newitem.rst similarity index 100% rename from docs/proposed/newitem.rst rename to docs/experimental/newitem.rst diff --git a/docs/proposed/index.rst b/docs/proposed/index.rst deleted file mode 100644 index 45b1041c4..000000000 --- a/docs/proposed/index.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. _proposed-index: - -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. - -.. warning:: - - This is experimental or "work in progress" documentation, use at your own - risk! - -.. toctree:: - :maxdepth: 1 - - newitem - newitem-fields - spiders - -