Merge pull request #137 from Digenis/1.0

Documentation and code backports for 1.0
scrapy · Mar 28, 2016 · 61bfabe · 61bfabe
2 parents 158887c + 3ed2d46
commit 61bfabe
Show file tree

Hide file tree

Showing 10 changed files with 64 additions and 11 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -6,6 +6,14 @@ API
 
 The following section describes the available resources in Scrapyd JSON API.
 
+.. warning::
+
+    This documentation is for the old |version| version of scrapyd.
+    Unless you are maintaining an old project that requires it,
+    you may instead want the
+    `latest version <http://scrapyd.readthedocs.org/en/latest/>`_.
+
+
 addversion.json
 ---------------
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -48,9 +48,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.18'
+version = '1.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.18'
+#release = ''
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/config.rst b/docs/config.rst
@@ -14,6 +14,14 @@ them in order with the latest one taking more priority:
 The configuration file supports the following options (see default values in
 the :ref:`example <config-example>`).
 
+.. warning::
+
+    This documentation is for the old |version| version of scrapyd.
+    Unless you are maintaining an old project that requires it,
+    you may instead want the
+    `latest version <http://scrapyd.readthedocs.org/en/latest/>`_.
+
+
 http_port
 ---------
 

diff --git a/docs/deploy.rst b/docs/deploy.rst
@@ -21,6 +21,15 @@ your project) and each target supports multiple projects.
 Each time you deploy a new version of a project, you can name it for later
 reference.
 
+.. warning::
+
+    This documentation is for the old |version| version of scrapyd.
+    Unless you are maintaining an old project that requires it,
+    you may instead want the
+    `latest version <http://scrapyd.readthedocs.org/en/latest/>`_.
+
+
+
 Show and define targets
 -----------------------
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -5,6 +5,14 @@ Scrapyd a is an application for deploying and running Scrapy spiders. It
 enables you to deploy (upload) your projects and control their spiders using a
 JSON API.
 
+.. warning::
+
+    This documentation is for the old |version| version of scrapyd.
+    Unless you are maintaining an old project that requires it,
+    you may instead want the
+    `latest version <http://scrapyd.readthedocs.org/en/latest/>`_.
+
+
 Contents
 --------
 .. toctree::

diff --git a/docs/install.rst b/docs/install.rst
@@ -6,6 +6,13 @@ Installation
 This documents explains how to install and configure Scrapyd, to deploy and run
 your Scrapy spiders.
 
+.. warning::
+
+    This documentation is for the old |version| version of scrapyd.
+    Unless you are maintaining an old project that requires it,
+    you may instead want the
+    `latest version <http://scrapyd.readthedocs.org/en/latest/>`_.
+
 Requirements
 ------------
 

diff --git a/docs/news.rst b/docs/news.rst
@@ -3,7 +3,16 @@
 Release notes
 =============
 
-1.0 (unreleased)
-----------------
+.. warning::
+
+    This documentation is for the old |version| version of scrapyd.
+    Unless you are maintaining an old project that requires it,
+    you may instead want the
+    `latest version <http://scrapyd.readthedocs.org/en/latest/>`_.
+
+
+1.0
+---
 
 First standalone release (it was previously shipped with Scrapy until Scrapy 0.16).
+
diff --git a/docs/overview.rst b/docs/overview.rst
@@ -2,6 +2,14 @@
 Overview
 ========
 
+.. warning::
+
+    This documentation is for the old |version| version of scrapyd.
+    Unless you are maintaining an old project that requires it,
+    you may instead want the
+    `latest version <http://scrapyd.readthedocs.org/en/latest/>`_.
+
+
 Projects and versions
 =====================
 
@@ -48,11 +56,6 @@ distribution::
 
 That should get your Scrapyd started.
 
-Or, if you want to start Scrapyd from inside a Scrapy project you can use the
-`server command`_, like this::
-
-    scrapy server
-
 Scheduling a spider run
 =======================
 

diff --git a/scrapyd/website.py b/scrapyd/website.py
@@ -70,7 +70,7 @@ def render_GET(self, txrequest):
 <li><a href="/jobs">Jobs</a></li>
 <li><a href="/items/">Items</li>
 <li><a href="/logs/">Logs</li>
-<li><a href="http://doc.scrapy.org/en/latest/topics/scrapyd.html">Documentation</a></li>
+<li><a href="http://scrapyd.readthedocs.org/en/1.0/">Documentation</a></li>
 </ul>
 
 <h2>How to schedule a spider?</h2>
@@ -81,7 +81,7 @@ def render_GET(self, txrequest):
 <p>Example using <a href="http://curl.haxx.se/">curl</a>:</p>
 <p><code>curl http://localhost:6800/schedule.json -d project=default -d spider=somespider</code></p>
 
-<p>For more information about the API, see the <a href="http://doc.scrapy.org/en/latest/topics/scrapyd.html">Scrapyd documentation</a></p>
+<p>For more information about the API, see the <a href="http://scrapyd.readthedocs.org/en/1.0/">Scrapyd documentation</a></p>
 </body>
 </html>
 """ % vars

diff --git a/setup.py b/setup.py
@@ -17,6 +17,7 @@
     'packages': ['scrapyd'],
     'scripts': ['bin/scrapyd', 'bin/scrapyd-deploy'],
     'include_package_data': True,
+    'zip_safe': False,
     'classifiers': [
         'Programming Language :: Python',
         'Programming Language :: Python :: 2.6',