ReST formatting errors when registering package can invalidate HTML conversion
I thought I would post a generally help tip that Ian Bicking helped me with. I couldn't figure out why my ReST formatted long_description field would not get converted to HTML when I registered my egg with the cheeseshop: python setup.py register It turns out I had a minor error in my ReST formatting, I didn't underline a headline with enough length. So, the moral of the story is if you wonder why you cannot get HTML formatted ReST to display when you register your egg, it is possible you have a formatting error. It was tricky for me to discover, because I did not get any error message when I uploaded to the cheeseshop, and I just missed the minor formatting error when I was viewing the converted HTML document I used to preview what I created. Noah Gift / http://noahgift.com
I would be in favor of a warning message generated by PyPI when a long_description field is not reST compliant. I don't think it is a client-side job. In any case you can test your long_description field like this: $ python setup.py --long-description | rst2html.py --strict > /dev/null If something goes wrong in the conversion you'll get a warning here On Sun, Apr 6, 2008 at 2:19 AM, Noah Gift <noah.gift@gmail.com> wrote:
I thought I would post a generally help tip that Ian Bicking helped me with. I couldn't figure out why my ReST formatted long_description field would not get converted to HTML when I registered my egg with the cheeseshop:
python setup.py register
It turns out I had a minor error in my ReST formatting, I didn't underline a headline with enough length. So, the moral of the story is if you wonder why you cannot get HTML formatted ReST to display when you register your egg, it is possible you have a formatting error. It was tricky for me to discover, because I did not get any error message when I uploaded to the cheeseshop, and I just missed the minor formatting error when I was viewing the converted HTML document I used to preview what I created.
Noah Gift / http://noahgift.com
_______________________________________________ Distutils-SIG maillist - Distutils-SIG@python.org http://mail.python.org/mailman/listinfo/distutils-sig
-- Tarek Ziadé | Association AfPy | www.afpy.org Blog FR | http://programmation-python.org Blog EN | http://tarekziade.wordpress.com/
+1 I eventually found it just the way you describe Tarek, and with Ian's suggestion. On Sun, Apr 6, 2008 at 5:02 AM, Tarek Ziadé <ziade.tarek@gmail.com> wrote:
I would be in favor of a warning message generated by PyPI when a long_description field is not reST compliant. I don't think it is a client-side job.
In any case you can test your long_description field like this:
$ python setup.py --long-description | rst2html.py --strict > /dev/null
If something goes wrong in the conversion you'll get a warning here
On Sun, Apr 6, 2008 at 2:19 AM, Noah Gift <noah.gift@gmail.com> wrote:
I thought I would post a generally help tip that Ian Bicking helped me with. I couldn't figure out why my ReST formatted long_description field would not get converted to HTML when I registered my egg with the cheeseshop:
python setup.py register
It turns out I had a minor error in my ReST formatting, I didn't underline a headline with enough length. So, the moral of the story is if you wonder why you cannot get HTML formatted ReST to display when you register your egg, it is possible you have a formatting error. It was tricky for me to discover, because I did not get any error message when I uploaded to the cheeseshop, and I just missed the minor formatting error when I was viewing the converted HTML document I used to preview what I created.
Noah Gift / http://noahgift.com
_______________________________________________ Distutils-SIG maillist - Distutils-SIG@python.org http://mail.python.org/mailman/listinfo/distutils-sig
-- Tarek Ziadé | Association AfPy | www.afpy.org Blog FR | http://programmation-python.org Blog EN | http://tarekziade.wordpress.com/
participants (2)
-
Noah Gift -
Tarek Ziadé