From: Thanh Ha Date: Sun, 9 Sep 2018 00:44:58 +0000 (-0400) Subject: Bootstrap Controller documentation X-Git-Tag: release/neon~89 X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=commitdiff_plain;h=9a2405cac35636e82911bfcb5202da403d83fbff Bootstrap Controller documentation Issue: DOCS-69 Change-Id: Iaf57d73e8d720b910c66cae41a75f10ceefba80f Signed-off-by: Thanh Ha --- 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 0000000000..861e1af629 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 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 0000000000..c9b3888c7d Binary files /dev/null and b/docs/favicon.ico differ 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 +