Skip to content

Use Pandoc to publish RestructuredText to PyPI #3817

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
pydanny opened this issue Jan 9, 2016 · 5 comments
Closed

Use Pandoc to publish RestructuredText to PyPI #3817

pydanny opened this issue Jan 9, 2016 · 5 comments

Comments

@pydanny
Copy link
Contributor

pydanny commented Jan 9, 2016

A little call out to Pandoc during the publish setup.py command would mean this:

screen shot 2016-01-08 at 6 49 35 pm

would look more like:

screen shot 2016-01-08 at 6 50 59 pm

If this is something wanted, I'm more than happy to make the pull request.

@jpadilla
Copy link
Member

jpadilla commented Jan 9, 2016

I'd be ok if we just had moved our README.md to reStructuredText instead. That file only changes when a new version is released.

@tomchristie
Copy link
Member

@pydanny sounds good. I'd probably rather see/review that first, before considering using .rst for the README

@mblayman
Copy link
Contributor

As reported in #4012, the pandoc reST output is not rendering properly on PyPI. PyPI doesn't really report these errors easily so here is some output that can hopefully help resolve the problem. On other projects, when I've resolved any errors from rst2html, the page starts to render properly on PyPI.

python setup.py --long-description | rst2html.py > /dev/null
<stdin>:110: (WARNING/2) Cannot analyze code. Pygments package not found.
<stdin>:145: (WARNING/2) Cannot analyze code. Pygments package not found.

Installing Pygments made the errors go away.

@xordoquy
Copy link
Collaborator

@mblayman We already have a fix for that, see the related issues list.

@mblayman
Copy link
Contributor

I ran the above command from the stable branch that includes the merged PR referenced in the issues list. I did some triage and thought this might be new information.

My apologies if you were already aware of this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants