diff --git a/docs/_ext/scrapydocs.py b/docs/_ext/scrapydocs.py index 6b1e6a9b4..54622f1ad 100644 --- a/docs/_ext/scrapydocs.py +++ b/docs/_ext/scrapydocs.py @@ -25,7 +25,7 @@ def setup(app): app.add_role('source', source_role) def source_role(name, rawtext, text, lineno, inliner, options={}, content=[]): - url = 'http://dev.scrapy.org/browser/' + text + url = 'https://github.com/scrapy/scrapy/blob/master/' + text set_classes(options) node = nodes.reference(rawtext, text, refuri=ref, **options) return [node], [] diff --git a/docs/contributing.rst b/docs/contributing.rst index d227b223e..a852bd777 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -8,7 +8,7 @@ There are many ways to contribute to Scrapy. Here are some of them: newcomers with more examples and the Scrapy project to increase its visibility. -* Report bugs and request features in the `ticket tracker`_, trying to follow +* Report bugs and request features in the `issue tracker`_, trying to follow the guidelines detailed in `Reporting bugs`_ below. * Submit patches for new functionality and/or bug fixes. Please read @@ -27,10 +27,9 @@ guidelines when reporting a new bug. * check the :ref:`FAQ ` first to see if your issue is addressed in a well-known question -* check the `active tickets` in the issue tracker to see if your issue has - already been reported. If it has, don't dismiss the report but check the - ticket history and comments, you may find additional useful information to - contribute. +* check the `open issues`_ to see if it has already been reported. If it has, + don't dismiss the report but check the ticket history and comments, you may + find additional useful information to contribute. * search the `scrapy-users`_ list to see if it has been discussed there, or if you're not sure if what you're seeing is a bug. You can also ask in the @@ -71,21 +70,16 @@ Well-written patches should: Submitting patches ================== -To submit patches, any of the following mechanism is considered good: +The best way to submit a patch is to issue a `pull request`_ on Github, +optionally creating a new issue first. -* create appropriate tickets in the issue tracker and attach the patches to - those tickets. The patches can be generated using ``hg diff``. +Alternatively, we also accept the patches in the traditional way of sending +them to the `scrapy-developers`_ list. -* send the patches to the `scrapy-developers`_ list, along with a comment - explaining what was fixed or the new functionality (what it is, why it's - needed, etc). The more info you include, the easier will be for core - developers to understand and accept your patch. - -* fork the `Github mirror`_ and send a pull request when you're done working on - the patch - -* clone the `Bitbucket mirror`_ and send a pull request when you're done - working on the patch +Regardless of which mechanism you use, remember to explain what was fixed or +the new functionality (what it is, why it's needed, etc). The more info you +include, the easier will be for core developers to understand and accept your +patch. You can also discuss the new functionality (or bug fix) in `scrapy-developers`_ first, before creating the patch, but it's always good to have a patch ready to @@ -112,7 +106,7 @@ Documentation policies * **Don't** use docstrings for documenting classes, or methods which are already documented in the official (sphinx) documentation. For example, the :meth:`ItemLoader.add_value` method should be documented in the sphinx - documentation and not its docstring. + documentation, not its docstring. * **Do** use docstrings for documenting functions not present in the official (sphinx) documentation, such as functions from ``scrapy.utils`` package and @@ -156,12 +150,11 @@ And their unit-tests are in:: scrapy.tests.test_contrib_loader -.. _ticket tracker: http://dev.scrapy.org/newticket +.. _issue tracker: https://github.com/scrapy/scrapy/issues .. _scrapy-users: http://groups.google.com/group/scrapy-users .. _scrapy-developers: http://groups.google.com/group/scrapy-developers -.. _Github mirror: http://github.com/insophia/scrapy/ -.. _Bitbucket mirror: http://bitbucket.org/insophia/scrapy/ .. _Twisted unit-testing framework: http://twistedmatrix.com/documents/current/core/development/policy/test-standard.html -.. _AUTHORS: http://dev.scrapy.org/browser/AUTHORS -.. _scrapy/tests: http://dev.scrapy.org/browser/scrapy/tests -.. _active tickets: http://dev.scrapy.org/report/1 +.. _AUTHORS: https://github.com/scrapy/scrapy/blob/master/AUTHORS +.. _scrapy/tests: https://github.com/scrapy/scrapy/tree/master/scrapy/tests +.. _open issues: https://github.com/scrapy/scrapy/issues +.. _pull request: http://help.github.com/send-pull-requests/ diff --git a/docs/faq.rst b/docs/faq.rst index 36e06d8b9..a6fc4927d 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -32,10 +32,7 @@ What Python versions does Scrapy support? Scrapy runs in Python 2.5, 2.6 and 2.7. But it's recommended you use Python 2.6 or above, since the Python 2.5 standard library has a few bugs in their URL handling libraries. Some of these Python 2.5 bugs not only affect Scrapy but -any user code, such as spiders. You can see a list of `Python 2.5 bugs that -affect Scrapy`_ in the issue tracker. - -.. _Python 2.5 bugs that affect Scrapy: http://dev.scrapy.org/query?status=accepted&status=assigned&status=new&status=reopened&order=priority&keywords=~py25-bug +any user code, such as spiders. Does Scrapy work with Python 3.0? --------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 898f33249..1236d5329 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,12 +16,12 @@ Having trouble? We'd like to help! * Search for information in the `archives of the scrapy-users mailing list`_, or `post a question`_. * Ask a question in the `#scrapy IRC channel`_. -* Report bugs with Scrapy in our `ticket tracker`_. +* Report bugs with Scrapy in our `issue tracker`_. .. _archives of the scrapy-users mailing list: http://groups.google.com/group/scrapy-users/ .. _post a question: http://groups.google.com/group/scrapy-users/ .. _#scrapy IRC channel: irc://irc.freenode.net/scrapy -.. _ticket tracker: http://dev.scrapy.org/ +.. _issue tracker: https://github.com/scrapy/scrapy/issues First steps diff --git a/docs/intro/examples.rst b/docs/intro/examples.rst index 8e8b77fc7..b09eed874 100644 --- a/docs/intro/examples.rst +++ b/docs/intro/examples.rst @@ -16,18 +16,10 @@ It contains a README file with a detailed description of the project contents. If you're familiar with git, you can checkout the code. Otherwise you can download a tarball or zip file of the project by clicking on `Downloads`_. -Other sources for examples -========================== - -1. There is a site for sharing code snippets (spiders, middlewares, extensions) -called `Scrapy snippets`_. - -2. There is also a `Scrapy Recipes`_ page on the wiki that contains code -snippets for performing not-so-trivial tasks. This contains code posted before -the `Scrapy snippets`_ site was lunched. New code should be posted in `Scrapy -snippets`_. +There is also a site for sharing code snippets such as spiders, middlewares, +extensions, or scripts, called `Scrapy snippets`_. Feel free to share any code +there. .. _dirbot: https://github.com/scrapy/dirbot .. _Downloads: https://github.com/scrapy/dirbot/archives/master -.. _Scrapy Recipes: http://dev.scrapy.org/wiki/ScrapyRecipes .. _Scrapy snippets: http://snippets.scrapy.org/ diff --git a/docs/intro/install.rst b/docs/intro/install.rst index 46409a8ea..c16d82bd3 100644 --- a/docs/intro/install.rst +++ b/docs/intro/install.rst @@ -183,6 +183,5 @@ There are two ways to install Scrapy in Windows: .. _this Twisted bug: http://twistedmatrix.com/trac/ticket/3707 .. _pip: http://pypi.python.org/pypi/pip .. _setuptools: http://pypi.python.org/pypi/setuptools -.. _Mercurial: http://www.selenic.com/mercurial/ .. _Control Panel: http://www.microsoft.com/resources/documentation/windows/xp/all/proddocs/en-us/sysdm_advancd_environmnt_addchange_variable.mspx .. _Downloads page: http://scrapy.org/download/ diff --git a/docs/topics/commands.rst b/docs/topics/commands.rst index 22d84d2d3..d4126d31f 100644 --- a/docs/topics/commands.rst +++ b/docs/topics/commands.rst @@ -452,7 +452,7 @@ You can also add your custom project commands by using the :setting:`COMMANDS_MODULE` setting. See the Scrapy commands in `scrapy/commands`_ for examples on how to implement your commands. -.. _scrapy/commands: http://dev.scrapy.org/browser/scrapy/commands +.. _scrapy/commands: https://github.com/scrapy/scrapy/blob/master/scrapy/commands .. setting:: COMMANDS_MODULE COMMANDS_MODULE diff --git a/docs/topics/link-extractors.rst b/docs/topics/link-extractors.rst index ac53eaa59..ef62efad0 100644 --- a/docs/topics/link-extractors.rst +++ b/docs/topics/link-extractors.rst @@ -151,4 +151,4 @@ BaseSgmlLinkExtractor :type process_value: callable -.. _scrapy.linkextractor: http://dev.scrapy.org/browser/scrapy/linkextractor.py +.. _scrapy.linkextractor: https://github.com/scrapy/scrapy/blob/master/scrapy/linkextractor.py diff --git a/docs/topics/scrapyd.rst b/docs/topics/scrapyd.rst index 8803e70fe..fabe1d251 100644 --- a/docs/topics/scrapyd.rst +++ b/docs/topics/scrapyd.rst @@ -313,7 +313,7 @@ revision, for example ``r382``:: scrapy deploy scrapyd -p project1 --version HG -Also, if you use Git for tracking your project source code, you can use +And, if you use Git for tracking your project source code, you can use ``GIT`` for the version which will be replaced by the SHA1 of current Git revision, for example ``b0582849179d1de7bd86eaa7201ea3cda4b5651f``:: diff --git a/docs/topics/ubuntu.rst b/docs/topics/ubuntu.rst index f554c8b6b..b2d550bc3 100644 --- a/docs/topics/ubuntu.rst +++ b/docs/topics/ubuntu.rst @@ -7,9 +7,9 @@ Ubuntu packages .. versionadded:: 0.10 `Insophia`_ publishes apt-gettable packages which are generally fresher than -those in Ubuntu, and more stable too since they're built continously from -`Scrapy Mercurial repositories`_ (stable & development) and so they contain the -latest bug fixes. +those in Ubuntu, and more stable too since they're continuously built from +`Github repo`_ (master & stable branches) and so they contain the latest bug +fixes. To use the packages, just add the following line to your ``/etc/apt/sources.list``, and then run ``aptitude update`` and ``aptitude @@ -46,4 +46,4 @@ keyring as follows:: curl -s http://archive.scrapy.org/ubuntu/archive.key | sudo apt-key add - .. _Insophia: http://insophia.com/ -.. _Scrapy Mercurial repositories: http://hg.scrapy.org/ +.. _Github repo: https://github.com/scrapy/scrapy diff --git a/docs/versioning.rst b/docs/versioning.rst index cbe670b35..cba8601e7 100644 --- a/docs/versioning.rst +++ b/docs/versioning.rst @@ -18,8 +18,8 @@ There are 4 numbers in a Scrapy version: *A.B.C.D* stable branches, and odd Bs will be development. * *C* is the bugfix release number, but it has been recently deprecated of favor of using the revision number (*D*) -* *D* is the revision number of the Mercurial repo from where the release was - taken +* *D* is an incremental number (aka. revision) based on the number of commits + in the git repo where the release was taken For example: