Add tox env to generate documentation
[multicloud/framework.git] / docs / conf.py
1 # -*- coding: utf-8 -*-
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at
5 #
6 #    http://www.apache.org/licenses/LICENSE-2.0
7 #
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
11 # implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 import os
16 import sys
17
18 BASE_DIR = os.path.dirname(os.path.abspath(__file__))
19 ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", ".."))
20
21 sys.path.insert(0, ROOT)
22 sys.path.insert(0, BASE_DIR)
23
24 # -- General configuration ----------------------------------------------------
25
26 # Add any Sphinx extension module names here, as strings. They can be
27 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28 extensions = [
29     'sphinx.ext.autodoc',
30     #'sphinx.ext.intersphinx'
31 ]
32
33 # The suffix of source filenames.
34 source_suffix = '.rst'
35
36 # The master toctree document.
37 master_doc = 'index'
38
39 # General information about the project.
40 project = u'MultiCloud Framework'