0ce00bb569
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Set openstackdocs_auto_name to use 'project' as name. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: Ib5706db978edfdddb88230ee81a563c7976f238a
70 lines
1.8 KiB
Python
70 lines
1.8 KiB
Python
# Copyright 2011 OpenStack Foundation
|
|
# Copyright 2013 Rackspace Hosting
|
|
# Copyright 2013 Hewlett-Packard Development Company, L.P.
|
|
# Copyright 2013 Mirantis Inc.
|
|
# All Rights Reserved.
|
|
#
|
|
# 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.
|
|
#
|
|
# -*- coding: utf-8 -*-
|
|
|
|
import sys
|
|
import os
|
|
|
|
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)
|
|
|
|
extensions = [
|
|
'sphinx.ext.doctest',
|
|
'sphinx.ext.coverage',
|
|
'openstackdocstheme',
|
|
'sphinxcontrib.apidoc',
|
|
]
|
|
|
|
# sphinxcontrib.apidoc options
|
|
apidoc_module_dir = '../../troveclient'
|
|
apidoc_output_dir = 'reference/api'
|
|
apidoc_excluded_paths = [
|
|
'compat/tests/*',
|
|
'compat/tests',
|
|
'tests/*',
|
|
'tests']
|
|
apidoc_separate_modules = True
|
|
|
|
# openstackdocstheme options
|
|
openstackdocs_repo_name = 'openstack/python-troveclient'
|
|
openstackdocs_bug_project = 'python-troveclient'
|
|
openstackdocs_bug_tag = ''
|
|
html_theme = 'openstackdocs'
|
|
|
|
templates_path = ['_templates']
|
|
|
|
source_suffix = '.rst'
|
|
|
|
master_doc = 'index'
|
|
|
|
copyright = u'2014, OpenStack Foundation'
|
|
|
|
exclude_trees = []
|
|
|
|
pygments_style = 'native'
|
|
|
|
htmlhelp_basename = 'python-troveclientdoc'
|
|
latex_documents = [
|
|
('index', 'python-troveclient.tex', u'python-troveclient Documentation',
|
|
u'OpenStack', 'manual'),
|
|
]
|