Commit 93f5ed32 authored by Dmitry Shachnev's avatar Dmitry Shachnev 🐧

Updated version 0.14+dfsg from 'upstream/0.14+dfsg'.

parents 5e4ad732 9c9d5d3c
......@@ -4,8 +4,8 @@
:Author: David Goodger; open to all Docutils developers
:Contact: goodger@python.org
:Date: $Date: 2014-07-07 04:36:36 +0200 (Mo, 07. Jul 2014) $
:Revision: $Revision: 7768 $
:Date: $Date: 2017-06-09 13:02:35 +0200 (Fr, 09 Jun 2017) $
:Revision: $Revision: 8103 $
:Copyright: This document has been placed in the public domain.
.. _Docutils: http://docutils.sourceforge.net/
......@@ -152,8 +152,10 @@ Also see the `SourceForge Bug Tracker`_.
``href="C:/test/foo.css"`` instead of
``href="file:///C:/test/foo.css"``.
For details, see `this posting by Alan G. Isaac
<http://article.gmane.org/gmane.text.docutils.user/1569>`_.
.. gmane web interface is down.
TODO: find this article in the Sourceforge mail archives
For details, see `this posting by Alan G. Isaac
<http://article.gmane.org/gmane.text.docutils.user/1569>`_.
* Footnote label "5" should be "4" when processing the following
input::
......
......@@ -4,7 +4,7 @@
:Author: David Goodger
:Contact: goodger@python.org
:Date: $Date: 2015-05-08 17:56:32 +0200 (Fr, 08. Mai 2015) $
:Date: $Date: 2015-05-08 17:56:32 +0200 (Fr, 08 Mai 2015) $
:Web site: http://docutils.sourceforge.net/
:Copyright: This document has been placed in the public domain.
......
......@@ -9,7 +9,7 @@
Docutils FAQ (Frequently Asked Questions)
===========================================
:Date: $Date: 2016-02-26 22:40:17 +0100 (Fr, 26. Feb 2016) $
:Date: $Date: 2016-02-26 22:40:17 +0100 (Fr, 26 Feb 2016) $
:Revision: $Revision: 7934 $
:Web site: http://docutils.sourceforge.net/
:Copyright: This document has been placed in the public domain.
......
......@@ -6,13 +6,123 @@
:Author: David Goodger; open to all Docutils developers
:Contact: docutils-develop@lists.sourceforge.net
:Date: $Date: 2016-12-09 10:48:58 +0100 (Fr, 09. Dez 2016) $
:Revision: $Revision: 7985 $
:Date: $Date: 2017-08-03 11:01:16 +0200 (Do, 03 Aug 2017) $
:Revision: $Revision: 8147 $
:Web site: http://docutils.sourceforge.net/
:Copyright: This document has been placed in the public domain.
.. contents::
Release 0.14 (2017-08-03)
=========================
As rc2.
* docs/ref/docutils.dtd:
- Enable validation of Docutils XML documents against the DTD:
Use attribute type NMTOKEN instead of REFID for the `refid` attribute
and NMTOKENS for `backrefs`: REFID refers to an ID type instance,
however, the `ids` attribute cannot use the ID type because `XML only
allows one ID per Element Type`__ and doesn't support a multiple-ID
"IDS" attribute type.
__ https://www.w3.org/TR/REC-xml/#sec-attribute-types
* docs/ref/rst/restructuredtext.txt:
- Added documentation for escaped whitespace in URI contexts.
- Clarify use of Unicode character categories.
* docutils/parsers/rst/states.py:
- Added functionality: escaped whitespace in URI contexts.
- Consistent handling of all whitespace characters in inline markup
recognition. Fixes [ 307 ] and [ 3402314 ] (now [ 173 ]).
* docutils/parsers/rst/directives/images.py:
- Added support for escaped whitespace in URI contexts.
* docutils/parsers/rst/directives/tables.py:
- Rework patch [ 120 ] (revert change to ``Table.get_column_widths()``
that led to problems in an application with a custom table directive).
* docutils/transforms/frontmatter.py
- Fix [ 320 ] Russian docinfo fields not recognized.
* docutils/transforms/references.py
- Don't add a second ID to problematic references.
* docutils/transforms/universal.py
Fix SmartQuotes: warn only once if language is unsupported,
keep "rawsource" when "educating" quotes.
* docutils/utils/__init__.py:
- Added ``split_escaped_whitespace`` function, support for escaped
whitespace in URI contexts.
* docutils/utils/error_reporting.py
- Fix [ 321 ] Import block might cause name error.
* docutils/utils/smartquotes.py:
- Update quote definitions for languages et, fi, fr, ro, sv, tr, uk.
- New quote definitions for hr, hsb, hu, lv, sh, sl, sr.
- Fix [ 313 ] Differentiate apostrophe from closing single quote
(if possible).
- Fix [ 317 ] Extra space inserted with French smartquotes.
- Add command line interface for stand-alone use (requires 2.7).
* docutils/writers/_html_base.py
- Provide default title in metadata (required by HTML5).
- Fix [ 312 ] HTML writer generates invalid HTML if the table has two tags.
- Fix [ 319 ] The MathJax CDN shut down on April 30, 2017. For security
reasons, we don't use a third party public installation as default but
warn if math-output_ is set to MathJax without specifying a URL.
* docutils/writers/html4css1/__init__.py
- Apply [ 125 ] HTML writer: respect automatic table column sizing.
* docutils/writers/latex2e/__init__.py
- Handle class arguments for block-level elements by wrapping them
in a "DUclass" environment. This replaces the special handling for
"epigraph" and "topic" elements.
* docutils/writers/manpage.py
- Apply [ 141 ] Handling inline in manpage writer.
* docutils/writers/odf_odt/__init__.py:
- Command setting ``language`` now sets the default language
of the generated ODF document.
- The use of image directive options :width: (%), :scale:, etc now
set the width/height/size of images in the generated ODF
documents.
- The heading/title of admonitions now reflects the language
specified by the ``language`` setting.
- Fixed [ 306 ] only first of multiple "image" directives with the same URL
shown in output.
- Fixed [ 282 ] python3: AttributeError.
* tools/rst2html4.py: New front-end.
* tools/dev/generate_punctuation_chars.py: New skript
to test and update utils.punctuation_chars.
Release 0.13.1 (2016-12-09)
===========================
......@@ -20,10 +130,10 @@ Release 0.13.1 (2016-12-09)
docutils/parsers/rst/languages/fa.py
docutils/languages/la.py
docutils/parsers/rst/languages/la.py:
- Apply [ 133 ] Persian mappings by Shahin Azad.
- Apply [ 135 ] Language modules for Latvian by Alexander Smishlajev
* docutils/nodes.py
- Fix [ 253 ] Attribute key without value not allowed in XML.
......@@ -71,7 +181,7 @@ Release 0.13.1 (2016-12-09)
* docutils/writers/_html_base.py
- New auxiliary module for definitions common to all HTML writers.
* docutils/writers/html5_polyglot/
- New HTML writer generating clean, polyglot_ markup conforming to
......@@ -109,9 +219,9 @@ Release 0.13.1 (2016-12-09)
- Fix [ 286 ] Empty column title cause invalid latex file.
- Fix [ 224 ] Fix rowspan support for tables.
- Let LaTeX determine the column widths in tables with "colwidths-auto".
Not suited for with multi-paragraph cells!
Not suited for multi-paragraph cells!
* docutils/writers/odf_odt/__init__.py
......
Metadata-Version: 1.1
Name: docutils
Version: 0.13.1
Version: 0.14
Summary: Docutils -- Python Documentation Utilities
Home-page: http://docutils.sourceforge.net/
Author: docutils-develop list
......
=======================
README: Docutils 0.12
README: Docutils 0.14
=======================
:Author: David Goodger
:Contact: goodger@python.org
:Date: $Date: 2014-07-07 04:36:36 +0200 (Mo, 07. Jul 2014) $
:Date: $Date: 2017-08-03 11:03:32 +0200 (Do, 03 Aug 2017) $
:Web site: http://docutils.sourceforge.net/
:Copyright: This document has been placed in the public domain.
......@@ -31,7 +31,7 @@ This is for those who want to get up & running quickly.
3. Unpack the tarball in a temporary directory (**not** directly in
Python's ``site-packages``), go to the directory created by expanding
the archive, and run ``setup.py install`` with admin rights. On
the archive, and run ``setup.py install``. On
Windows systems it may be sufficient to double-click ``install.py``.
See Installation_ below for details.
......@@ -79,17 +79,18 @@ Releases & Snapshots
====================
While we are trying to follow a "release early & often" policy,
features are added very frequently. Since the code in the Subversion
features are added frequently. Since the code in the Subversion
repository is usually in a bug-free state, we recommend that you use
the current snapshot (which is usually updated within an hour of
changes being committed to the repository):
a current snapshot.
* Snapshot of Docutils code, documentation, front-end tools, and
tests:
http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/docutils/?view=tar
To get a snapshot, go to the code page and click the download snapshot
button:
* Snapshot of the Sandbox (experimental, contributed code):
http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/sandbox/?view=tar
* Docutils code, documentation, front-end tools, and tests:
https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/
* Sandbox (experimental, contributed code):
https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/sandbox/
To keep up to date on the latest developments, download fresh copies of
the snapshots regularly or use a working copy of the
......@@ -103,7 +104,7 @@ Requirements
To run the code, Python_ must be installed.
Docutils is compatible with Python versions from 2.4 up to 2.7 and
versions 3.1 and 3.2 (cf. `Python 3 compatibility`_).
versions 3.1 to 3.5 (cf. `Python 3 compatibility`_).
Docutils uses the following packages for enhanced functionality, if they are
installed:
......@@ -138,9 +139,6 @@ translation for `porting to Python 3`_.
* When editing the source, do changes on the Python 2 versions of the
files and re-run the build command.
Using Docutils with Python 3.x is less tested and might still have some
issues.
.. _porting to Python 3: http://docs.python.org/py3k/howto/pyporting.html
......@@ -353,8 +351,8 @@ depend on the computer running the tests. The difference between the
two times represents the time required to set up the tests (import
modules, create data structures, etc.).
If any of the tests fail, please `open a bug report`_, `send email`_,
or post a message via the `web interface`_ (see `Bugs <BUGS.html>`_).
If any of the tests fail, please `open a bug report`_ or `send an email`_
(see `Bugs <BUGS.html>`_).
Please include all relevant output, information about your operating
system, Python version, and Docutils version. To see the Docutils
version, use one of the ``rst2*`` front ends or ``tools/quicktest.py``
......@@ -372,10 +370,9 @@ Windows users type these commands::
.. _Docutils Testing: http://docutils.sourceforge.net/docs/dev/testing.html
.. _open a bug report:
http://sourceforge.net/p/docutils/bugs/
.. _send email: mailto:docutils-users@lists.sourceforge.net
.. _send an email: mailto:docutils-users@lists.sourceforge.net
?subject=Test%20suite%20failure
.. _web interface: http://post.gmane.org/post.php
?group=gmane.text.docutils.user&subject=Test+suite+failure
.. _web interface: https://sourceforge.net/p/docutils/mailman/
Getting Help
......
.. -*- coding: utf-8 -*-
========================
Docutils Release Notes
========================
:Contact: grubert@users.sourceforge.net
:Maintainer: docutils-develop@lists.sourceforge.net
:Date: $Date: 2016-12-09 10:48:58 +0100 (Fr, 09. Dez 2016) $
:Revision: $Revision: 7985 $
:Date: $Date: 2017-08-03 11:01:16 +0200 (Do, 03 Aug 2017) $
:Revision: $Revision: 8147 $
:Web site: http://docutils.sourceforge.net/
:Copyright: This document has been placed in the public domain.
This document summarizes the major changes in recent releases. For a
more detailed list of changes, please see the `Docutils History`_.
This document summarizes the major changes in recent and upcoming releases.
For a more detailed list of changes, please see the `Docutils History`_.
.. _Docutils History: HISTORY.html
......@@ -20,43 +22,99 @@ more detailed list of changes, please see the `Docutils History`_.
Future changes
==============
* remove the `handle_io_errors` option from io.FileInput/Output.
* Drop support for Python 2.4, 2.5, 3.1, and 3.2 immediately after the 0.14
release.
* Remove the `handle_io_errors` option from io.FileInput/Output.
Used by Sphinx up to version 1.3.1, fixed in 1.3.2 (Nov 29, 2015).
* The default HTML writer "html" with frontend ``rst2html.py`` may change
from "html4css1" to "html5".
Use `get_writer_by_name('html')` or the rst2html.py_ front end, if you
want the output to be up-to-date automatically.
Use a specific writer name or front end, if you depend on stability of the
generated HTML code, e.g. because you use a custom style sheet or
post-processing that may break otherwise.
.. _rst2html.py: docs/user/tools.html#rst2html-py
Release 0.14 (2017-08-03)
=========================
As rc2.
* docutils/docs/ref/docutils.dtd:
- Enable validation of Docutils XML documents against the DTD:
* docutils/parsers/rst/:
- Added functionality: escaped whitespace in URI contexts.
- Consistent handling of all whitespace characters in inline markup
recognition. (May break documents that relied on some whitespace
characters (NBSP, ...) *not* to be recognized as whitespace.)
.. used by Sphinx up to version 1.3.1,
see https://github.com/sphinx-doc/sphinx/issues/1834
* docutils/utils/smartquotes.py:
* »Prune« the doctree (no change to the reST input syntax):
- Update quote definitions for et, fi, fr, ro, sv, tr, uk.
- Add quote definitions for hr, hsb, hu, lv, sh, sl, sr.
- Differentiate apostrophe from closing single quote (if possible).
- Add command line interface for stand-alone use (requires 2.7).
- "doctest" element -> literal block with "pycon" (python-console)
class argument and syntax highlight (like the "code" directive),
- special admonitions (note, hint, warning, ...) -> generic "admonition"
element with class attribute and auto-generated title.
* docutils/writers/_html_base:
- Provide default title in metadata.
- The MathJax CDN shut down on April 30, 2017. For security reasons, we
don't use a third party public installation as default but warn
if `math-output` is set to MathJax without specifying a URL.
See math-output_ for details.
* docutils/writers/html4css1:
- Respect automatic table column sizing.
* docutils/writers/latex2e/__init__.py
- Handle class arguments for block-level elements by wrapping them
in a "DUclass" environment. This replaces the special handling for
"epigraph" and "topic" elements.
* docutils/writers/odf_odt:
- Language option sets ODF document's default language
- Image width, scale, ... set image size in generated ODF.
* tools/
- New front-end ``rst2html4.py``.
* Drop support for python 2.4 after release 0.13.
Release 0.13.1 (2016-12-09)
===========================
* docutils/writers/html_plain
* docutils/writers/html5_polyglot
- New HTML writer generating `HTML 5`_.
.. _HTML 5: http://www.w3.org/TR/html5/
* tools/
- New front-end ``rst2html5.py``.
.. _HTML 5: http://www.w3.org/TR/html5/
* languages: persian/farsi and latvian/la mappings.
* languages: persian/farsi (fa) and latvian (la) mappings.
* change default base url for :rfc: to http://tools.ietf.org/html/
* change default base url for :rfc: to http://tools.ietf.org/html/
* tables accept widths, a list and align
* tables accept widths, a list and align
* latex2e: Fix admonition width, remove deprecated options, better tablewidth auto, ...
* latex2e: Fix admonition width, remove deprecated options,
better tablewidth auto, ...
* rst.el : The problem with ``electric-indent-mode`` has been fixed.
* rst.el: The problem with ``electric-indent-mode`` has been fixed.
Release 0.12 (2014-07-06)
......@@ -64,6 +122,7 @@ Release 0.12 (2014-07-06)
Small changes only, release current state
Release 0.11 (2013-07-22)
=========================
......
......@@ -5,7 +5,7 @@ Acknowledgements
:Author: David Goodger
:Contact: goodger@python.org
:Date: $Date: 2015-02-09 00:21:18 +0100 (Mo, 09. Feb 2015) $
:Date: $Date: 2015-02-09 00:21:18 +0100 (Mo, 09 Feb 2015) $
:Revision: $Revision: 7784 $
:Copyright: This document has been placed in the public domain.
......
python-docutils (0.14+dfsg-1) UNRELEASED; urgency=medium
* New upstream release.
* Update debian/watch to properly mangle upstream pre-releases.
-- Dmitry Shachnev <mitya57@debian.org> Tue, 19 Sep 2017 00:17:27 +0300
python-docutils (0.13.1+dfsg-2) unstable; urgency=medium
* Backport upstream change to make the return type of get_column_widths
......
......@@ -4,7 +4,7 @@
:Author: David Goodger
:Contact: docutils-develop@lists.sourceforge.net
:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03. Jan 2012) $
:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03 Jan 2012) $
:Revision: $Revision: 7302 $
:Copyright: This document has been placed in the public domain.
......
......@@ -4,7 +4,7 @@
:Author: David Goodger
:Contact: docutils-develop@lists.sourceforge.net
:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03. Jan 2012) $
:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03 Jan 2012) $
:Revision: $Revision: 7302 $
:Copyright: This document has been placed in the public domain.
......
......@@ -4,7 +4,7 @@
:Author: David Goodger
:Contact: docutils-develop@lists.sourceforge.net
:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03. Jan 2012) $
:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03 Jan 2012) $
:Revision: $Revision: 7302 $
:Copyright: This document has been placed in the public domain.
......
......@@ -5,7 +5,7 @@
:Author: Lea Wiemann
:Contact: docutils-develop@lists.sourceforge.net
:Revision: $Revision: 7889 $
:Date: $Date: 2015-05-08 17:56:32 +0200 (Fr, 08. Mai 2015) $
:Date: $Date: 2015-05-08 17:56:32 +0200 (Fr, 08 Mai 2015) $
:Copyright: This document has been placed in the public domain.
.. _Docutils: http://docutils.sourceforge.net/
......
......@@ -4,7 +4,7 @@
:Author: David Goodger
:Contact: docutils-develop@lists.sourceforge.net
:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03. Jan 2012) $
:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03 Jan 2012) $
:Revision: $Revision: 7302 $
:Copyright: 2004 by `Enthought, Inc. <http://www.enthought.com>`_
:License: `Enthought License`_ (BSD-style)
......
......@@ -5,7 +5,7 @@
:Author: Lea Wiemann
:Contact: docutils-develop@lists.sourceforge.net
:Revision: $Revision: 7302 $
:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03. Jan 2012) $
:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03 Jan 2012) $
:Copyright: This document has been placed in the public domain.
:Abstract: This is the introduction to Docutils for all persons who
......
......@@ -4,8 +4,8 @@
:Author: David Goodger; open to all Docutils developers
:Contact: docutils-develop@lists.sourceforge.net
:Date: $Date: 2015-02-24 14:01:43 +0100 (Di, 24. Feb 2015) $
:Revision: $Revision: 7800 $
:Date: $Date: 2017-06-23 01:26:18 +0200 (Fr, 23 Jun 2017) $
:Revision: $Revision: 8123 $
:Copyright: This document has been placed in the public domain.
.. contents::
......@@ -86,8 +86,9 @@ How to make code contributions that are easily accepted:
cases are also examples and showcases for new features. See `Docutils
Testing`_ for a description of the test suite in ``docutils/test/``.
Ensure the addition works with all supported Python versions
(2.4 ... 3.4).
Ensure the addition works with all `supported Python versions`__.
__ ../../README.html#requirements
* Look at the Docutils sources to see how similar features are implemented,
learn to do it "the Docutils way".
......@@ -284,13 +285,11 @@ The "docutils" directory of the **trunk** (a.k.a. the **Docutils
core**) is used for active -- but stable, fully tested, and reviewed
-- development.
There will be at least one active **maintenance branch** at a time,
based on at least the latest feature release. For example, when
Docutils 0.5 is released, its maintenance branch will take over, and
the 0.4.x maintenance branch may be retired. Maintenance branches
will receive bug fixes only; no new features will be allowed here.
.. TODO: is this still active policy?
If we need to cut a bugfix release, we'll create a **maintenance branch**
based on the latest feature release. For example, when Docutils 0.5 is
released, this would be ``branches/docutils-0.5``, any existing 0.4.x
maintenance branches may be retired. Maintenance branches will receive bug
fixes only; no new features will be allowed here.
Obvious and uncontroversial bug fixes *with tests* can be checked in
directly to the core and to the maintenance branches. Don't forget to
......@@ -410,12 +409,10 @@ Version Numbering
Docutils version numbering uses a ``major.minor.micro`` scheme (x.y.z;
for example, 0.4.1).
**Major releases** (x.0, e.g. 1.0) will be rare, and will represent
major changes in API, functionality, or commitment. For example, as
long as the major version of Docutils is 0, it is to be considered
*experimental code*. When Docutils reaches version 1.0, the major
APIs will be considered frozen and backward compatibility will become
of paramount importance.
**Major releases** (x.0, e.g. 1.0) will be rare, and will represent major
changes in API, functionality, or commitment. When Docutils reaches version
1.0, the major APIs will be considered frozen and backward compatibility
will become of paramount importance.
Releases that change the minor number (x.y, e.g. 0.5) will be
**feature releases**; new features from the `Docutils core`_ will be
......@@ -430,7 +427,10 @@ Docutils version 0.4. Prior to version 0.4, Docutils didn't have an
official version numbering policy, and micro releases contained both
bug fixes and new features.
See also the `Docutils Release Procedure`_, `docutils.__version__` and
`docutils.__version_info__`.
.. _Docutils Release Procedure: release.html#version-numbers
Snapshots
=========
......
......@@ -5,7 +5,7 @@
:Author: David Goodger
:Contact: docutils-develop@lists.sourceforge.net
:Revision: $Revision: 7302 $
:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03. Jan 2012) $
:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03 Jan 2012) $
:Copyright: This DTD has been placed in the public domain.
:Filename: pysource.dtd
......
......@@ -4,7 +4,7 @@
:Author: David Goodger
:Contact: docutils-develop@lists.sourceforge.net
:Revision: $Revision: 7302 $
:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03. Jan 2012) $
:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03 Jan 2012) $
:Copyright: This document has been placed in the public domain.
This document explores issues around extracting and processing
......
......@@ -4,8 +4,8 @@
:Authors: David Goodger; Lea Wiemann; open to all Docutils developers
:Contact: docutils-develop@lists.sourceforge.net
:Date: $Date: 2016-07-28 09:50:29 +0200 (Do, 28. Jul 2016) $
:Revision: $Revision: 7956 $
:Date: $Date: 2017-08-03 11:00:21 +0200 (Do, 03 Aug 2017) $
:Revision: $Revision: 8146 $
:Copyright: This document has been placed in the public domain.
.. _Docutils: http://docutils.sourceforge.net/
......@@ -17,8 +17,8 @@ On the test machine python2.4, 2.5, 2.6, 2.7 and 3.2, 3.3, and 3.4
are installed.
Some in /usr/ some under /usr/local.
Assumption: If python2.6 is in /usr/bin/ than site-packages is under
/usr/local/lib/python2.6.
Assumption: If python2.6 is in /usr/bin/ then site-packages is under
/usr/local/lib/python2.6.
On new ubuntu 12.10
......@@ -39,39 +39,41 @@ On new ubuntu 12.10
Releasing
---------
Note on numbering (Feature Request #50)
Version numbers
~~~~~~~~~~~~~~~
PEP 440 specifies how release version are understood by pip and other tools.
Version numbers shall follow the `Docutils Project Policies`_ and comply
with `PEP 440`_.
The last released package of docutils was in 2014.
Especially, mark pre-releases and the repository version/snapshots as
"between" releases (cf. `Feature Request #50`_ and the discussion on
docutils-devel on May 28 2017), e.g.
If you install the version from Source it will not be overriden by version
0.13 when it is eventaully released.
| prev. release 0.13.1,
| prerelease 0.14rc1,
| [prereleases 0.14rc2, ...]
| release 0.14,
| repo/snapshots 0.15.dev
| [bugfix relases 0.14.1, ...] # branches off of the 0.14 release.
As folks have installed 0.13 from indeterminate source versions the current
version should be incremented as to allow pip to overrite a 0.13 snapshot
when the next official release.
The repository version number is always equal to the last released
version + 1, with a .dev suffix: ``<major>.<minor+1>.dev``.
(Exception: during "feature freeze" between pre-release and release it may
point to the next pre-release.)
Please increment and switch the version in setup.py to be a pre-release. e.g.
0.13.1a
.. _Docutils Project Policies: policies.html#version-numbers
.. _Feature Request #50: https://sourceforge.net/p/docutils/feature-requests/50/
.. _PEP 440: https://www.python.org/dev/peps/pep-0440/
When a version is tagged it should be changed to a non pre release and then
in the next commit incremented to the next expected version but with a pre
release added ::
0.13.1a -> Head
0.13.1 -> when tagged for release
0.13.2a -> new head after release
Additionally snapshots can be marked with the .devXXX nominclature.
These can then all be pushed to pypi.python.org and by default pip will install the latest release unless explicitly requested via the --pre flag or a version specifier docutils>=0.13.1a
Release steps
~~~~~~~~~~~~~
REWORK FOR SOURCEFORGE REPO
Steps in boldface text are *not* covered by the release script at
sandbox/infrastructure/release.sh. "Not covered" means that you aren't even
reminded of them.
.. WARNING:: Steps in boldface text are *not* covered by the release script
at sandbox/infrastructure/release.sh. "Not covered" means that you
aren't even reminded of them.
.. Note:: This document does not cover branching and tagging, but the
release script does.
......@@ -85,18 +87,46 @@ reminded of them.
* **On the Docutils-develop mailing list, announce that the release is
going to be made, update the release notes and ask for additions.**
**Announce the date of the feature freeze, at least a week away.**
Consult HISTORY.TXT for changes.