docs/README

   1 This directory contains project documentation, most of which is
   2 generated from document source in the doc directory (proj_doc
   3 would be a better name for this directory).
   4
   5 Because this directory is "scraped" by some other process(es)
   6 which seem to be python based, and are completely unrelated to
   7 this repo, there are some files in this directory which are
   8 necessary, misterious, and somewhat fragile:
   9
  10         _static
  11         conf.py
  12         conf.yaml
  13         requirements-docs.txt
  14         index.rst
  15         favicon.ico             // checking in jpg/png is just as bad as checking a jar
  16
  17 It is also very possible that introducing a change in the files
  18 listed above will cause the vetting jobs which run on checkin,
  19 and/or merge, to fail.
  20
  21 The documentation that we place here which is generated (read
  22 don't modify it in place here as it won't be merged):
  23         config-deploy.rst
  24         developer-guide.rst
  25         rel-notes.rst
  26         user-guide.rst
  27
  28 Look for the source, along with instructions on how to compile
  29 the doc in rmr/doc/src/rtd.  Some of the source for these docs
  30 is pulled directly from the manual pages in rmr/doc/src/man.
  31