From 9a2405cac35636e82911bfcb5202da403d83fbff Mon Sep 17 00:00:00 2001
From: Thanh Ha <thanh.ha@linuxfoundation.org>
Date: Sat, 8 Sep 2018 20:44:58 -0400
Subject: [PATCH] Bootstrap Controller documentation

Issue: DOCS-69
Change-Id: Iaf57d73e8d720b910c66cae41a75f10ceefba80f
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
---
 .gitignore            |   5 +++++
 docs/_static/logo.png | Bin 0 -> 329 bytes
 docs/conf.py          |  14 ++++++++++++++
 docs/conf.yaml        |   4 ++++
 docs/favicon.ico      | Bin 0 -> 766 bytes
 docs/index.rst        |   5 +++++
 docs/requirements.txt |   1 +
 tox.ini               |  16 ++++++++++++++++
 8 files changed, 45 insertions(+)
 create mode 100644 docs/_static/logo.png
 create mode 100644 docs/conf.py
 create mode 100644 docs/conf.yaml
 create mode 100644 docs/favicon.ico
 create mode 100644 docs/index.rst
 create mode 100644 docs/requirements.txt
 create mode 100644 tox.ini

diff --git a/.gitignore b/.gitignore
index 735f29f704..8758bfe6bb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -33,3 +33,8 @@ opendaylight/md-sal/sal-distributed-datastore/journal
 maven-metadata-local.xml
 .fbExcludeFilterFile
 META-INF
+
+# Sphinx documentation
+.tox/
+docs/_build/
+
diff --git a/docs/_static/logo.png b/docs/_static/logo.png
new file mode 100644
index 0000000000000000000000000000000000000000..861e1af629c51e29ea456b462e680df1b916893d
GIT binary patch
literal 329
zcmeAS@N?(olHy`uVBq!ia0vp^5+KaM3?#3wJbMaAxd!-zxc=H90zz9vA&hsXn(xdt
z-`Qxsx7T>@qwzja<9&$6hX}QgacZBkRK8RxeW_La+N|)kP5#>i+3!<iey$S(YTT`p
zdlqOQV@Z%-FoVOh8)+a;lDE4HLkFv@2av;A;1OBOz`!jG!i)^F=71c-UgGKN%Km_z
zjYZh9#3FbFP^i|^#W6(V{M1RFTn7|*Tw^m9mMIEO`Ype8f0W^(mlIk~)X(%OSvOOp
zc(ZP!#sljw0yWH5YqSdjI9Dsx$VR3pu}sX!SlA|9xbI+q>;n(c6*dJ+ceHMBkBKm6
zW|Cd<lGnq|Y2%Skyb&wIj-D->FPG8#B(<Y^<Lz#v@ZayJ&rzt7mHlgb*c9jx22WQ%
Jmvv4FO#sKec&q>b

literal 0
HcmV?d00001

diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000000..925316abfa
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,14 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# SPDX-License-Identifier: EPL-1.0
+##############################################################################
+# Copyright (c) 2018 The Linux Foundation and others.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# which accompanies this distribution, and is available at
+# http://www.eclipse.org/legal/epl-v10.html
+##############################################################################
+
+from docs_conf.conf import *
+
diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644
index 0000000000..e9fd0669b0
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,4 @@
+project_cfg: opendaylight
+project: Controller
+version: Neon
+
diff --git a/docs/favicon.ico b/docs/favicon.ico
new file mode 100644
index 0000000000000000000000000000000000000000..c9b3888c7d8b02bed442758f5cdbb907287e8aad
GIT binary patch
literal 766
zcmc&wyApyx3|t%wOJE%9V`;Fx486bLH~CY3l9g6ARwm#Oh>eZI-sLWPk7N^|(2-K9
z>lU{SZ~)M$CAE{9oe$WJo2})?J@$8W=Lgc|iT(BE4}SDy6|^FGo|qy!9c=TGlS|&z
z&NEp76{%4NklLNXe`H!SrfZSLc<t!|kMBdguY4+gu1DjlT-Rqj))VTD{cvgj_N)_Y
F;tiJ3WElVe

literal 0
HcmV?d00001

diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000000..ffe79afd65
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,5 @@
+.. _controller:
+
+########################
+Controller Documentation
+########################
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000000..74a3b7a3fd
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1 @@
+lfdocs-conf
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000000..8d4a48fd56
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,16 @@
+[tox]
+minversion = 1.6
+envlist =
+    docs
+    docs-linkcheck
+skipsdist = true
+
+[testenv:docs]
+deps = -rdocs/requirements.txt
+commands =
+    sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
+
+[testenv:docs-linkcheck]
+deps = -rdocs/requirements.txt
+commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
+
-- 
2.36.6