Add release notes (scrapy#25)

docs/_ext/__init__.py

@@ -0,0 +1 @@
+

docs/_ext/github.py

@@ -0,0 +1,20 @@
+from docutils import nodes
+from docutils.parsers.rst.roles import set_classes
+
+
+def setup(app):
+    app.add_role('gh', github_role)
+
+
+def github_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
+    if text.isdigit():
+        display_text = f'#{text}'
+        url = f'https://github.com/scrapy/itemloaders/issues/{text}'
+    else:
+        short_commit = text[:7]
+        display_text = short_commit
+        url = f'https://github.com/scrapy/itemloaders/commit/{short_commit}'
+
+    set_classes(options)
+    node = nodes.reference(rawtext, display_text, refuri=url, **options)
+    return [node], []

docs/conf.py

@@ -18,6 +18,7 @@
 # If your extensions are in another directory, add it here. If the directory
 # is relative to the documentation root, use os.path.abspath to make it
 # absolute, like shown here.
+sys.path.append(path.dirname(__file__))
 sys.path.insert(0, path.dirname(path.dirname(__file__)))
 
 # General configuration
@@ -26,6 +27,7 @@
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
+    '_ext.github',
     'sphinx.ext.autodoc',
     'sphinx.ext.coverage',
     'sphinx.ext.intersphinx',
@@ -226,4 +228,6 @@ def maybe_skip_member(app, what, name, obj, skip, options):
 intersphinx_mapping = {
     'parsel': ('https://parsel.readthedocs.io/en/stable/', None),
     'python': ('https://docs.python.org/3', None),
+    'scrapy': ('https://docs.scrapy.org/en/latest/', None),
+    'w3lib': ('https://w3lib.readthedocs.io/en/latest', None),
 }

docs/declaring-loaders.rst

@@ -38,12 +38,17 @@ declare a default input/output processors using the
 
 The precedence order, for both input and output processors, is as follows:
 
-1. Item Loader field-specific attributes: ``field_in`` and ``field_out`` (most
-   precedence)
-2. Field metadata (``input_processor`` and ``output_processor`` keys).
-   Check out
-   `itemadapter field metadata <https://github.com/scrapy/itemadapter#metadata-support>`_
-   for more information.
+1.  Item Loader field-specific attributes: ``field_in`` and ``field_out`` (most
+    precedence)
+
+2.  Field metadata (``input_processor`` and ``output_processor`` keys).
+
+    Check out `itemadapter field metadata
+    <https://github.com/scrapy/itemadapter#metadata-support>`_ for more
+    information.
+
+    .. versionadded:: 1.0.1
+
 3. Item Loader defaults: :meth:`ItemLoader.default_input_processor` and
    :meth:`ItemLoader.default_output_processor` (least precedence)
 

docs/index.rst

@@ -101,3 +101,4 @@ Contents
     extending-loaders
     built-in-processors
     api-reference
+    release-notes

docs/release-notes.rst

@@ -0,0 +1,61 @@
+.. currentmodule:: itemloaders
+
+.. _release-notes:
+
+Release notes
+=============
+
+.. _release-1.0.3:
+
+itemloaders 1.0.3 (2020-09-09)
+------------------------------
+
+-   Calls to :meth:`ItemLoader.get_output_value` no longer affect the output of
+    :meth:`ItemLoader.load_item` (:gh:`21`, :gh:`22`)
+
+-   Fixed some documentation links (:gh:`19`, :gh:`23`)
+
+-   Fixed some test warnings (:gh:`24`)
+
+
+.. _release-1.0.2:
+
+itemloaders 1.0.2 (2020-08-05)
+------------------------------
+
+-   Included the license file in the source releases (:gh:`13`)
+
+-   Cleaned up some remnants of Python 2 (:gh:`16`, :gh:`17`)
+
+
+.. _release-1.0.1:
+
+itemloaders 1.0.1 (2020-07-02)
+------------------------------
+
+-   Extended item type support to all item types supported by itemadapter_
+    (:gh:`13`)
+
+-   :ref:`Input and output processors <declaring-loaders>` defined in item
+    field metadata are now taken into account (:gh:`13`)
+
+-   Lowered some minimum dependency versions (:gh:`10`):
+
+    -   :doc:`parsel <parsel:index>`: 1.5.2 → 1.5.0
+
+    -   :doc:`w3lib <w3lib:index>`: 1.21.0 → 1.17.0
+
+-   Improved the README file (:gh:`9`)
+
+-   Improved continuous integration (:gh:`e62d95b`)
+
+
+.. _release-1.0.0:
+
+itemloaders 1.0.0 (2020-05-18)
+------------------------------
+
+Initial release, based on a part of the :doc:`Scrapy <scrapy:index>` code base.
+
+
+.. _itemadapter: https://github.com/scrapy/itemadapter#itemadapter