Merge "Auto Generated INFO.yaml file"

diff --git a/.gitmodules b/.gitmodules
index 7bf4296..846ab24 100644 (file)
--- a/.gitmodules
+++ b/.gitmodules
@@ -8,6 +8,11 @@
        url = ../armband
        branch = .
        ignore = dirty
+[submodule "docs/submodules/auto"]
+       path = docs/submodules/auto
+       url = ../auto
+       branch = .
+       ignore = dirty
 [submodule "docs/submodules/bottlenecks"]
        path = docs/submodules/bottlenecks
        url = ../bottlenecks
@@ -162,6 +167,11 @@
        url = ../storperf
        branch = .
        ignore = dirty
+[submodule "docs/submodules/stor4nfv"]
+       path = docs/submodules/stor4nfv
+       url = ../stor4nfv
+       branch = .
+       ignore = dirty
 [submodule "docs/submodules/ves"]
        path = docs/submodules/ves
        url = ../ves
@@ -232,3 +242,11 @@
        url = https://gerrit.opnfv.org/gerrit/calipso
        branch = .
        ignore = dirty
+[submodule "docs/submodules/stor4nfv"]
+       path = docs/submodules/stor4nfv
+       url = https://gerrit.opnfv.org/gerrit/stor4nfv
+[submodule "docs/submodules/clover"]
+       path = docs/submodules/clover
+       url = https://gerrit.opnfv.org/gerrit/clover
+       branch = .
+       ignore = dirty

