Skip to content

Commit 4bedcb0

Browse files
committed
Switch to reStructuredText README
PyPI doesn't render markdown, it parses README.md assuming reST rules: pypi/legacy#148 which currently causes joined lines on https://pypi.python.org/pypi/manageiq-api-client-python/ Using README.rst with reST syntax is the simplest workaround.
1 parent 7be1b6c commit 4bedcb0

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md renamed to README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@ This python package provides the ManageIQ API Client library.
77
Getting Started
88
---------------
99

10-
Preparing your python virtual environment:
10+
Preparing your python virtual environment::
1111

1212
$ virtualenv venv
1313
$ source venv/bin/activate
1414
$ pip install -e . # To create an editable install of this package
1515

16-
If you want to install it directly from GitHub:
16+
If you want to install it directly from GitHub::
1717

1818
$ pip install git+https://github.com/ManageIQ/manageiq-api-client-python.git
1919

2020
To run the example present in this repository you probably need to configure
21-
your options (if different from the default shown here):
21+
your options (if different from the default shown here)::
2222

2323
$ export MIQURL=http://localhost:3000/api
2424
$ export MIQUSERNAME=admin

0 commit comments

Comments
 (0)