summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDylanB95EST <dylan.byrne@est.tech>2021-09-24 10:52:23 +0100
committerDylanB95EST <dylan.byrne@est.tech>2021-09-24 10:52:32 +0100
commitc2ce1198a0f11af748d23797e6cdc7b3ed3236f6 (patch)
tree4423d8bc0b633e4f97d24c51c5879dca71ddfd0b
parentfa11e9cb799b9738d2295abd4690c142639b9250 (diff)
Create preliminary documentation for ONAP DMI-Plugin
Add .readthedocs.yaml file for NCMP-DMI-PLUGIN Issue-ID: CPS-625 Change-Id: I810ca4859127f95bb216c9b16406087784053cac Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
-rw-r--r--.readthedocs.yaml38
1 files changed, 38 insertions, 0 deletions
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 00000000..9c22c0b4
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,38 @@
+# ============LICENSE_START=======================================================
+# Copyright (C) 2021 Nordix Foundation
+# ================================================================================
+# 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.
+#
+# SPDX-License-Identifier: Apache-2.0
+# ============LICENSE_END=========================================================
+
+---
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+# Required
+version: 2
+
+formats:
+ - htmlzip
+
+build:
+ image: latest
+
+python:
+ version: 3.7
+ install:
+ - requirements: docs/requirements-docs.txt
+
+sphinx:
+ configuration: docs/conf.py