Add root level docs control files

[ric-plt/lib/rmr.git] / doc / src / rtd / README

diff --git a/doc/src/rtd/README b/doc/src/rtd/README
index b6f4acd..c7dd309 100644 (file)
--- a/doc/src/rtd/README
+++ b/doc/src/rtd/README
@@ -15,3 +15,11 @@ single make.  While it is possible to convert X to Y, a true document
 composition language is far better at geneating readable Postscript
 output with embedded figures as well as text and tables. 
 
+CAUTION:
+The RST syntax is as bad as python when it comes to dealing with
+spaces.  For example &bold( foo ) will insert spaces after the initial
+bold trigger, and before the trailing bold trigger which will throw
+the tox validation into a tizzy.  Further,  something like 'void *' 
+and 'rmr_ '  does as well.  If needed, use the defined escape macro
+to add an escape in such situations; it should only generate for RST
+and not impact other output formats.