From: Youhwan Seol Date: Mon, 17 Apr 2023 09:54:47 +0000 (+0900) Subject: Added initial docs format X-Git-Tag: 1.0.0~36 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=4fb1ceb5de5bb43e398df85506236f0787e19873;p=aiml-fw%2Faihp%2Fips%2Fkserve-adapter.git Added initial docs format Change-Id: Iee015ad3fd1c1fb44d6974d40ade0d97fccdc5b8 Signed-off-by: Youhwan Seol --- diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9c14461 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +# documentation +.tox +docs/_build/ diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..fba6092 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,17 @@ +--- +version: 2 + +formats: + - htmlzip + +build: + image: latest + +python: + version: 3.7 + install: + - requirements: docs/requirements-docs.txt + +sphinx: + configuration: docs/conf.py + \ No newline at end of file diff --git a/docs/_static/logo.png b/docs/_static/logo.png new file mode 100755 index 0000000..3803e04 Binary files /dev/null and b/docs/_static/logo.png differ diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..b0c8a2a --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,24 @@ +# ================================================================================== +# +# Copyright (c) 2023 Samsung Electronics Co., Ltd. All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# ================================================================================== + +from docs_conf.conf import * +linkcheck_ignore = [ + 'http://localhost.*', + 'http://127.0.0.1.*', + 'https://gerrit.o-ran-sc.org.*' +] diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..1c3c03b --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,6 @@ +--- +project_cfg: oran +project: aiml-fw/aihp/ips/kserve-adapter + +# Change this to ReleaseBranchName to modify the header +version: latest diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100755 index 0000000..00b0fd0 Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..2458914 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,18 @@ + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-B +.. Copyright (c) 2023 Samsung Electronics Co., Ltd. All Rights Reserved. + +Welcome to Kserve Adapter for AIML Framework + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + overview.rst + release-notes.rst + user-guide.rst + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` \ No newline at end of file diff --git a/docs/overview.rst b/docs/overview.rst new file mode 100644 index 0000000..df6b33a --- /dev/null +++ b/docs/overview.rst @@ -0,0 +1,8 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. Copyright (c) 2023 Samsung Electronics Co., Ltd. All Rights Reserved. + +Kserve Adapter Overview +======================= + diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 0000000..5be7a74 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,8 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. Copyright (c) 2023 Samsung Electronics Co., Ltd. All Rights Reserved. + +Release-Notes +============= + diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 0000000..4f9d174 --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1,5 @@ +sphinx +sphinx-rtd-theme +sphinxcontrib-httpdomain +recommonmark +lfdocs-conf \ No newline at end of file diff --git a/docs/user-guide.rst b/docs/user-guide.rst new file mode 100644 index 0000000..222c0b0 --- /dev/null +++ b/docs/user-guide.rst @@ -0,0 +1,7 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. Copyright (c) 2023 Samsung Electronics Co., Ltd. All Rights Reserved. + +User-Guide +========== \ No newline at end of file diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..577b565 --- /dev/null +++ b/tox.ini @@ -0,0 +1,37 @@ +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# ================================================================================== + +# documentation only +[tox] +envlist = docs,docs-linkcheck +skipsdist = true + +[testenv:docs] +basepython = python3 +deps = + sphinx + sphinx-rtd-theme + sphinxcontrib-httpdomain + recommonmark + lfdocs-conf + +commands = + sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +whitelist_externals = echo +allowlist_externals = echo + +[testenv:docs-linkcheck] +basepython = python3 +deps = sphinx + sphinx-rtd-theme + sphinxcontrib-httpdomain + recommonmark + lfdocs-conf +commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck