From 9a15c7446db9b5ae7dd7edd22f340d6ff173bd07 Mon Sep 17 00:00:00 2001 From: Pradyun Date: Wed, 28 May 2014 17:18:57 +0530 Subject: [PATCH 1/3] Change README to Markdown, fixes the badges. --- README.txt => README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README.txt => README.md (100%) diff --git a/README.txt b/README.md similarity index 100% rename from README.txt rename to README.md From 990aee38c4b4898a119a6d7792c3124f9a1590b2 Mon Sep 17 00:00:00 2001 From: Pradyun Date: Wed, 28 May 2014 17:26:11 +0530 Subject: [PATCH 2/3] Clean up README.md for Proper rendering --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 5fb7e99..e63b9fd 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,10 @@ original form of the docstring. Key aims of RefactorDoc are: - - Do not change the order of sections. - - Allow sphinx directives between (and inside) section blocks. - - Easier to debug (native support for debugging) and extend - (future versions). + - Do not change the order of sections. + - Allow sphinx directives between (and inside) section blocks. + - Easier to debug (native support for debugging) and extend + (future versions). Repository ---------- @@ -24,20 +24,20 @@ Repository The RefactorDoc extension lives at Github. You can clone the repository using:: - $ git clone https://github.com/enthought/refactordoc.git + $ git clone https://github.com/enthought/refactordoc.git Installation ------------ -1. Install ``refactordoc`` from pypi using pip:: +1. Install ``refactordoc`` from pypi using pip - $ pip install reafactordoc + $ pip install reafactordoc 2. Add refactor-doc to the extensions variable of your sphinx ``conf.py``:: - extensions = [ - ..., - 'refactordoc', - ..., - ] + extensions = [ + ..., + 'refactordoc', + ..., + ] From af6ca7cb6aef506961b84a46dea0bcf4f06c6d0a Mon Sep 17 00:00:00 2001 From: Pradyun Date: Thu, 29 May 2014 00:14:51 +0530 Subject: [PATCH 3/3] Remove a bit of RST stuff. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e63b9fd..f14b5f8 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Repository ---------- The RefactorDoc extension lives at Github. You can clone the repository -using:: +using $ git clone https://github.com/enthought/refactordoc.git @@ -30,11 +30,11 @@ using:: Installation ------------ -1. Install ``refactordoc`` from pypi using pip +1. Install `refactordoc` from pypi using pip $ pip install reafactordoc -2. Add refactor-doc to the extensions variable of your sphinx ``conf.py``:: +2. Add refactor-doc to the extensions variable of your sphinx `conf.py` extensions = [ ...,