summaryrefslogtreecommitdiffstats
path: root/python/breathe/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/breathe/README')
-rw-r--r--python/breathe/README5
1 files changed, 5 insertions, 0 deletions
diff --git a/python/breathe/README b/python/breathe/README
new file mode 100644
index 0000000000..74d1dd08cf
--- /dev/null
+++ b/python/breathe/README
@@ -0,0 +1,5 @@
+Breathe is a sphinx plugin providing beautiful integrated
+doxygen output in your user-facing documentation.It allows
+you to combine doxygen's excellent technical understanding
+of your codebase with the superb long form documentation
+output of the sphinx system.