diff options
author | Victor Morales <victor.morales@intel.com> | 2017-08-09 14:25:50 -0500 |
---|---|---|
committer | Victor Morales <victor.morales@intel.com> | 2017-08-09 14:25:50 -0500 |
commit | 47a6f470675ef28c5c7d5e9826fe6696fa139d14 (patch) | |
tree | 1b0763fb7be9c95c911611683a02979f39237694 /bootstrap/vagrant-onap/doc/source/conf.py | |
parent | bafd0b7a83b442983e3736af71da28f45b03b9ff (diff) |
Improve vagrant-onap documentation
It was added the process to create documentation thru sphinx tool.
Now it's possible to generate all the documentation locally running:
$ tox -e docs
Lastly, the installation guide was included as a reference to
different methods to install requirements.
Change-Id: Id0b277d605cf83ddbde54ecd9f4648e1f89023c3
Signed-off-by: Victor Morales <victor.morales@intel.com>
Diffstat (limited to 'bootstrap/vagrant-onap/doc/source/conf.py')
-rw-r--r-- | bootstrap/vagrant-onap/doc/source/conf.py | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/bootstrap/vagrant-onap/doc/source/conf.py b/bootstrap/vagrant-onap/doc/source/conf.py new file mode 100644 index 000000000..906f249d4 --- /dev/null +++ b/bootstrap/vagrant-onap/doc/source/conf.py @@ -0,0 +1,40 @@ +# -*- 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 + +BASE_DIR = os.path.dirname(os.path.abspath(__file__)) +ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", "..")) + +sys.path.insert(0, ROOT) +sys.path.insert(0, BASE_DIR) + +# -- 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', + #'sphinx.ext.intersphinx' +] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'ONAP on Vagrant' |