Scikit-optimize: Rewrite README.md using restructured text so that it renders nicely on the PyPi page

Created on 30 May 2017  路  5Comments  路  Source: scikit-optimize/scikit-optimize

All 5 comments

I suggest to use pandoc to (possibly automatically) convert the README.md file (as displayed on GitHub) to a README.rst file (to be displayed on PyPi).

I think pypi uses the value of the long_description in setup.py so we also need to modify that to be something like open('README.rst').read().

For dib-lab/khmer we recently switched (back to) rst: https://github.com/dib-lab/khmer/pull/1696 for exactly this reason :)

Exactly. Can someone with write access do this change, instead of a PR, please?

(I remember seeing a large project where the setup.py file used pandoc Python interface to convert the README.md to rST on the fly... but that's way too heavy I think -- and I cannot find it again!)

I can make a PR later to change the README and change the setup.py.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

glouppe picture glouppe  路  6Comments

Atarust picture Atarust  路  3Comments

nunocesarsa picture nunocesarsa  路  6Comments

betatim picture betatim  路  3Comments

tritemio picture tritemio  路  4Comments