diff --git a/docker/Dockerfile b/docker/Dockerfile
new file mode 100644 (file)
index 0000000..fe1ff80
--- /dev/null
+++ b/docker/Dockerfile
@@ -0,0 +1,23 @@
+FROM ubuntu:14.04
+
+MAINTAINER Julien Zhang <julienjut@gmail.com>
+LABEL version="0.1" Description="OPNFVDocs Docker container"
+
+ARG BRANCH=master
+ARG build=html
+ENV BRANCH=$BRANCH
+ENV build=$build
+
+# Dependencies for sphinx, pip and git
+RUN apt-get update && apt-get install -y \
+    python-pip python-sphinx git
+
+RUN git clone --depth=1 --branch=$BRANCH https://git.opnfv.org/opnfvdocs /opnfvdocs
+RUN pip install -r /opnfvdocs/etc/requirements.txt
+RUN pip install virtualenv
+RUN rm -rf /var/lib/apt-lists/* /root/.cache/pip /opnfvdocs/.git
+
+ADD ./entrypoint.sh /sbin/entrypoint.sh
+RUN chmod 755 /sbin/entrypoint.sh
+
+ENTRYPOINT /sbin/entrypoint.sh

diff --git a/docker/README.md b/docker/README.md
new file mode 100644 (file)
index 0000000..c7b119c
--- /dev/null
+++ b/docker/README.md
@@ -0,0 +1,28 @@
+# OPNFVDoc tool readme
+------------------------
+
+This docker container is used for building OPNFV docs from **rst** format files for each feature
+project. The output is just like contents in [opnfvdocs](http://docs.opnfv.org/) website. You can
+review the contents through web browser. Currently *PDF* output is not good enough and it will make
+the container image size 3x larger. PDF output format is not supported in this release.
+
+# Usage
+
+* The default build is *html*, you can run:
+```
+docker run -it --rm -v ./some-opnfv-repo:/docs -v /tmp/output:/output \
+     opnfv/opnfvdocs
+```
+
+* Then if you want to build epub, etc you could pass it as an arg:
+```
+docker run -it --rm -v ./some-opnfv-repo:/docs -v /tmp/output:/output \
+     -e build=epub opnfv/opnfvdocs
+```
+
+## env parameters
+* build: [html | singlehtml | epub]
+
+## two directory parameters
+* /docs: **mandatory**, used for source files
+* /output: **optional**, used for storing the built result

diff --git a/docker/entrypoint.sh b/docker/entrypoint.sh
new file mode 100644 (file)
index 0000000..6982bff
--- /dev/null
+++ b/docker/entrypoint.sh
@@ -0,0 +1,28 @@
+#!/bin/bash -x
+
+if [ ! -d /docs ]; then
+    echo source path /docs not exist and no repo for building
+    exit 1
+fi
+
+cd /docs
+for item in conf.py _templates _static
+do
+    cp -r /opnfvdocs/docs/$item ./
+done
+
+# use the same procedure as verify Job
+# [TODO]create a common macro can be consumed in Docker and Jenkins
+sudo pip install virtualenv
+virtualenv $WORKSPACE/venv
+. $WORKSPACE/venv/bin/activate
+pip install --upgrade pip
+pip freeze
+pip install tox
+tox -edocs
+
+# copy the building result to host
+if [ -d /output ]; then
+    cp -R ./docs/_build /output
+fi
+

diff --git a/docs/index.rst b/docs/index.rst
index b12470b..191153f 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -16,6 +16,7 @@ about network transformation.
    :maxdepth: 1
 
    release/overview
+   how-to-use-docs/getting.started
    release/installation.introduction
    release/userguide.introduction
    release/release-notes

diff --git a/docs/release/release-notes.rst b/docs/release/release-notes.rst
index 3fe891a..8aad8a4 100644 (file)
--- a/docs/release/release-notes.rst
+++ b/docs/release/release-notes.rst
@@ -16,6 +16,8 @@ Project release notes:
 
 :ref:`Apex Release Notes <apex-releasenotes>`
 
+:ref:`Auto Release Notes <auto-releasenotes>`
+
 :ref:`Barometer Release Notes <barometer-releasenotes>`
 
 :ref:`Bottlenecks Release Notes <bottlenecks-releasenotes>`

diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst
index 02267ea..bd448a8 100644 (file)
--- a/docs/release/userguide.introduction.rst
+++ b/docs/release/userguide.introduction.rst
@@ -76,6 +76,7 @@ Feature Configuration Guides
 Feature User Guides
 ===================
 
+- :ref:`Auto User Guide <auto-userguide>`
 - :ref:`Barometer User Guide <barometer-userguide>`
 - :ref:`Doctor User Guide <doctor-userguide>`
 - :ref:`Domino User Guide <domino-userguide>`

diff --git a/docs/submodules/apex b/docs/submodules/apex
index e1eda22..049cf8e 160000 (submodule)
--- a/docs/submodules/apex
+++ b/docs/submodules/apex
@@ -1 +1 @@
-Subproject commit e1eda223437eed7bef2bdfa7bef990a6749f1670
+Subproject commit 049cf8ea3e0074fc42bcfd3c23df71517c530ca2

diff --git a/docs/submodules/armband b/docs/submodules/armband
index f7a780a..13c73bf 160000 (submodule)
--- a/docs/submodules/armband
+++ b/docs/submodules/armband
@@ -1 +1 @@
-Subproject commit f7a780a85429d1975e3109e67760865d2ee2226d
+Subproject commit 13c73bfed1188a5e2c7355cf7eb5c5a1da006c22

diff --git a/docs/submodules/auto b/docs/submodules/auto
new file mode 160000 (submodule)
index 0000000..c74e914
--- /dev/null
+++ b/docs/submodules/auto
@@ -0,0 +1 @@
+Subproject commit c74e914c628819473625c3bfd03d4535e6e64bb8

diff --git a/docs/submodules/availability b/docs/submodules/availability
index cae4101..c1ee363 160000 (submodule)
--- a/docs/submodules/availability
+++ b/docs/submodules/availability
@@ -1 +1 @@
-Subproject commit cae41018b60f6b8c408ea3d766ae6f1e11416c44
+Subproject commit c1ee3631b59009ff61450808e2bd33fe1d4b17f2

diff --git a/docs/submodules/barometer b/docs/submodules/barometer
index 7be7d9a..83119c8 160000 (submodule)
--- a/docs/submodules/barometer
+++ b/docs/submodules/barometer
@@ -1 +1 @@
-Subproject commit 7be7d9aea103e9bd1073bbb1e8fd7583e5c598c4
+Subproject commit 83119c84b73421144b1e25b7946dc5eeeb19c298

diff --git a/docs/submodules/bottlenecks b/docs/submodules/bottlenecks
index ce3cbaa..c4a33d0 160000 (submodule)
--- a/docs/submodules/bottlenecks
+++ b/docs/submodules/bottlenecks
@@ -1 +1 @@
-Subproject commit ce3cbaa4868eeee4740a876f05cf2b4a33c83603
+Subproject commit c4a33d033497629b5e0b2ef1b269742eb26b0502

diff --git a/docs/submodules/calipso b/docs/submodules/calipso
index c6c19c9..8f3b074 160000 (submodule)
--- a/docs/submodules/calipso
+++ b/docs/submodules/calipso
@@ -1 +1 @@
-Subproject commit c6c19c9d08794f947bd4b48b85a4ff9f18d56634
+Subproject commit 8f3b074fafd2271557a152f43a676abaee6a32ea

diff --git a/docs/submodules/clover b/docs/submodules/clover
new file mode 160000 (submodule)
index 0000000..d031212
--- /dev/null
+++ b/docs/submodules/clover
@@ -0,0 +1 @@
+Subproject commit d031212e58932602779122ba384495dbefb680fa

diff --git a/docs/submodules/compass4nfv b/docs/submodules/compass4nfv
index bce23c3..01ff425 160000 (submodule)
--- a/docs/submodules/compass4nfv
+++ b/docs/submodules/compass4nfv
@@ -1 +1 @@
-Subproject commit bce23c34f221cdd9a41608c6505b359d99963afe
+Subproject commit 01ff42530757cf99e99b0d63d6daa822b93e1941

diff --git a/docs/submodules/container4nfv b/docs/submodules/container4nfv
index 5ed6980..84ce45c 160000 (submodule)
--- a/docs/submodules/container4nfv
+++ b/docs/submodules/container4nfv
@@ -1 +1 @@
-Subproject commit 5ed69809f33e546bf3e06dc285a90e0818c89ceb
+Subproject commit 84ce45c8bf6e03f0373d9c46e0a8b7e0b3faa605

diff --git a/docs/submodules/daisy b/docs/submodules/daisy
index f4c8d7c..c314d9c 160000 (submodule)
--- a/docs/submodules/daisy
+++ b/docs/submodules/daisy
@@ -1 +1 @@
-Subproject commit f4c8d7c8017e26f5dd000b0e576c5de24e31fa29
+Subproject commit c314d9c3a5f522f9b2979ef03b218c852b72cfb3

diff --git a/docs/submodules/doctor b/docs/submodules/doctor
index 888af5e..4c1ff36 160000 (submodule)
--- a/docs/submodules/doctor
+++ b/docs/submodules/doctor
@@ -1 +1 @@
-Subproject commit 888af5e40c21c1cef22e968c076908f1601c53f2
+Subproject commit 4c1ff363e85c9f49b783c99b6f45dac66b045c60

diff --git a/docs/submodules/dovetail b/docs/submodules/dovetail
index ff2a7b3..71ba21f 160000 (submodule)
--- a/docs/submodules/dovetail
+++ b/docs/submodules/dovetail
@@ -1 +1 @@
-Subproject commit ff2a7b3f7de37e64164250b8fa9a623dd061bac5
+Subproject commit 71ba21ff906d4104a81442d4712aac13cf4906d4

diff --git a/docs/submodules/fuel b/docs/submodules/fuel
index c2174cd..9c9a1ad 160000 (submodule)
--- a/docs/submodules/fuel
+++ b/docs/submodules/fuel
@@ -1 +1 @@
-Subproject commit c2174cd6d489b9079faec3523f175725da08f9df
+Subproject commit 9c9a1adc6f2501507a68b1926ea93efcb40782d1

diff --git a/docs/submodules/functest b/docs/submodules/functest
index 2db6217..6108496 160000 (submodule)
--- a/docs/submodules/functest
+++ b/docs/submodules/functest
@@ -1 +1 @@
-Subproject commit 2db621767d66b632fab4e2594e4524348484ad56
+Subproject commit 6108496e34d3b875d99cfbb67bd93e32a9b406ec

diff --git a/docs/submodules/ipv6 b/docs/submodules/ipv6
index 5058fb9..dfcc074 160000 (submodule)
--- a/docs/submodules/ipv6
+++ b/docs/submodules/ipv6
@@ -1 +1 @@
-Subproject commit 5058fb93bbb60151d74ad2ed7a7886af0b17a34f
+Subproject commit dfcc0745ef76e684593c8284f9dcb81cca2f7959

diff --git a/docs/submodules/joid b/docs/submodules/joid
index 9c6d9f0..16ea3c2 160000 (submodule)
--- a/docs/submodules/joid
+++ b/docs/submodules/joid
@@ -1 +1 @@
-Subproject commit 9c6d9f01489f5867ed84a9c04416ecbfce8254d0
+Subproject commit 16ea3c2f27d84ac6f917947b30a36b5985fff3d8

diff --git a/docs/submodules/moon b/docs/submodules/moon
index 9da7ac6..814b34a 160000 (submodule)
--- a/docs/submodules/moon
+++ b/docs/submodules/moon
@@ -1 +1 @@
-Subproject commit 9da7ac6718d66b73ba7fc8fc70e656a70e4db766
+Subproject commit 814b34aee2b42bc52229e3dad37e95bf480cddfe

diff --git a/docs/submodules/netready b/docs/submodules/netready
index 38697bc..a0f1cb6 160000 (submodule)
--- a/docs/submodules/netready
+++ b/docs/submodules/netready
@@ -1 +1 @@
-Subproject commit 38697bcef2049dc3f99e21dbfe7f591c987fb780
+Subproject commit a0f1cb6d759679e66d6da7fcd0471ddca22b5b6f

diff --git a/docs/submodules/nfvbench b/docs/submodules/nfvbench
index 298511b..6226413 160000 (submodule)
--- a/docs/submodules/nfvbench
+++ b/docs/submodules/nfvbench
@@ -1 +1 @@
-Subproject commit 298511bb572ffeb460f7ccbebe06233a17e6b794
+Subproject commit 6226413ca6e1b4c3a52a3deeb66f8f487c2704ae

diff --git a/docs/submodules/ovn4nfv b/docs/submodules/ovn4nfv
index e0e7d50..9623c07 160000 (submodule)
--- a/docs/submodules/ovn4nfv
+++ b/docs/submodules/ovn4nfv
@@ -1 +1 @@
-Subproject commit e0e7d50a8dbf70117baec66451df7f594a7db233
+Subproject commit 9623c07f59e059ed0b1cdc6fdfec9c7d9996d88d

diff --git a/docs/submodules/parser b/docs/submodules/parser
index d6c75bc..cabfeec 160000 (submodule)
--- a/docs/submodules/parser
+++ b/docs/submodules/parser
@@ -1 +1 @@
-Subproject commit d6c75bcf6eb3dd88a2dee1478236dcf09b73daf9
+Subproject commit cabfeecb3259c5e22488756d91b6f72d27c4c18a

diff --git a/docs/submodules/pharos b/docs/submodules/pharos
index 77b600e..02a3385 160000 (submodule)
--- a/docs/submodules/pharos
+++ b/docs/submodules/pharos
@@ -1 +1 @@
-Subproject commit 77b600ef0d64210c1b5fd72581cfe7752fa00c8c
+Subproject commit 02a3385322bad418f2b16854983546a59c3cf919

diff --git a/docs/submodules/promise b/docs/submodules/promise
index 335b844..7c28b66 160000 (submodule)
--- a/docs/submodules/promise
+++ b/docs/submodules/promise
@@ -1 +1 @@
-Subproject commit 335b8446a9cb142b82a6b5cd1c2231d8185416c9
+Subproject commit 7c28b66a376d8a441c40c2926b218497d63516a3

diff --git a/docs/submodules/qtip b/docs/submodules/qtip
index 17ff159..b340300 160000 (submodule)
--- a/docs/submodules/qtip
+++ b/docs/submodules/qtip
@@ -1 +1 @@
-Subproject commit 17ff15959005c3c6f72a9b91192de7d54734a005
+Subproject commit b34030013f9af4c40fd79850a85957c842e76595

diff --git a/docs/submodules/releng b/docs/submodules/releng
index 00b1600..97733bc 160000 (submodule)
--- a/docs/submodules/releng
+++ b/docs/submodules/releng
@@ -1 +1 @@
-Subproject commit 00b16002d3e31c6d692c78907b3885a7aff778cb
+Subproject commit 97733bc25ce3f415dd05bce4aa9f2cee8f2a11e7

diff --git a/docs/submodules/releng-xci b/docs/submodules/releng-xci
index 1d77569..75df705 160000 (submodule)
--- a/docs/submodules/releng-xci
+++ b/docs/submodules/releng-xci
@@ -1 +1 @@
-Subproject commit 1d775691155069aa730e671a285e6f25ce37cef1
+Subproject commit 75df705acd886a83a49692bf557f9bdda4c65a4f

diff --git a/docs/submodules/samplevnf b/docs/submodules/samplevnf
index d29f8fa..3981ce6 160000 (submodule)
--- a/docs/submodules/samplevnf
+++ b/docs/submodules/samplevnf
@@ -1 +1 @@
-Subproject commit d29f8fa251540b48371f76e47ddba6315607d192
+Subproject commit 3981ce6fed44db09af235100526ab8bc1666e38e

diff --git a/docs/submodules/sdnvpn b/docs/submodules/sdnvpn
index 37889e4..fc149c8 160000 (submodule)
--- a/docs/submodules/sdnvpn
+++ b/docs/submodules/sdnvpn
@@ -1 +1 @@
-Subproject commit 37889e4e2703cd3f2ba3514449ec94b3d933538b
+Subproject commit fc149c80771705b894d7a1dac427ce112c3c48b6

diff --git a/docs/submodules/sfc b/docs/submodules/sfc
index 575a8c9..a459dee 160000 (submodule)
--- a/docs/submodules/sfc
+++ b/docs/submodules/sfc
@@ -1 +1 @@
-Subproject commit 575a8c98517c587dfdccfad93a6ea119ad689629
+Subproject commit a459dee88ba00d6f8283232ce2159594ae23d22a

diff --git a/docs/submodules/snaps b/docs/submodules/snaps
index 9cf59ae..390d31e 160000 (submodule)
--- a/docs/submodules/snaps
+++ b/docs/submodules/snaps
@@ -1 +1 @@
-Subproject commit 9cf59ae0a133b0c8ab3907c84ec3c7b962df599a
+Subproject commit 390d31e3a6eaa0968474d19d71ec804d0c6c071a

diff --git a/docs/submodules/stor4nfv b/docs/submodules/stor4nfv
new file mode 160000 (submodule)
index 0000000..957abb6
--- /dev/null
+++ b/docs/submodules/stor4nfv
@@ -0,0 +1 @@
+Subproject commit 957abb60ddc82354234687328460147e19607caf

diff --git a/docs/submodules/storperf b/docs/submodules/storperf
index 0869c3a..6d64efd 160000 (submodule)
--- a/docs/submodules/storperf
+++ b/docs/submodules/storperf
@@ -1 +1 @@
-Subproject commit 0869c3a314d864d65b2d9faf98653378e411d493
+Subproject commit 6d64efd6d50b728dc03ca465f45e15cbd79ce92a

diff --git a/docs/submodules/ves b/docs/submodules/ves
index 0c7d632..6e0bfeb 160000 (submodule)
--- a/docs/submodules/ves
+++ b/docs/submodules/ves
@@ -1 +1 @@
-Subproject commit 0c7d63282c5c88c7f50eb68b720013e6ff579ba2
+Subproject commit 6e0bfeb045314a0964bffee025889619d427522a

diff --git a/docs/submodules/vswitchperf b/docs/submodules/vswitchperf
index 23eff36..1b37c72 160000 (submodule)
--- a/docs/submodules/vswitchperf
+++ b/docs/submodules/vswitchperf
@@ -1 +1 @@
-Subproject commit 23eff36d6a4b9e42ce06152e2b75e50fb7aaa5c5
+Subproject commit 1b37c72a4f4459a7e776503e8bb74e393b246493

diff --git a/docs/submodules/yardstick b/docs/submodules/yardstick
index 35ca724..2510133 160000 (submodule)
--- a/docs/submodules/yardstick
+++ b/docs/submodules/yardstick
@@ -1 +1 @@
-Subproject commit 35ca724899b3e0a8c58af6323dc4622736ee0625
+Subproject commit 25101331450b21ea4ca2c4250c06d290638cd357

diff --git a/docs/testing/ecosystem/overview.rst b/docs/testing/ecosystem/overview.rst
index 50569a7..ef7705b 100644 (file)
--- a/docs/testing/ecosystem/overview.rst
+++ b/docs/testing/ecosystem/overview.rst
@@ -219,7 +219,7 @@ The data model is very basic, 5 objects are available:
 
 For detailed information, please go to http://artifacts.opnfv.org/releng/docs/testapi.html
 
-The code of the Test API is hosted in the releng repository `[TST2]`_.
+The code of the Test API is hosted in the releng-testresults repository `[TST2]`_.
 The static documentation of the Test API can be found at `[TST3]`_.
 The Test API has been dockerized and may be installed locally in your lab.
 
@@ -367,7 +367,7 @@ Reference Documentation
 
 `[TST1]`_: OPNFV web site
 
-`[TST2]`_: Test utils in Releng
+`[TST2]`_: TestAPI code repository link in releng-testresults
 
 `[TST3]`_: TestAPI autogenerated documentation
 
@@ -376,7 +376,7 @@ Reference Documentation
 `[TST5]`_: Testing group dashboard
 
 .. _`[TST1]`: http://www.opnfv.org
-.. _`[TST2]`: https://git.opnfv.org/functest/tree/releng/utils/tests
+.. _`[TST2]`: https://git.opnfv.org/releng-testresults
 .. _`[TST3]`: http://artifacts.opnfv.org/releng/docs/testapi.html
 .. _`[TST4]`: http://testresults.opnfv.org/testing/index.html#!/select/visual
 .. _`[TST5]`: https://opnfv.biterg.io:443/goto/283dba93ca18e95964f852c63af1d1ba

diff --git a/opnfv-theme/.gitignore b/opnfv-theme/.gitignore
new file mode 100644 (file)
index 0000000..83b2238
--- /dev/null
+++ b/opnfv-theme/.gitignore
@@ -0,0 +1,5 @@
+/dist
+/build
+*.egg-info
+*.pyc
+__pycache__

diff --git a/opnfv-theme/MANIFEST.in b/opnfv-theme/MANIFEST.in
new file mode 100644 (file)
index 0000000..a5886cd
--- /dev/null
+++ b/opnfv-theme/MANIFEST.in
@@ -0,0 +1,7 @@
+include *.txt
+include *.rst
+
+recursive-include sphinx_opnfv_theme *
+recursive-include sphinx_opnfv_theme/opnfv *
+
+global-exclude *.pyc

diff --git a/opnfv-theme/README.rst b/opnfv-theme/README.rst
new file mode 100644 (file)
index 0000000..484a7a7
--- /dev/null
+++ b/opnfv-theme/README.rst
@@ -0,0 +1,48 @@
+OPNFV Documentation Theme
+=========================
+
+This theme is used for all OPNFV documentation and is released seperatly
+from the documentation itself. It's and extention of the `Sphinx
+Bootstrap Theme`_
+
+Installation
+------------
+
+Here's how to install the theme from PyPI_
+
+To install and configure the theme do the following.
+
+#. Install the theme from pypi::
+
+   $ pip install sphinx_opnfv_theme
+
+#. Configure Sphinx to use the theme:
+
+.. code-block:: python
+
+   # conf.py
+   import sphinx_opnfv_theme
+
+   # ...
+
+   html_theme = 'opnfv'
+   html_theme_path = sphinx_opnfv_theme.get_html_theme_path()
+
+Customization
+-------------
+
+There are no customization specific to this theme yet, but all
+all customizations_ Sphinx Bootstrap Theme are supported.
+
+If you'd like your documentation to match OPNFV's style configure the
+following options for the bootstrap theme::
+
+  html_theme_options = {
+    'bootswatch_theme': 'journal',
+    'navbar_sidebarrel': false,
+    'navbar_title': '',
+  }
+
+.. _Sphinx Bootstrap Theme: https://github.com/ryan-roemer/sphinx-bootstrap-theme
+.. _Pypi: http://pypi.python.org/pypi/sphinx-opnfv-theme/
+.. _customizations: https://github.com/ryan-roemer/sphinx-bootstrap-theme#customization

diff --git a/opnfv-theme/setup.py b/opnfv-theme/setup.py
new file mode 100644 (file)
index 0000000..5375c09
--- /dev/null
+++ b/opnfv-theme/setup.py
@@ -0,0 +1,30 @@
+from setuptools import setup, find_packages
+
+from sphinx_opnfv_theme import __version__
+
+with open('README.rst') as f:
+    readme_text = f.read()
+
+setup(
+    name='sphinx_opnfv_theme',
+    description="OPNFV Theme for Sphinx",
+    long_description=readme_text,
+    url='https://docs.opnfv.org/',
+    author='Trevor Bramwell',
+    author_email='tbramwell@linuxfoundation.org',
+    version=__version__,
+    entry_points = {
+        'sphinx.html_themes': [
+            'opnfv = sphinx_opnfv_theme',
+        ]
+    },
+    packages=find_packages(),
+    install_requires = [
+        'sphinx_bootstrap_theme',
+        'sphinxcontrib.httpdomain',
+    ],
+    include_package_data=True,
+    package_data = {
+        'sphinx_opnfv_theme': ['opnfv/**',]
+    },
+)

diff --git a/opnfv-theme/sphinx_opnfv_theme/__init__.py b/opnfv-theme/sphinx_opnfv_theme/__init__.py
new file mode 100644 (file)
index 0000000..0079275
--- /dev/null
+++ b/opnfv-theme/sphinx_opnfv_theme/__init__.py
@@ -0,0 +1,15 @@
+"""OPNFV Sphinx Theme"""
+
+from os import path
+
+__version__='0.1.1'
+
+
+def get_html_theme_path():
+    """Return list of HTML theme paths."""
+    local_path = path.abspath(path.dirname(__file__))
+    return [local_path]
+
+def setup(app):
+    """Required by Sphinx to create the theme."""
+    app.add_html_theme('opnfv', path.abspath(path.dirname(__file__)))

diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/layout.html b/opnfv-theme/sphinx_opnfv_theme/opnfv/layout.html
new file mode 100644 (file)
index 0000000..ddd674c
--- /dev/null
+++ b/opnfv-theme/sphinx_opnfv_theme/opnfv/layout.html
@@ -0,0 +1,5 @@
+{# Import the theme's layout. #}
+{% extends "bootstrap/layout.html" %}
+
+{# Custom CSS overrides #}
+{% set css_files = css_files + ['_static/my-styles.css'] %}

diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/my_custom_sidebar.html b/opnfv-theme/sphinx_opnfv_theme/opnfv/my_custom_sidebar.html
new file mode 100644 (file)
index 0000000..6b259bc
--- /dev/null
+++ b/opnfv-theme/sphinx_opnfv_theme/opnfv/my_custom_sidebar.html
@@ -0,0 +1,3 @@
+<ul class="globaltoc">
+{{ toctree(maxdepth=theme_globaltoc_depth|toint, collapse=False,includehidden=theme_globaltoc_includehidden|tobool) }}
+</ul>
\ No newline at end of file

diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/relations.html b/opnfv-theme/sphinx_opnfv_theme/opnfv/relations.html
new file mode 100644 (file)
index 0000000..5bad0b5
--- /dev/null
+++ b/opnfv-theme/sphinx_opnfv_theme/opnfv/relations.html
@@ -0,0 +1,15 @@
+<center>
+<div class="btn-group" role="group" aria-label="...">
+    {% if prev %}
+    <a class="btn btn-default" href="{{ prev.link|e }}">Prev Page</a>
+    {% else %}
+    <button type="button" class="btn btn-default disabled">Prev Page</button>
+    {% endif %}
+
+    {% if next %}
+    <a class="btn btn-default" href="{{ next.link|e }}">Next Page</a>
+    {% else %}
+    <button type="button" class="btn btn-default disabled">Next Page</button>
+    {% endif %}
+</div>
+</center>
\ No newline at end of file

diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/favicon.ico b/opnfv-theme/sphinx_opnfv_theme/opnfv/static/favicon.ico
new file mode 100755 (executable)
index 0000000..bbe55ab
Binary files /dev/null and b/opnfv-theme/sphinx_opnfv_theme/opnfv/static/favicon.ico differ

diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/logo.png b/opnfv-theme/sphinx_opnfv_theme/opnfv/static/logo.png
new file mode 100644 (file)
index 0000000..1519503
Binary files /dev/null and b/opnfv-theme/sphinx_opnfv_theme/opnfv/static/logo.png differ

diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/my-styles.css b/opnfv-theme/sphinx_opnfv_theme/opnfv/static/my-styles.css
new file mode 100644 (file)
index 0000000..8feb45b
--- /dev/null
+++ b/opnfv-theme/sphinx_opnfv_theme/opnfv/static/my-styles.css
@@ -0,0 +1,33 @@
+body {
+       font-family: Helvetica, sans-serif;
+       font-size: 16px;
+}
+
+body a {
+       color: #27CCC0;
+}
+
+body a:hover {
+       color: #676767;
+}
+
+.navbar-brand img {
+       height: 200%;
+       margin-top: -5%;
+}
+
+.navbar, h1, h2, h3, h4, h5, h6 {
+       font-family: Helvetica, sans-serif;
+}
+
+.navbar-text{
+       color: #676767;
+}
+
+.navbar-form.navbar-right{
+       padding: 0;
+}
+
+.navbar-form .form-control{
+       width: 150px;
+}

diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/theme.conf b/opnfv-theme/sphinx_opnfv_theme/opnfv/theme.conf
new file mode 100644 (file)
index 0000000..66424aa
--- /dev/null
+++ b/opnfv-theme/sphinx_opnfv_theme/opnfv/theme.conf
@@ -0,0 +1,7 @@
+[theme]
+inherit = bootstrap
+stylesheet = bootstrap-sphinx.css
+pygments_style = tango
+
+# Theme Options exposed by html_theme_options
+[options]