Use pandoc to convert md to rst#438
Conversation
| ============= | ||
|
|
||
| [Documentation for the Riak Python Client Library](http://basho.github.io/riak-python-client/index.html) is available here. The documentation source is found in [`docs/` subdirectory](https://github.com/basho/riak-python-client/tree/master/docs) and can be built with [Sphinx](http://sphinx.pocoo.org/). | ||
| [Documentation for the Riak Python Client Library](http://basho.github.io/riak-python-client/index.html) is available [here](http://basho.github.io/riak-python-client/index.html). |
There was a problem hiding this comment.
rst barfed on the pre-formatted text within the hyperlink.
Add pandoc check to Makefile Add pypandoc check to Makefile
|
@javajolt - FYI wiki is updated https://github.com/basho/riak-python-client/wiki/Releasing-the-Python-Client |
lukebakken
force-pushed
the
fixes/lrb/fix-pypi-documentation
branch
from
83db97b to
0e1ced8
Compare
|
While we are mucking with READMEs, could we update some of the docs links? For example, the 2i link is to the 2.0.0 release. Thinking it should be http://docs.basho.com/riak/latest/dev/using/2i/. |
|
@javajolt working on that now |
lukebakken
force-pushed
the
fixes/lrb/fix-pypi-documentation
branch
from
0e1ced8 to
827787f
Compare
|
@javajolt links in the README should all be fixed, good catch on that. |
| tests_require=tests_require, | ||
| package_data={'riak': ['erl_src/*']}, | ||
| description='Python client for Riak', | ||
| long_description=long_description, |
There was a problem hiding this comment.
I assume I'd actually have to do a release to see this work?
There was a problem hiding this comment.
Yep, but you can see it here too:
https://testpypi.python.org/pypi?:action=display&name=riak&version=2.4.2
That's from pushing to the test pypi site with the fix.
|
👍 827787f |
Use pandoc to convert md to rst Reviewed-by: javajolt
Use pandoc to convert md to rst
3 participants
I'll update the Wiki to list
pandocas a requirement:https://github.com/basho/riak-python-client/wiki/Releasing-the-Python-Client