9b2729cdd5
This change creates a section of the documentation focused on users, holding the guides, API docs, etc. Another change will focus on documentation for contributors. * Installation details were moved straight into the user index. Installation details for contributors will go into that section. * The old usage.rst section was moved into the userguides/ section and will grow into a Connection guide in another change. * The sections were organized according top to bottom in order of likelihood of utility to users. The guides will help people get started, the API docs will help them go from there, and anyone needing to customize lower-level things will have already scrolled through the preceeding sections to get to the end. * In order to see how the Resource docs turn out to be organized, I added pages for Compute and Database resources. We'll need to add them for every service, but I didn't want to overload this change with all of those additions. * Since glossary isn't linked in a TOC anywhere, just mentioned explicitly at the beginning of the user section, I added an exclude for it in the conf.py. It still gets built, but that allows it to not become a warning for being left out of TOCs. Change-Id: If9d1e4726ed14d5b7592c9da00c27591d2a4291c Partial-Bug: 1416553
86 lines
2.8 KiB
Python
Executable File
86 lines
2.8 KiB
Python
Executable File
# -*- 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',
|
|
#'sphinx.ext.intersphinx',
|
|
'oslosphinx',
|
|
]
|
|
|
|
# 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'python-openstacksdk'
|
|
copyright = u'2013, OpenStack Foundation'
|
|
|
|
# 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'
|
|
|
|
autodoc_member_order = "bysource"
|
|
|
|
# Locations to exclude when looking for source files.
|
|
# * Glossary is not included in any toctree, so it raised warnings, but it
|
|
# is explicitly linked to from the top of users/index.rst.
|
|
exclude_patterns = ["users/glossary.rst"]
|
|
|
|
# -- 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']
|
|
|
|
# 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 Foundation', 'manual'),
|
|
]
|
|
|
|
# Example configuration for intersphinx: refer to the Python standard library.
|
|
#intersphinx_mapping = {'http://docs.python.org/': None}
|
|
|
|
# Include both the class and __init__ docstrings when describing the class
|
|
autoclass_content = "both"
|