diff options
| -rw-r--r-- | .gitignore | 3 | ||||
| -rw-r--r-- | docs/conf.py | 40 | ||||
| -rw-r--r-- | multivimbroker/tox.ini | 4 |
3 files changed, 47 insertions, 0 deletions
@@ -13,3 +13,6 @@ multivimbroker/.coverage multivimbroker/.tox/ multivimbroker/logs/*.log multivimbroker/test-reports/ + +# Docs related +docs/html diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..bab9649 --- /dev/null +++ b/docs/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'MultiCloud Framework' diff --git a/multivimbroker/tox.ini b/multivimbroker/tox.ini index af3b3a5..1e54370 100644 --- a/multivimbroker/tox.ini +++ b/multivimbroker/tox.ini @@ -32,3 +32,7 @@ deps = rstcheck whitelist_externals = bash commands = bash -c "find ../docs -not -path {toxinidir}/.tox/\* \ -name \*.rst -type f -print0 | xargs -0 rstcheck --report warning" + +[testenv:docs] +deps = sphinx +commands = sphinx-build -b html ../docs/ ../docs/html |