Configure for publishing RST to readthedocs.io

Change-Id: I66bca6ca33058c3120c6999296feb90553fbb0f1
Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>

diff --git a/.gitignore b/.gitignore
index 2bfa4fa..675d063 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -50,3 +50,4 @@
 
 # documentation
 .tox
+docs/_build/*

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 7496bc4..3797dc8 100644 (file)
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -1,12 +1,20 @@
 ---
-# pip requirements file for building sphinx docs (e.g. nbsphinx)
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+# Required
 version: 2
 
-sphinx:
-    configuration: docs/conf.py
+formats:
+  - htmlzip
+
+build:
+  image: latest
 
-# Use python 3 for building
 python:
-    version: 3.6
-    install:
-        - requirements: docs/requirements-docs.txt
+  version: 3.7
+  install:
+    - requirements: docs/requirements-docs.txt
+
+sphinx:
+  configuration: docs/conf.py

diff --git a/docs/conf.py b/docs/conf.py
index 592a573..922e22f 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,2 +1,6 @@
-from docs_conf import *
-master_doc = 'index'
+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
index 02f362d..127745e 100644 (file)
--- a/docs/conf.yaml
+++ b/docs/conf.yaml
@@ -1,3 +1,3 @@
 ---
-project_cfg: lfdocs
+project_cfg: oran
 project: portal-ric-dashboard

diff --git a/tox.ini b/tox.ini
index 96d6ff8..72742cf 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -23,4 +23,8 @@ whitelist_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