Skip to content

Commit b85b08a

Browse files
committed
README.rst: Add a lot more detail
1 parent ebe1f39 commit b85b08a

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

‎README.rst‎

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,32 @@
11
pydocverter
22
===========
33

4-
Python client for Docverter service
4+
Python client for [Docverter][] service
5+
6+
[Docverter][] is a hosted service
7+
that can do convert documents from one format to another (using [pandoc][]).
8+
For example, it can be used to convert [Markdown][] documents to [reStructuredText][].
9+
This is very useful if you prefer to write your `README` in Markdown,
10+
but want to publish your package to PyPI,
11+
which only knows how to do nice rendering of descriptions
12+
written in reStructuredText.
13+
14+
This module is a Python client to the Docverter service.
15+
16+
It has a very similar API to that of [pypandoc][], so that you can do stuff like:
17+
18+
.. code-block:: python
19+
20+
try:
21+
import pypandoc as converter
22+
except ImportError:
23+
import pydocverter as converter
24+
25+
converter.convert('somefile.md', 'rst')
26+
27+
28+
[Docverter]: http://www.docverter.com/
29+
[pandoc]: http://johnmacfarlane.net/pandoc
30+
[Markdown]: http://daringfireball.net/projects/markdown/
31+
[reStructuredText]: http://docutils.sourceforge.net/rst.html
32+
[pypandoc]: https://github.com/bebraw/pypandoc

0 commit comments

Comments
 (0)