diff --git a/README.rst b/README.rst index 7a12f1d..b6755e0 100644 --- a/README.rst +++ b/README.rst @@ -7,12 +7,16 @@ Team and repository tags .. Change things from this point on - Tacker Horizon UI ================= Horizon UI for Tacker VNF Manager +* License: Apache license +* Source: https://git.openstack.org/cgit/openstack/tacker-horizon +* Bugs: https://bugs.launchpad.net/tacker +* Tacker-horizon docs: https://docs.openstack.org/tacker-horizon/latest/ + Installation ============ @@ -49,15 +53,26 @@ master branch. /opt/stack/horizon/openstack_dashboard/enabled/ -4. Restart Apache server. +4. Collect and compress static files. + + :: + + ./manage.py collectstatic --noinput + echo yes | ./manage.py compress + + +5. Restart Apache server. :: sudo service apache2 restart -More Information -================ +If your server is using Systemd instead of Upstart (e.g Ubuntu 15.10 +and above), use the following command instead: + + :: + + sudo systemctl restart apache2 + -[1] Tacker Documentation: https://docs.openstack.org/tacker/ -[2] Tacker Wiki: https://wiki.openstack.org/wiki/Tacker diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..4971ad1 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,7 @@ +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. + +openstackdocstheme>=1.18.1 # Apache-2.0 +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +reno>=2.5.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..9a0feed --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,89 @@ +# -*- coding: utf-8 -*- +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import os +import sys + +sys.path.insert(0, os.path.abspath('../..')) +# -- General configuration ---------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [ + 'sphinx.ext.autodoc', + 'openstackdocstheme', + # 'sphinx.ext.intersphinx', +] + +# autodoc generation is a bit aggressive and a nuisance when doing heavy +# text edit cycles. +# execute "export SPHINX_DEBUG=1" in your terminal to disable + +# The suffix of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Tacker-Horizon' +copyright = u'2018, OpenStack Developers' + +# openstackdocstheme options +repository_name = 'openstack/tacker-horizon' +bug_project = 'tacker' +bug_tag = '' +html_last_updated_fmt = '%Y-%m-%d %H:%M' + +# If true, '()' will be appended to :func: etc. cross-reference text. +add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +add_module_names = True + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# -- Options for HTML output -------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. Major themes that come with +# Sphinx are currently 'default' and 'sphinxdoc'. +# html_theme_path = ["."] +# html_theme = '_theme' +# html_static_path = ['static'] +html_theme = 'openstackdocs' + +# Output file base name for HTML help builder. +htmlhelp_basename = '%sdoc' % project + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass +# [howto/manual]). +latex_documents = [ + ('index', + '%s.tex' % project, + u'%s Documentation' % project, + u'OpenStack Developers', 'manual'), +] + +man_pages = [ + ('index', u'Tacker Horizon Documentation', + 'Documentation for Tacker Horizon plugin to Openstack\ + Dashboard (Horizon)', + [u'OpenStack'], 1) +] + +# Example configuration for intersphinx: refer to the Python standard library. +# intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst new file mode 100644 index 0000000..db8542c --- /dev/null +++ b/doc/source/configuration/index.rst @@ -0,0 +1,9 @@ +============= +Configuration +============= + +Tacker-horizon does not need special configuration. + +For more configurations, see +`Configuration Guide `_ +in the Horizon documentation. diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 0000000..573114c --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,39 @@ +================= +Contributor Guide +================= + +Contributor License Agreement +----------------------------- + +.. index:: + single: license; agreement + +In order to contribute to the Tacker-Horizon project, you need to have +signed OpenStack's contributor's agreement. You can find the details +of how to contribute as the link below. + +.. seealso:: + + * http://docs.openstack.org/infra/manual/developers.html + * http://wiki.openstack.org/CLA + +LaunchPad Project +----------------- + +Most of the tools used for OpenStack depend on a launchpad.net ID for +authentication. + +.. seealso:: + + * https://launchpad.net + * https://launchpad.net/tacker + +Project Info +------------ + +* Free software: under the `Apache license `_ +* Tacker service: http://git.openstack.org/cgit/openstack/tacker +* Tacker-horizon library: https://git.openstack.org/cgit/openstack/tacker-horizon +* Bugs tracker: http://bugs.launchpad.net/tacker +* Blueprints: https://blueprints.launchpad.net/tacker +* Code review: https://review.openstack.org/#/q/status:open+project:openstack/tacker-horizon,n,z diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..7b83e9c --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,28 @@ +============== +Tacker Horizon +============== + +Horizon UI for NFV Orchestration (Tacker) + +* License: `Apache license `_ +* Tacker-horizon docs: https://docs.openstack.org/tacker-horizon/lastest +* Source: https://git.openstack.org/cgit/openstack/tacker-horizon +* Bugs: https://bugs.launchpad.net/tacker + +Contents +-------- + +.. toctree:: + :maxdepth: 2 + + install/index + configuration/index + user/index + contributor/index + + +Indices and tables +------------------ + +* :ref:`search` +* :ref:`modindex` diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst new file mode 100644 index 0000000..bbe3d12 --- /dev/null +++ b/doc/source/install/index.rst @@ -0,0 +1,71 @@ +================== +Installation Guide +================== + +Manual Installation +------------------- + +**Note:** The paths we are using for configuration files in these steps +are with reference to Ubuntu Operating System. The paths may vary for +other Operating Systems. + +The branch_name which is used in commands, specify the branch_name +as stable/ for any stable branch installation. For eg: +stable/queens. If unspecified the default will be master branch. + +1. Clone tacker-horizon repository. + + :: + + cd ~/ + git clone https://github.com/openstack/tacker-horizon -b + + +2. Install horizon module. + + :: + + cd tacker-horizon + sudo python setup.py install + + +3. Enable tacker horizon in dashboard. + + :: + + sudo cp tacker_horizon/enabled/* \ + /opt/stack/horizon/openstack_dashboard/enabled/ + + +4. Collect and compress static files. + + :: + + ./manage.py collectstatic --noinput + echo yes | ./manage.py compress + + +5. Restart Apache server. + + :: + + sudo service apache2 restart + + +If your server is using Systemd instead of Upstart (e.g Ubuntu 15.10 +and above), use the following command instead: + + :: + + sudo systemctl restart apache2 + + +Install via Devstack +-------------------- + +The tacker-horizon is automatically enabled when tacker server +is installed. + +.. seealso:: + + https://docs.openstack.org/tacker/latest/install/devstack.html diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 0000000..7204381 --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,5 @@ +========== +User Guide +========== + +**Reference:** https://docs.openstack.org/tacker/latest/user/index.html diff --git a/setup.cfg b/setup.cfg index 5e22487..ed6ca9f 100644 --- a/setup.cfg +++ b/setup.cfg @@ -5,7 +5,7 @@ description-file = README.rst author = OpenStack author-email = openstack-dev@lists.openstack.org -home-page = http://www.openstack.org/ +home-page = https://docs.openstack.org/tacker-horizon/latest/ classifier = Environment :: OpenStack Intended Audience :: Developers @@ -24,15 +24,6 @@ packages = namespace_packages = tacker_horizon -[global] -setup-hooks = - pbr.hooks.setup_hook - -[build_sphinx] -all_files = 1 -build-dir = doc/build -source-dir = doc/source - [nosetests] where = test verbosity = 2 diff --git a/test-requirements.txt b/test-requirements.txt index 215a1a8..c21c868 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -19,10 +19,7 @@ nose-exclude>=0.3.0 # LGPL nosehtmloutput>=0.0.3 # Apache-2.0 nosexcover>=1.0.10 # BSD openstack.nose-plugin>=0.7 # Apache-2.0 -oslosphinx>=4.7.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 selenium>=2.50.1 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD testtools>=2.2.0 # MIT # This also needs xvfb library installed on your OS xvfbwrapper>=0.1.3 #license: MIT diff --git a/tox.ini b/tox.ini index 5a16c3b..7224459 100644 --- a/tox.ini +++ b/tox.ini @@ -24,8 +24,6 @@ commands = commands = {envpython} {toxinidir}/manage.py test tacker_horizon --settings=tacker_horizon.test.settings {posargs} -[tox:jenkins] - [testenv:pep8] usedevelop = True whitelist_externals = @@ -36,9 +34,9 @@ setenv = commands = flake8 -[testenv:doc] -deps = Sphinx -commands = sphinx-build doc/source doc/build +[testenv:docs] +deps = -r{toxinidir}/doc/requirements.txt +commands = sphinx-build -W -b html doc/source doc/build/html [testenv:cover] setenv = NOSE_WITH_COVERAGE=1