From: Thanh Ha Date: Sun, 9 Sep 2018 01:28:02 +0000 (-0400) Subject: Bootstrap transportpce documentation X-Git-Tag: v0.3.0~72 X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=transportpce.git;a=commitdiff_plain;h=00c548e0ab75f78090291734639191aea9bfa983 Bootstrap transportpce documentation Issue: DOCS-69 Change-Id: Ic3dd2d82ee6af8cdb50a971d1012646dc54f89d1 Signed-off-by: Thanh Ha --- diff --git a/.gitignore b/.gitignore index 04e0228f4..8da0b1eec 100644 --- a/.gitignore +++ b/.gitignore @@ -21,4 +21,9 @@ classes .metadata ordmodels/src/main/java tests/config.xml -tests/models \ No newline at end of file +tests/models + +# Sphinx documentation +.tox/ +docs/_build/ + diff --git a/docs/_static/logo.png b/docs/_static/logo.png new file mode 100644 index 000000000..861e1af62 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 000000000..925316abf --- /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 000000000..2dd95bc29 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,4 @@ +project_cfg: opendaylight +project: Transport PCE +version: Neon + diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 000000000..c9b3888c7 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 000000000..0c578a6cc --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,6 @@ +.. _transportpce: + +########################### +Transport PCE Documentation +########################### + diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 000000000..74a3b7a3f --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +lfdocs-conf diff --git a/tox.ini b/tox.ini new file mode 100644 index 000000000..8d4a48fd5 --- /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 +