Add README.

thewtex · Feb 12, 2012 · 759c784 · 759c784
1 parent 6235363
commit 759c784
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -0,0 +1,8 @@
+===========
+breathelink
+===========
+
+A sphinx extension that creates a new directive to simultaneously call the
+breathe_ `doxygenclass` directive and a doxylink_ role to import doxygen class
+documentation and create a link to the full class documentation.  The new
+directive `breathelink` also creates an index entry.
diff --git a/__init__.py b/__init__.py
@@ -0,0 +1 @@
+from breathelink import *
diff --git a/breathelink.py b/breathelink.py