From 2c4cf077b8d8b6368eacaa166dbe6146a07b259d Mon Sep 17 00:00:00 2001 From: "Lott, Christopher (cl778h)" Date: Fri, 4 Oct 2019 13:55:34 -0400 Subject: [PATCH] Configure for publishing RST to readthedocs.io Change-Id: I66bca6ca33058c3120c6999296feb90553fbb0f1 Signed-off-by: Lott, Christopher (cl778h) --- .gitignore | 1 + .readthedocs.yaml | 22 +++++++++++++++------- docs/conf.py | 8 ++++++-- docs/conf.yaml | 2 +- tox.ini | 4 ++++ 5 files changed, 27 insertions(+), 10 deletions(-) diff --git a/.gitignore b/.gitignore index 2bfa4fa9..675d063c 100644 --- a/.gitignore +++ b/.gitignore @@ -50,3 +50,4 @@ # documentation .tox +docs/_build/* diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 7496bc45..3797dc8b 100644 --- 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 592a5736..922e22fb 100644 --- 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 02f362de..127745e9 100644 --- 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 96d6ff8e..72742cff 100644 --- 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 -- 2.16.6