summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2014-12-18 16:01:51 -0500
committerDoug Hellmann <doug@doughellmann.com>2014-12-18 16:01:51 -0500
commit9324bf0b675160f6eb4099d17231e289b68097be (patch)
treeb447b86328c5bf3e755899e6728801f72855be73
parent6462f163f1c81aca2c59191b9d97633edad10347 (diff)
downloadstevedore-9324bf0b675160f6eb4099d17231e289b68097be.tar.gz
Fix the README.rst file format for pypi
PyPI uses vanila docutils instead of sphinx to render the README to HTML, so we need to be careful about what directives and roles we use. Change-Id: I92ba44ada0d055d1ca8cc6c950cc2d2d201bf7f3
-rw-r--r--README.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index 9a40f4f..57167c7 100644
--- a/README.rst
+++ b/README.rst
@@ -1,12 +1,12 @@
-=============================================================
- stevedore -- Manage dynamic plugins for Python applications
-=============================================================
+===========================================================
+stevedore -- Manage dynamic plugins for Python applications
+===========================================================
Python makes loading code dynamically easy, allowing you to configure
and extend your application by discovering and loading extensions
("*plugins*") at runtime. Many applications implement their own
-library for doing this, using ``__import__`` or
-:mod:`importlib`. stevedore avoids creating yet another extension
+library for doing this, using ``__import__`` or ``importlib``.
+stevedore avoids creating yet another extension
mechanism by building on top of `setuptools entry points`_. The code
for managing entry points tends to be repetitive, though, so stevedore
provides manager classes for implementing common patterns for using