docs/dev/wheeling.txt

   1 ===========================
   2  Docutils_ Building Wheels
   3 ===========================
   4
   5 :Authors: engelbert gruber; open to all Docutils developers
   6 :Contact: docutils-develop@lists.sourceforge.net
   7 :Date: $Date$
   8 :Revision: $Revision$
   9 :Copyright: This document has been placed in the public domain.
  10
  11 .. _Docutils: http://docutils.sourceforge.net/
  12
  13 .. contents::
  14
  15 Abstract
  16 --------
  17
  18 This document documents my trial to build python wheels from
  19 docutils. Once it is finished it might be driven into distribution or
  20 release documentation.
  21
  22 Requests
  23 --------
  24
  25 There is `feature request 43`_ :  Make setup.py build wheels.
  26
  27   Just add this to setup.cfg:
  28
  29   [bdist_wheel]
  30   universal = 1
  31
  32   See https://packaging.python.org/en/latest/distributing.html#universal-wheels
  33
  34   -.-.-
  35
  36   Docutils is not fit for Universal Wheels. Docutils supports both Python 2 and
  37   3, but with different code (we use “2to3”). This would make it a candidate
  38   for "Pure Python wheels".
  39
  40   https://packaging.python.org/en/latest/distributing.html#pure-python-wheels
  41
  42 and bugs275_ : Upload wheels to pypi
  43
  44   Currently docutils does not publish any wheels on pypi. Wheels make docutils
  45   faster to install (no need to run setup.py, which for a large number of
  46   packages can take some time), and is no more difficult than uploading an
  47   sdist (see https://packaging.python.org/en/latest/distributing.html#wheels
  48   for instructions).
  49
  50 Logbook
  51 -------
  52
  53
  54 .. _bugs275: https://sourceforge.net/p/docutils/bugs/275/
  55 .. _feature request 43: https://sourceforge.net/p/docutils/feature-requests/43/
  56