Add wormhole state check function

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

diff --git a/doc/src/rtd/README b/doc/src/rtd/README
index b6f4acd..0adb444 100644 (file)
--- a/doc/src/rtd/README
+++ b/doc/src/rtd/README
@@ -6,7 +6,13 @@ it is not good practice, the generated .rst files must be checked into
 the repo and committed with changes to the source.  
 
 The command 'make all' should be all that is needed to build the 
-rtd documentation.
+rtd documentation. Follow that with 'make publish' to actually move
+the .rst files into the docs directory at the root; only the changed
+files are moved.
+
+Adding A New Man Page
+WHen a new manual page is added to the source (../man), it must be 
+added to the list in the user's guide source in this directory.
 
 Rationale
 Documentation is just code, and by maintaining the documentation as
@@ -15,3 +21,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.