fix README.rst so it renders correctly on PyPI
This commit is contained in:
parent
0eabad14f6
commit
73d73d3c4e
|
@ -34,7 +34,7 @@ Changelog
|
|||
[cewing, xiru, winstonf88]
|
||||
|
||||
.. note::
|
||||
this change fixes a bug in the earlier implementation that could cause
|
||||
This change fixes a bug in the earlier implementation that could cause
|
||||
errors in some situations. This situation will only arise if the userid and
|
||||
username for a user are not the same. If membrane is being used for content-
|
||||
based user objects, or if email-as-login is enabled *and* a user has changed
|
||||
|
|
17
README.rst
17
README.rst
|
@ -1,6 +1,12 @@
|
|||
plone.api
|
||||
=========
|
||||
|
||||
* `Documentation @ api.plone.org <http://api.plone.org>`_
|
||||
* `Source code @ GitHub <http://github.com/plone/plone.api>`_
|
||||
* `Issues @ GitHub <http://github.com/plone/plone.api/issues>`_
|
||||
* `Continuous Integration @ Travis CI <http://travis-ci.org/plone/plone.api>`_
|
||||
* `Code Coverage @ Coveralls.io <http://coveralls.io/r/plone/plone.api>`_
|
||||
|
||||
.. topic:: Overview
|
||||
|
||||
The ``plone.api`` is an elegant and simple API, built for humans wishing
|
||||
|
@ -10,17 +16,6 @@ plone.api
|
|||
for doing common development tasks in Plone. Recipes try to assume the user
|
||||
does not have extensive knowledge about Plone internals.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<img src="http://travis-ci.org/plone/plone.api.png?&branch=master">
|
||||
<img src="http://coveralls.io/repos/plone/plone.api/badge.png">
|
||||
|
||||
* `Documentation @ api.plone.org <http://api.plone.org>`_
|
||||
* `Source code @ GitHub <http://github.com/plone/plone.api>`_
|
||||
* `Issues @ GitHub <http://github.com/plone/plone.api/issues>`_
|
||||
* `Continuous Integration @ Travis CI <http://travis-ci.org/plone/plone.api>`_
|
||||
* `Code Coverage @ Coveralls.io <http://coveralls.io/r/plone/plone.api>`_
|
||||
|
||||
The intention of this package is to provide clear API methods for Plone
|
||||
functionality which may be confusing or difficult to access. As the underlying
|
||||
code improves some API methods may be deprecated and the documentation here
|
||||
|
|
Reference in New Issue