f272ab3ae4
As a new user I found navigating the documentation difficult. The flow was a bit unclear and searches bring up old versions of API references that aren't included in the current documentation. This - provides an introduction to the tools similar to other projects - generates API references for the v1 and v2 client - fixes some minor docstring issues - adds doc/* to pep8 tests to check the conf.py The API generation code is cribbed from python-novaclient Change-Id: I65772127679d7afd5e7e48ca7872366b01382f21
130 lines
4.3 KiB
Python
130 lines
4.3 KiB
Python
# Copyright 2015 OpenStack Foundation
|
|
# 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 os
|
|
import sys
|
|
|
|
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__),
|
|
'..', '..')))
|
|
|
|
BASE_DIR = os.path.dirname(os.path.abspath(__file__))
|
|
ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", ".."))
|
|
|
|
|
|
def gen_ref(ver, title, names):
|
|
refdir = os.path.join(BASE_DIR, "ref")
|
|
pkg = "glanceclient"
|
|
if ver:
|
|
pkg = "%s.%s" % (pkg, ver)
|
|
refdir = os.path.join(refdir, ver)
|
|
if not os.path.exists(refdir):
|
|
os.makedirs(refdir)
|
|
idxpath = os.path.join(refdir, "index.rst")
|
|
with open(idxpath, "w") as idx:
|
|
idx.write(("%(title)s\n"
|
|
"%(signs)s\n"
|
|
"\n"
|
|
".. toctree::\n"
|
|
" :maxdepth: 1\n"
|
|
"\n") % {"title": title, "signs": "=" * len(title)})
|
|
for name in names:
|
|
idx.write(" %s\n" % name)
|
|
rstpath = os.path.join(refdir, "%s.rst" % name)
|
|
with open(rstpath, "w") as rst:
|
|
rst.write(("%(title)s\n"
|
|
"%(signs)s\n"
|
|
"\n"
|
|
".. automodule:: %(pkg)s.%(name)s\n"
|
|
" :members:\n"
|
|
" :undoc-members:\n"
|
|
" :show-inheritance:\n"
|
|
" :noindex:\n")
|
|
% {"title": name.capitalize(),
|
|
"signs": "=" * len(name),
|
|
"pkg": pkg, "name": name})
|
|
|
|
gen_ref(None, "API", ["client", "exc"])
|
|
gen_ref("v1", "OpenStack Images Version 1 Client Reference",
|
|
["client", "images", "image_members"])
|
|
gen_ref("v2", "OpenStack Images Version 2 Client Reference",
|
|
["client", "images", "image_tags",
|
|
"image_members", "tasks", "metadefs"])
|
|
|
|
# -- 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', '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
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# The suffix of source filenames.
|
|
source_suffix = '.rst'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
project = 'python-glanceclient'
|
|
copyright = u'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'
|
|
|
|
# Grouping the document tree for man pages.
|
|
# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
|
|
|
|
man_pages = [
|
|
('man/glance', 'glance', u'Client for OpenStack Images API',
|
|
[u'OpenStack Foundation'], 1),
|
|
]
|
|
# -- 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 = 'nature'
|
|
|
|
# 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'
|
|
),
|
|
]
|