Documentation changes needed to support RTD 88/1388/3
authorE. Scott Daniels <daniels@research.att.com>
Wed, 6 Nov 2019 20:12:38 +0000 (15:12 -0500)
committerE. Scott Daniels <daniels@research.att.com>
Wed, 6 Nov 2019 20:28:15 +0000 (15:28 -0500)
commit392168d467d7949f391602f53f9fd62d2a64d12b
tree13043beac5a65ada4480f5bd9a2a8effd6ee17f7
parent3879c38814010dfbbb896a9fc6492bff48c9b77a
Documentation changes needed to support RTD

Changes which are necessary to support a docs directory that
is scraped for "read the docs."  Changes include:

Tweaks to manual pages to allow them to be combined into a
large "user's guide" (removed the final quit command).

Addition of an rtd subidrectory under source and the needed
.xfm source to generate the various .rst files in the top
level docs (plural).

Moved the top level readme to the main source directory as
it was out of place at the top; created a new top level README.

Signed-off-by: E. Scott Daniels <daniels@research.att.com>
Change-Id: I708a750e3c58df4d0446eb3a5706c10bf65bed1d
63 files changed:
README
doc/README
doc/src/man/rmr.7.xfm
doc/src/man/rmr_alloc_msg.3.xfm
doc/src/man/rmr_bytes2meid.3.xfm
doc/src/man/rmr_bytes2payload.3.xfm
doc/src/man/rmr_bytes2xact.3.xfm
doc/src/man/rmr_call.3.xfm
doc/src/man/rmr_close.3.xfm
doc/src/man/rmr_free_msg.3.xfm
doc/src/man/rmr_get_meid.3.xfm
doc/src/man/rmr_get_rcvfd.3.xfm
doc/src/man/rmr_get_src.3.xfm
doc/src/man/rmr_get_srcip.3.xfm
doc/src/man/rmr_get_trace.3.xfm
doc/src/man/rmr_get_trlen.3.xfm
doc/src/man/rmr_get_xact.3.xfm
doc/src/man/rmr_init.3.xfm
doc/src/man/rmr_init_trace.3.xfm
doc/src/man/rmr_mt_call.3.xfm
doc/src/man/rmr_mt_rcv.3.xfm
doc/src/man/rmr_payload_size.3.xfm
doc/src/man/rmr_rcv_msg.3.xfm
doc/src/man/rmr_ready.3.xfm
doc/src/man/rmr_realloc_payload.3.xfm
doc/src/man/rmr_rts_msg.3.xfm
doc/src/man/rmr_send_msg.3.xfm
doc/src/man/rmr_set_stimeout.3.xfm
doc/src/man/rmr_set_trace.3.xfm
doc/src/man/rmr_str2meid.3.xfm
doc/src/man/rmr_str2xact.3.xfm
doc/src/man/rmr_support.3.xfm
doc/src/man/rmr_torcv_msg.3.xfm
doc/src/man/rmr_trace_ref.3.xfm
doc/src/man/rmr_tralloc_msg.3.xfm
doc/src/man/rmr_wh_close.3.xfm
doc/src/man/rmr_wh_open.3.xfm
doc/src/man/rmr_wh_send_msg.3.xfm
doc/src/man/setup.im
doc/src/rst.im
doc/src/rtd/Makefile [new file with mode: 0644]
doc/src/rtd/README [new file with mode: 0644]
doc/src/rtd/config-deploy.xfm [new file with mode: 0644]
doc/src/rtd/developer-guide.xfm [new file with mode: 0644]
doc/src/rtd/fmt_changes.ksh [new file with mode: 0644]
doc/src/rtd/license.im [new file with mode: 0644]
doc/src/rtd/overview.xfm [new file with mode: 0644]
doc/src/rtd/setup.im [new file with mode: 0644]
doc/src/rtd/user-guide.xfm [new file with mode: 0644]
docs/.gitignore [new file with mode: 0644]
docs/README [new file with mode: 0644]
docs/conf.py [new file with mode: 0644]
docs/conf.yaml [new file with mode: 0644]
docs/config-deploy.rst [new file with mode: 0644]
docs/developer-guide.rst [new file with mode: 0644]
docs/favicon.ico [new file with mode: 0644]
docs/index.rst [new file with mode: 0644]
docs/overview.rst [new file with mode: 0644]
docs/rel-notes.rst [new file with mode: 0644]
docs/release-notes.rst [new file with mode: 0644]
docs/requirements-docs.txt [new file with mode: 0644]
docs/user-guide.rst [new file with mode: 0644]
src/rmr/README [new file with mode: 0644]