Bootstrap Sphinx documentation

Change-Id: I29052dffa60eff9d32b94e4b43cb0888a45db393
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

diff --git a/.gitignore b/.gitignore
index d176524c3175f03584aa2be00fdd77000eb13ac8..3bcb77d84dd582b9eab1641d0c72f1d0baccd2c3 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -25,3 +25,7 @@ META-INF
 .fbExcludeFilterFile
 .cache-main
 .cache-tests
+
+# Sphinx documentation
+.tox/
+docs/_build/

diff --git a/docs/_static/logo.png b/docs/_static/logo.png
new file mode 100644 (file)
index 0000000..861e1af
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 (file)
index 0000000..925316a
--- /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 (file)
index 0000000..d128264
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,4 @@
+project_cfg: opendaylight
+project: MD-SAL
+version: 2.2.0
+

diff --git a/docs/favicon.ico b/docs/favicon.ico
new file mode 100644 (file)
index 0000000..c9b3888
Binary files /dev/null and b/docs/favicon.ico differ

diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644 (file)
index 0000000..6346ea5
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,13 @@
+.. _mdsal:
+
+MD-SAL
+======
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
+veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
+commodo consequat. Duis aute irure dolor in reprehenderit in voluptate
+velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
+cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
+est laborum.
+

diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644 (file)
index 0000000..74a3b7a
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1 @@
+lfdocs-conf

diff --git a/tox.ini b/tox.ini
new file mode 100644 (file)
index 0000000..8d4a48f
--- /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
+