1. Tarek Ziadé
  2. hitchhiker-guide-packaging
  3. Issues
Issue #28 new

expand on the use of markdown

Anonymous created an issue

Increasingly, developers are turning to markdown to write all their docs (particularly web-friendly README.md's).

It would be great to see the author expand on his use of Markdown, particularly for READMEs that are PYPI compatible.

The best solution I've seen so far is:



in setup.py

import pypandoc

readme = pypandoc.convert('README.md', 'rst')

setup( ... long_description=readme, ... )


But this is problematic for others who do not have pandoc and pypandoc installed.

Comments (0)

  1. Log in to comment