Path: csiph.com!usenet.pasdenom.info!gegeweb.org!usenet-fr.net!nerim.net!novso.com!newsfeed.xs4all.nl!newsfeed4.news.xs4all.nl!xs4all!post.news.xs4all.nl!not-for-mail Return-Path: X-Original-To: python-list@python.org Delivered-To: python-list@mail.python.org X-Spam-Status: OK 0.012 X-Spam-Evidence: '*H*': 0.98; '*S*': 0.00; 'url:pypi': 0.03; 'skip:[ 20': 0.04; 'pypi': 0.07; 'utf-8': 0.07; 'interpreted': 0.09; 'setup.py': 0.09; 'subject:How': 0.10; 'cc:addr:python-list': 0.11; 'directive': 0.16; 'exiting': 0.16; 'formatted': 0.16; 'garbage': 0.16; 'path:': 0.16; 'readme.rst': 0.16; 'subject:pypi': 0.16; 'sat,': 0.16; 'do,': 0.16; 'wrote:': 0.18; 'example': 0.22; 'cc:addr:python.org': 0.22; 'specify': 0.24; 'file.': 0.24; 'cc:2**0': 0.24; 'cc:no real name:2**0': 0.24; '(see': 0.26; 'header:In-Reply-To:1': 0.27; 'rest': 0.29; 'chris': 0.29; 'am,': 0.29; 'message-id:@mail.gmail.com': 0.30; 'url:mailman': 0.30; 'sep': 0.31; 'file': 0.32; 'text': 0.33; 'url:python': 0.33; 'role': 0.34; 'sense': 0.34; 'message.': 0.35; 'but': 0.35; 'received:google.com': 0.35; 'there': 0.35; '14,': 0.36; 'url:listinfo': 0.36; 'subject:?': 0.36; 'url:org': 0.36; 'problems': 0.38; 'files': 0.38; 'url:mail': 0.40; 'how': 0.40; 'url:3': 0.61; 'from:charset:utf-8': 0.61; 'show': 0.63; 'such': 0.63; 'field': 0.63; 'skip:\xe2 10': 0.65; 'to:addr:gmail.com': 0.65; 'due': 0.66; '8bit%:43': 0.74; 'inline': 0.74; 'directory:': 0.84; 'michel': 0.84; 'albert': 0.91; 'url:tk': 0.95; '2013': 0.98 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :cc:content-type:content-transfer-encoding; bh=KZb6c+GalbeX7uhuqYWLHyyKxtyAw+Xbn+P9eBPKBV8=; b=xrQt6e25QWwcBw8BRyBBi9mQwG/Ut76Y9OE71ostJtDN4Xig23oJl5IW3Z7Xz/y3XE PT2YUPrEP9I2rQKALPHkutSjg3PO2xxLUcxKifqDJjZ2b0GuMtudHcKUFaywvFCIm7fK lzBRCKkbvf9dAmE3+Op5gWfsdRXZPmRlzKQaaJ8SJ2Uy7cnqcaHDcwefh1FN9jTcxBuP Jzgta+ZyaIsST7VkPYweiysOc+57eLd+xtaqjcbA2/rlD6a5wq6MY6mOCLKjiyXbjgdc rJ4Obu86L9/S1YG51gmCCahJL0aUYa+2xwgVcoCTsuf21jeDBTKCrdh+EBq8tuXjh89o UEsQ== MIME-Version: 1.0 X-Received: by 10.221.47.193 with SMTP id ut1mr16393941vcb.8.1379152392648; Sat, 14 Sep 2013 02:53:12 -0700 (PDT) In-Reply-To: <950cde69-932e-4ba2-b473-c7f7e9892e2d@googlegroups.com> References: <950cde69-932e-4ba2-b473-c7f7e9892e2d@googlegroups.com> Date: Sat, 14 Sep 2013 11:53:12 +0200 Subject: Re: How to display ReST properly on pypi? From: =?UTF-8?B?Q2hyaXMg4oCcS3dwb2xza2HigJ0gV2Fycmljaw==?= To: Michel Albert Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Cc: python-list@python.org X-BeenThere: python-list@python.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: General discussion list for the Python programming language List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Newsgroups: comp.lang.python Message-ID: Lines: 31 NNTP-Posting-Host: 2001:888:2000:d::a6 X-Trace: 1379152396 news.xs4all.nl 15960 [2001:888:2000:d::a6]:43451 X-Complaints-To: abuse@xs4all.nl Xref: csiph.com comp.lang.python:54160 On Sat, Sep 14, 2013 at 11:08 AM, Michel Albert wrote: > In general, I write my README files using the ReST syntax. But when I do,= they don't show up formatted on pypi (see for example https://pypi.python.= org/pypi/config_resolver/3.3.0). > > How do I get it to be formatted properly? > > Also, is there a way to specify that the "description" field in setup.py = is formatted as ReST? > -- > https://mail.python.org/mailman/listinfo/python-list rst2html crashes with your file. Also, `py:class` is Sphinx-only and won=E2=80=99t work with the Cheeseshop and produce garbage in the output. [kwpolska@kwpolska-lin config_resolver-3.3.0]% rst2html README.rst README.rst:67: (WARNING/2) Inline emphasis start-string without end-string. README.rst:108: (ERROR/3) Unknown interpreted text role "py:class". README.rst:115: (ERROR/3) Unknown interpreted text role "py:class". README.rst:121: (ERROR/3) Unknown interpreted text role "py:class". README.rst:142: (SEVERE/4) Problems with "include" directive path: InputError: [Errno 2] No such file or directory: 'CHANGES'. Exiting due to level-4 (SEVERE) system message. [kwpolska@kwpolska-lin config_resolver-3.3.0]% echo $? 1 [kwpolska@kwpolska-lin config_resolver-3.3.0]% --=20 Chris =E2=80=9CKwpolska=E2=80=9D Warrick PGP: 5EAAEA16 stop html mail | always bottom-post | only UTF-8 makes sense