Code Review / ric-plt / xapp-frame-py.git / commit
? search:
summary | shortlog | log | commit | commitdiff | review | tree
(parent: fbb5928) | patch
Add generated API doc to RST 21/3221/2
authorLott, Christopher (cl778h) <cl778h@att.com>
Wed, 8 Apr 2020 16:41:07 +0000 (12:41 -0400)
committerLott, Christopher (cl778h) <cl778h@att.com>
Wed, 8 Apr 2020 16:43:00 +0000 (12:43 -0400)
commit2e1c18a96f7978cc24acc157c0e53067ebd677f1
tree27a39366583facadd43ce98e4705d9fe2b5824cetree | snapshot
parentfbb5928134d64dbab8bc3e64b23c2f21e4c4be6fcommit | diff
Add generated API doc to RST

The ReadTheDocs builder will never have RMR library installed,
so it's nearly impossible to use the sphinx autodoc API generator
to extract Pydoc strings from the code.  This hack adds the
generated strings to a static file which will require manual
maintenance, poor but an improvement on zero documentation.

Issue-ID: RIC-228
Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: Icf3121c960424eb5f83eac76dbcae55d2f64624b
docs/index.rst diff | blob | history
docs/installation-guide.rst diff | blob | history
docs/overview.rst diff | blob | history
docs/rmr_api.rst diff | blob | history
"ric_plt_xapp_frame_py"