diff options
Diffstat (limited to 'sdnr')
| -rw-r--r-- | sdnr/wt/readthedocs/README.md | 4 | ||||
| -rwxr-xr-x | sdnr/wt/readthedocs/convert.sh | 31 | ||||
| -rw-r--r-- | sdnr/wt/readthedocs/src/home.rst | 34 | ||||
| -rw-r--r-- | sdnr/wt/readthedocs/src/index.rst | 14 |
4 files changed, 83 insertions, 0 deletions
diff --git a/sdnr/wt/readthedocs/README.md b/sdnr/wt/readthedocs/README.md new file mode 100644 index 000000000..9613eab0f --- /dev/null +++ b/sdnr/wt/readthedocs/README.md @@ -0,0 +1,4 @@ +SDNR/WT specific scripts to generate ReadTheDocs content + +docs - destination of documentation files to be placed in a SDNC repository +sdnr/wt/readthedocs - scripts and scr data for creation of documentation. Other sources are located in related implementation directory diff --git a/sdnr/wt/readthedocs/convert.sh b/sdnr/wt/readthedocs/convert.sh new file mode 100755 index 000000000..5ab3d7576 --- /dev/null +++ b/sdnr/wt/readthedocs/convert.sh @@ -0,0 +1,31 @@ +#!/bin/bash + +BASEDIR=$(dirname "$0")"/../../../" +PATH_HELPSERVER_RES=$BASEDIR"sdnr/wt/helpserver/provider/src/main/resources/help/" +PATH_DOC_DST=$BASEDIR"docs/" +PATH_DOC_USERDOC_DST=$PATH_DOC_DST"guides/onap-user/" + +echo "==================Find .md files in helpserver====================================" +markdown_files=$(find $PATH_HELPSERVER_RES"sdnr" -type f -iname "*.md") +echo "$markdown_files[@]" + +echo "=============Converting md to rst files==================================" +for file in ${markdown_files[@]}; do + append_name=`echo "$file" | awk -F"/" '{print $(NF-1)}'` + f="$(basename -- $file)" + if [ "${f,,}" = "readme.md" ]; then + rstfile=$append_name".rst" + else + rstfile=${f%.md}".rst" + fi + + echo "$file to $PATH_DOC_USERDOC_DST$rstfile" + pandoc -s --toc -f markdown -t rst $file > $PATH_DOC_USERDOC_DST"$rstfile" +done + +cp -r "$BASEDIR"sdnr/wt/readthedocs/src/home.rst "$BASEDIR"docs/guides/onap-user/ +cp -r "$BASEDIR"sdnr/wt/readthedocs/src/index.rst "$BASEDIR"docs/ + +echo "================Creating html==========================================" +/usr/local/bin/sphinx-build -b html $PATH_DOC_DST /home/jack/public_html/sdnr-trial/ + diff --git a/sdnr/wt/readthedocs/src/home.rst b/sdnr/wt/readthedocs/src/home.rst new file mode 100644 index 000000000..cf8b19254 --- /dev/null +++ b/sdnr/wt/readthedocs/src/home.rst @@ -0,0 +1,34 @@ + +.. contents:: + :depth: 3 +.. + +SDN controller for 'Radio' (SDN-R) +================================== + +SDN-R adds features and functionality to the OpenDaylight-based ONAP +controller 'SDN-C'. It is built on the Common Controller Framework to +control and manage wireless resources. Wireless resources are virtual +network functions (e.g. vBBU, vEPC) or physical network functions (e.g. +microwave and millimeter wave radios, eNodeB, RRH, DAS equipment). + +| SDN-R is integrated into ONAP. Therefore it is interfacing with PNFs + and VNFs and with other ONAP components, such as A&AI, DCAE and SO. +| `See abbreviations <abbreviations>`__ + +.. figure:: ./ONAP-SDN-R.png + :alt: SDN-R in ONAP + + SDN-R in ONAP + + +.. toctree:: + :maxdepth: 1 + + connect + pnfFault + pnfMaintenance + pnfConfig + pnfPerformance + pnfInventory + pnfMediator diff --git a/sdnr/wt/readthedocs/src/index.rst b/sdnr/wt/readthedocs/src/index.rst new file mode 100644 index 000000000..78f6549f7 --- /dev/null +++ b/sdnr/wt/readthedocs/src/index.rst @@ -0,0 +1,14 @@ +================= +SDN-R Online help +================= + +Below are the references for SDN-R User Documentation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + +.. toctree:: + :maxdepth: 1 + + guides/onap-user/home + guides/onap-user/faq + guides/onap-user/abbreviations |