Skip to content

Change to Markdown for README syntax #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Change to Markdown for README syntax #11

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9a15c74
Change README to Markdown, fixes the badges.
May 28, 2014
990aee3
Clean up README.md for Proper rendering
May 28, 2014
af6ca7c
Remove a bit of RST stuff.
May 28, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions README.txt → README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,31 +13,31 @@ 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
----------

The RefactorDoc extension lives at Github. You can clone the repository
using::
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``::
2. Add refactor-doc to the extensions variable of your sphinx `conf.py`

extensions = [
...,
'refactordoc',
...,
]
extensions = [
...,
'refactordoc',
...,
]