Retire oslosphinx

Change-Id: I8c132b41ac325b3ad9c420df583d19b08c18f690
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Closes-Bug: #1713543
Depends-On: https://review.openstack.org/#/c/649954/
changes/70/649070/2
Stephen Finucane 4 years ago
parent db2ca62a96
commit 6676aa9256

24
.gitignore vendored

@ -1,24 +0,0 @@
*~
*.pyc
*.dat
TAGS
*.egg-info
build
.coverage
.tox
cover
.testrepository
subunit.log
AUTHORS
ChangeLog
*.deb
dist
*.egg
ceilometer/versioninfo
doc/source/api/ceilometer.*.rst
doc/source/api/tests.*.rst
doc/source/api/autoindex.rst
doc/source/sourcecode
*.mo
.update-venv
releasenotes/build

@ -1,15 +0,0 @@
- project:
gate:
jobs:
- openstack-tox-pep8
check:
jobs:
- openstack-tox-pep8
post:
jobs:
- publish-openstack-python-branch-tarball
templates:
- publish-openstack-docs-pti
- check-requirements
- release-notes-jobs-python3
- periodic-stable-jobs

@ -1,16 +0,0 @@
If you would like to contribute to the development of OpenStack,
you must follow the steps in this page:
http://docs.openstack.org/infra/manual/developers.html
Once those steps have been completed, changes to OpenStack
should be submitted for review via the Gerrit tool, following
the workflow documented at:
http://docs.openstack.org/infra/manual/developers.html#development-workflow
Pull requests submitted through GitHub will be ignored.
Bugs should be filed on Launchpad, not GitHub:
https://bugs.launchpad.net/oslosphinx

@ -1,12 +0,0 @@
oslosphinx Style Commandments
=============================
- Step 1: Read the OpenStack Style Commandments
https://docs.openstack.org/hacking/latest/
- Step 2: Read on
oslosphinx Specific Commandments
--------------------------------
None so far

@ -1,176 +0,0 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

@ -0,0 +1,9 @@
This project is no longer maintained.
The contents of this repository are still available in the Git
source code management system. To see the contents of this
repository before it reached its end of life, please check out the
previous commit with "git checkout HEAD^1".
For any further questions, please email
openstack-discuss@lists.openstack.org.

@ -1,17 +0,0 @@
=============================
OpenStack Sphinx Extensions
=============================
oslosphinx is obsolete. The openstackdocstheme package should be used
instead. oslosphinx will be maintained for the pike, ocata, and newton
release series and completely remove after that pike is marked
end-of-life.
The contents of this repository are still available in the Git source
code management system. To see the contents of this repository before
it reached its end of life, please check out the previous commit with
"git checkout HEAD^1", or check out one of the supported stable
branches.
For any further questions, please email
openstack-dev@lists.openstack.org or join #openstack-oslo on Freenode.

@ -1,48 +0,0 @@
===========================================================
Using oslosphinx.check_blueprints with Specs Repositories
===========================================================
The ``oslosphinx.check_blueprints`` extension verifies that the
filenames in spec repositories match a blueprint under a given
launchpad project.
Enabling
========
Add ``'oslosphinx.check_blueprints'`` to the ``extensions`` list in
the ``conf.py`` file in your Sphinx project.
Specifying the Launchpad Project
================================
Most projects should set ``check_blueprints_project`` to the name of
their launchpad project. This limits the search to the single project
named.
::
check_blueprints_project = 'nova'
Projects with multiple launchpad projects under their own project
group (such as Oslo), should instead set
``check_blueprints_project_group``. All projects in the group will be
scanned for each spec/blueprint name.
::
check_blueprints_project_group = 'oslo'
Checking Only the Current Release
=================================
By default, all files under ``specs/`` are checked. For large specs
repositories, this can take a long time. To limit the checks to a
subdirectory for the current release, set
``check_blueprints_release``.
For example::
check_blueprints_release = 'kilo'
will cause files under ``specs/kilo`` to be checked, and other files
to be ignored.

@ -1,85 +0,0 @@
# -*- 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',
'openstackdocstheme'
]
# -- Options for openstackdocstheme -------------------------------------------
repository_name = 'openstack/oslosphinx'
bug_project = 'oslosphinx'
bug_tag = ''
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
oslosphinx_cgit_link = 'https://git.openstack.org/cgit/openstack/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'oslosphinx'
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'
# -- 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 = 'openstackdocs'
# 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}

@ -1,5 +0,0 @@
==============
Contributing
==============
.. include:: ../../CONTRIBUTING.rst

@ -1 +0,0 @@
.. include:: ../../ChangeLog

@ -1,36 +0,0 @@
============================================
oslosphinx --- OpenStack Sphinx Extensions
============================================
oslosphinx contains the theme and extension support for Sphinx
documentation from the OpenStack project.
.. toctree::
:maxdepth: 2
usage
check_blueprints
contributing
Release Notes
=============
.. toctree::
:maxdepth: 1
history
Development
===========
.. toctree::
:maxdepth: 1
theme_check
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

@ -1,25 +0,0 @@
===========
Theme check
===========
This page is used to check the themes provided by oslosphinx.
.. note::
A comment with additional information that explains a part of the text.
.. important::
Something you must be aware of before proceeding.
.. tip::
An extra but helpful piece of practical advice.
.. Caution::
Helpful information that prevents the user from making mistakes.
.. Warning::
Critical information about the risk of data loss or security issues.

@ -1,52 +0,0 @@
============================
Using the oslosphinx Theme
============================
Guidelines
==========
Prior to using this theme, ensure your project can use the OpenStack
brand by referring to the brand guidelines at
https://www.openstack.org/brand. In particular, if the project is not
under OpenStack governance as an "official" project, it should not use
this theme.
If your documentation is not being published to an openstack.org site,
that may be a signal that you should not use this theme.
Sphinx Configuration
====================
To use the theme, add ``'oslosphinx'`` to the ``extensions`` list in
the ``conf.py`` file in your Sphinx project.
Incubating Projects
===================
If you are an incubating project, set::
html_theme_options = {'incubating': True}
in your conf.py as well, to enable the Incubation theme.
Linking to a Source Repository
==============================
``oslosphinx`` defines a configuration option ``oslosphinx_cgit_link``
which should be the URL to the git repository browser for the project
being documented. The default is a guess, and will be right for a lot
of projects, but to ensure that it is correct in all situations it is
best to set the value in conf.py::
oslosphinx_cgit_link = 'https://git.openstack.org/cgit/openstack/oslosphinx'
Showing Older Versions of Documentation
=======================================
``oslosphinx`` can automatically add links for previous versions of your
project's documentation to the sidebar. If this feature is enabled links
will be generated for each git tag. To enable this behavior, set::
html_theme_options = {'show_other_versions': True}
in your conf.py.

@ -1,101 +0,0 @@
# Copyright 2013 New Dream Network, LLC (DreamHost)
#
# 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 re
import six
from six.moves.urllib import parse
import string
import subprocess
CGIT_BASE = 'http://git.openstack.org/cgit/'
def _guess_cgit_link():
try:
git_remote = subprocess.check_output(
['git', 'config', '--local', '--get', 'remote.origin.url']
)
except Exception:
# git is not present or the command failed
return None
else:
if six.PY3:
git_remote = os.fsdecode(git_remote)
parsed = parse.urlparse(git_remote)
parsed = '/'.join(parsed.path.rstrip('/').split('/')[-2:])
parsed = re.sub(r'\.git$', '', parsed)
return CGIT_BASE + parsed
def _html_page_context(app, pagename, templatename, context, doctree):
# Insert the cgit link into the template context.
context['cgit_link'] = app.config.oslosphinx_cgit_link
context['other_versions'] = _get_other_versions(app)
return None
def _get_other_versions(app):
if not app.config.html_theme_options.get('show_other_versions', False):
return []
git_cmd = ["git", "tag"]
try:
raw_version_list = subprocess.Popen(
git_cmd, stdout=subprocess.PIPE).communicate()[0]
raw_version_list = raw_version_list.decode("utf8")
except OSError:
app.warn('Cannot get tags from git repository. '
'Not setting "other_versions".')
raw_version_list = u''
# grab last five that start with a number and reverse the order
_tags = [t.strip("'") for t in raw_version_list.split('\n')]
other_versions = [
t for t in _tags if t and t[0] in string.digits
# Don't show alpha, beta or release candidate tags
and 'rc' not in t and 'a' not in t and 'b' not in t
][:-5:-1]
return other_versions
def builder_inited(app):
theme_dir = os.path.join(os.path.dirname(__file__), 'theme')
app.info('Using openstack theme from %s' % theme_dir)
# Insert our theme directory at the front of the search path and
# force the theme setting to use the one in the package unless
# another openstack theme is already selected. This is done here,
# instead of in setup(), because conf.py is read after setup()
# runs, so if the conf contains these values the user values
# overwrite these. That's not bad for the theme, but it breaks the
# search path.
app.config.html_theme_path.insert(0, theme_dir)
# Set the theme name
if not app.config.html_theme.startswith('openstack'):
app.config.html_theme = 'openstack'
# Re-initialize the builder, if it has the method for setting up
# the templates and theme.
if hasattr(app.builder, 'init_templates'):
app.builder.init_templates()
# Register our page context additions
app.connect('html-page-context', _html_page_context)
def setup(app):
app.connect('builder-inited', builder_inited)
# Try to guess at the default value for where the cgit repository
# is.
cgit_link = _guess_cgit_link()
app.add_config_value('oslosphinx_cgit_link', cgit_link, 'env')

@ -1,130 +0,0 @@
# 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.
"""Ensure that the name of the spec file matches the name of a blueprint.
"""
import requests
class BlueprintChecker(object):
def __init__(self, app):
self.app = app
self.project_names = []
self._good_bps = set()
self._prefix = None
self._warn_search = 'unset'
BP_URL_TEMPLATE = 'https://api.launchpad.net/devel/%s/+spec/%s'
PROJ_LIST_URL_TEMPLATE = 'https://api.launchpad.net/1.0/%s/projects'
def _load_project_settings(self):
if self.project_names:
return
# If a project_name is set in the configuration, use
# that. Otherwise, allow any project in the project group.
project_name = self.app.config.check_blueprints_project
pg_name = self.app.config.check_blueprints_project_group
if project_name:
self.project_names = [project_name]
self._warn_search = 'the %s project' % project_name
else:
proj_list_response = requests.get(self.PROJ_LIST_URL_TEMPLATE
% pg_name)
projects = proj_list_response.json()['entries']
self.project_names = [p['name'] for p in projects]
self._warn_search = ('any projects in the %s project group'
% pg_name)
@property
def desired_prefix(self):
"""Determine the prefix for files we care to check.
We only care about blueprints in the current release, if the
check_blueprints_release option is set.
"""
if self._prefix is None:
release = self.app.config.check_blueprints_release
if release:
self._prefix = 'specs/%s/' % release
else:
self._prefix = 'specs/'
return self._prefix
def doctree_resolved(self, app, doctree, docname):
"""Hook registered as event handler."""
if not docname.startswith(self.desired_prefix):
return
bp_name = docname.split('/')[-1]
if bp_name == 'index':
return
self.check(bp_name)
def blueprint_exists(self, project_name, bp_name):
"""Return boolean indicating whether the blueprint exists."""
self.app.info('Checking for %s in %s' % (bp_name, project_name))
url = self.BP_URL_TEMPLATE % (project_name, bp_name)
response = requests.get(url)
if response.status_code == 200:
self.app.info('Found %s in %s' % (bp_name, project_name))
return True
return False
def check(self, bp_name):
"""Given one blueprint name, check to see if it is valid."""
if bp_name in self._good_bps:
return True
self._load_project_settings()
self.app.info('') # emit newline
candidate_project, dash, bp_name_to_find = bp_name.partition('-')
if candidate_project in self.project_names:
# First check the shortened name of the blueprint in the project.
if self.blueprint_exists(candidate_project, bp_name_to_find):
return
# Then check the full name of the blueprint in the project.
if self.blueprint_exists(candidate_project, bp_name):
return
self.app.info(
('Blueprint name %r looks like it starts with a project '
'name, but %r was not found in project %r') %
(bp_name, bp_name_to_find, candidate_project)
)
else:
self.app.info(
'Blueprint checking is faster if the file names '
'start with the launchpad project name.'
)
for project_name in self.project_names:
if self.blueprint_exists(project_name, bp_name):
self._good_bps.add(bp_name)
break
else:
self.app.warn(
'Could not find a blueprint called %r in %s'
% (bp_name, self._warn_search),
location=(bp_name, 0),
)
raise ValueError(
'Document %s does not match any blueprint name in %s'
% (bp_name, self._warn_search))
def setup(app):
app.info('Initializing %s' % __name__)
checker = BlueprintChecker(app)
app.connect('doctree-resolved', checker.doctree_resolved)
app.add_config_value('check_blueprints_project_group', 'openstack', 'env')
app.add_config_value('check_blueprints_project', '', 'env')
app.add_config_value('check_blueprints_release', '', 'env')

@ -1,71 +0,0 @@
# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
#
# 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.
"""Intersphinx mapping file for the OpenStack projects.
To use this mapping in a project, first add 'sphinx.ext.intersphinx' to
your extensions list in conf.py. Then::
from oslosphinx import intersphinx
intersphinx_mapping = intersphinx.mapping
You'll be able to link to other project's documentation, such as:
:ref:`virtual-environments <nova:virtual-environments>`
"""
mapping = dict(
# OpenStack Projects
ceilometer=('http://docs.openstack.org/developer/ceilometer/', None),
cinder=('http://docs.openstack.org/developer/cinder/', None),
glance=('http://docs.openstack.org/developer/glance/', None),
heat=('http://docs.openstack.org/developer/heat/', None),
horizon=('http://docs.openstack.org/developer/horizon/', None),
ironic=('http://docs.openstack.org/developer/ironic/', None),
keystone=('http://docs.openstack.org/developer/keystone/', None),
nova=('http://docs.openstack.org/developer/nova/', None),
oslo_config=('http://docs.openstack.org/developer/oslo.config/', None),
oslo_messaging=(
'http://docs.openstack.org/developer/oslo.messaging/', None),
ceilometerclient=(
'http://docs.openstack.org/developer/python-ceilometerclient/', None),
cinderclient=(
'http://docs.openstack.org/developer/python-cinderclient/', None),
glanceclient=(
'http://docs.openstack.org/developer/python-glanceclient/', None),
heatclient=(
'http://docs.openstack.org/developer/python-heatclient/', None),
ironicclient=(
'http://docs.openstack.org/developer/python-ironicclient/', None),
keystoneclient=(
'http://docs.openstack.org/developer/python-keystoneclient/', None),
novaclient=(
'http://docs.openstack.org/developer/python-novaclient/', None),
openstackclient=(
'http://docs.openstack.org/developer/python-openstackclient/', None),
neutronclient=(
'http://docs.openstack.org/developer/python-neutronclient/', None),
swiftclient=(
'http://docs.openstack.org/developer/python-swiftclient/', None),
troveclient=(
'http://docs.openstack.org/developer/python-troveclient/', None),
neutron=('http://docs.openstack.org/developer/neutron/', None),
swift=('http://docs.openstack.org/developer/swift/', None),
trove=('http://docs.openstack.org/developer/trove/', None),
# Other things of note
python=('http://docs.python.org/', None),
infra=('http://docs.openstack.org/infra/system-config/', None),
zuul=('http://docs.openstack.org/infra/zuul/', None),
)

@ -1,121 +0,0 @@
{% extends "basic/layout.html" %}
{% set css_files = css_files + ['_static/tweaks.css'] %}
{% block sidebar2 %}
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
{%- if not embedded %}{% if not theme_nosidebar|tobool %}
{%- block sidebarlogo %}
{%- if logo %}
<p class="logo"><a href="{{ pathto(master_doc) }}">
<img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
</a></p>
{%- endif %}
{%- endblock %}
{%- block sidebartoc %}
{%- if display_toc %}
<h3>{{ _('Table Of Contents') }}</h3>
<ul><li><a href="{{ pathto(master_doc) }}">Return to project home page</a></li></ul>
{{ toc }}
{%- endif %}
{%- endblock %}
{%- block sidebarrel %}
{%- if prev %}
<h4>{{ _('Previous topic') }}</h4>
<p class="topless"><a href="{{ prev.link|e }}"
title="{{ _('previous chapter') }}">{{ prev.title }}</a></p>
{%- endif %}
{%- if next %}
<h4>{{ _('Next topic') }}</h4>
<p class="topless"><a href="{{ next.link|e }}"
title="{{ _('next chapter') }}">{{ next.title }}</a></p>
{%- endif %}
{%- endblock %}
{%- block otherversions %}
{%- if other_versions %}
<h3>{{ _('Other Versions') }}</h3>
<ul class="this-page-menu">
<li><a href="{{ pathto(master_doc) }}" rel="nofollow">Current</a></li>
{%- for ver in other_versions: %}
<li><a href="{{ pathto(ver, 1) }}" rel="nofollow">{{ ver }}</a></li>
{%- endfor %}
</ul>
{%- endif %}
{%- endblock %}
{%- block projectsource %}
{%- if cgit_link %}
<h3>{{ _('Project Source') }}</h3>
<ul class="this-page-menu">
<li><a href="{{cgit_link}}"
rel="nofollow">{{ _('Project Source') }}</a></li>
</ul>
{%- endif %}
{%- endblock %}
{%- block sidebarsourcelink %}
{%- if show_source and has_source and sourcename %}
<h3>{{ _('This Page') }}</h3>
<ul class="this-page-menu">
<li><a href="{{ pathto('_sources/' + sourcename, true)|e }}"
rel="nofollow">{{ _('Show Source') }}</a></li>
</ul>
{%- endif %}
{%- endblock %}
{%- if customsidebar %}
{% include customsidebar %}
{%- endif %}
{%- block sidebarsearch %}
{%- if pagename != "search" %}
<div id="searchbox" style="display: none">
<h3>{{ _('Quick search') }}</h3>
<form class="search" action="{{ pathto('search') }}" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="{{ _('Go') }}" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
{{ _('Enter search terms or a module, class or function name.') }}
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
{%- endif %}
{%- endblock %}
{%- endif %}{% endif %}
</div>
</div>
{% endblock %}
{% block relbar1 %}{% endblock relbar1 %}
{% block header %}
<div id="header">
<h1 id="logo"><a href="https://www.openstack.org/">OpenStack</a></h1>
<ul id="navigation">
{% block header_navigation %}
<li><a href="https://www.openstack.org/" title="Go to the Home page" class="link">Home</a></li>
<li><a href="https://www.openstack.org/projects/" title="Go to the OpenStack Projects page">Projects</a></li>
<li><a href="https://www.openstack.org/user-stories/" title="Go to the User Stories page" class="link">User Stories</a></li>
<li><a href="https://www.openstack.org/community/" title="Go to the Community page" class="link">Community</a></li>
<li><a href="https://www.openstack.org/blog/" title="Go to the OpenStack Blog">Blog</a></li>
<li><a href="https://wiki.openstack.org/" title="Go to the OpenStack Wiki">Wiki</a></li>
<li><a href="https://docs.openstack.org/" title="Go to OpenStack Documentation" class="current">Documentation</a></li>
{% endblock %}
</ul>
</div>
{% endblock %}
{% block footer %}
{{ super() }}
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
try {
//Tracking docs.openstack.org/developer/<projectname> only
//The URL is built from the project variable in conf.py
var pageTracker = _gat._getTracker("UA-17511903-1");
pageTracker._setCookiePath("/developer/{{ project }}");
pageTracker._trackPageview();
} catch(err) {}</script>
{% endblock %}

@ -1,419 +0,0 @@
/**
* Sphinx stylesheet -- basic theme
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
/* -- main layout ----------------------------------------------------------- */
div.clearer {
clear: both;
}
/* -- relbar ---------------------------------------------------------------- */
div.related {
font-size: 90%;
}
div.related h3 {
display: none;
}
div.related ul {
margin: 0;
padding: 0 0 0 10px;
list-style: none;
}
div.related li {
display: inline;
}
div.related li.right {
float: right;
margin-right: 5px;
}
/* -- sidebar --------------------------------------------------------------- */
div.sphinxsidebarwrapper {
padding: 10px 5px 0 10px;
}
div.sphinxsidebar {
float: left;
width: 260px;
margin-left: -100%;
font-size: 90%;
}
div.sphinxsidebar ul {
list-style: none;
}
div.sphinxsidebar ul ul,
div.sphinxsidebar ul.want-points {
margin-left: 20px;
list-style: square;
}
div.sphinxsidebar ul ul {
margin-top: 0;
margin-bottom: 0;
}
div.sphinxsidebar form {
margin-top: 10px;
}
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
div.sphinxsidebar span.pre {
word-wrap: break-word;
}
img {
border: 0;
}
/* -- search page ----------------------------------------------------------- */
ul.search {
margin: 10px 0 0 20px;
padding: 0;
}
ul.search li {
padding: 5px 0 5px 20px;
background-image: url(file.png);
background-repeat: no-repeat;
background-position: 0 7px;
}
ul.search li a {
font-weight: bold;
}
ul.search li div.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
}
ul.keywordmatches li.goodmatch a {
font-weight: bold;
}
/* -- index page ------------------------------------------------------------ */
table.contentstable {
width: 90%;
}
table.contentstable p.biglink {
line-height: 150%;
}
a.biglink {
font-size: 1.3em;
}
span.linkdescr {
font-style: italic;
padding-top: 5px;
font-size: 90%;
}
/* -- general index --------------------------------------------------------- */
table.indextable td {
text-align: left;
vertical-align: top;
}
table.indextable dl, table.indextable dd {
margin-top: 0;
margin-bottom: 0;
}
table.indextable tr.pcap {
height: 10px;
}
table.indextable tr.cap {
margin-top: 10px;
background-color: #f2f2f2;
}
img.toggler {
margin-right: 3px;
margin-top: 3px;
cursor: pointer;
}
/* -- general body styles --------------------------------------------------- */
a.headerlink {
visibility: hidden;
}
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink {
visibility: visible;
}
div.body p.caption {
text-align: inherit;
}
div.body td {
text-align: left;
}
.field-list ul {
padding-left: 1em;
}
.first {
}
p.rubric {
margin-top: 30px;
font-weight: bold;
}
/* -- sidebars -------------------------------------------------------------- */
div.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #ddb;
padding: 7px 7px 0 7px;
background-color: #ffe;
width: 40%;
float: right;
}
p.sidebar-title {
font-weight: bold;
}
/* -- topics ---------------------------------------------------------------- */
div.topic {
border: 1px solid #ccc;
padding: 7px 7px 0 7px;
margin: 10px 0 10px 0;
}
p.topic-title {
font-size: 1.1em;
font-weight: bold;
margin-top: 10px;
}
/* -- admonitions ----------------------------------------------------------- */
div.admonition {
margin-top: 10px;
margin-bottom: 10px;
padding: 7px;
}
div.admonition dt {
font-weight: bold;
}
div.admonition dl {
margin-bottom: 0;
}
p.admonition-title {
margin: 0px 10px 5px 0px;
font-weight: bold;
}
div.body p.centered {
text-align: center;
margin-top: 25px;
}
/* -- tables ---------------------------------------------------------------- */
table.docutils {
border: 0;
border-collapse: collapse;
}
table.docutils td, table.docutils th {
padding: 1px 8px 1px 0;
border-top: 0;
border-left: 0;
border-right: 0;
border-bottom: 1px solid #aaa;
}
table.field-list td, table.field-list th {
border: 0 !important;
}
table.footnote td, table.footnote th {
border: 0 !important;
}
th {
text-align: left;
padding-right: 5px;
}
/* -- other body styles ----------------------------------------------------- */
dl {
margin-bottom: 15px;
}
dd p {
margin-top: 0px;
}
dd ul, dd table {
margin-bottom: 10px;
}
dd {
margin-top: 3px;
margin-bottom: 10px;
margin-left: 30px;
}
dt:target, .highlight {
background-color: #fbe54e;
}
dl.glossary dt {
font-weight: bold;
font-size: 1.1em;
}
.field-list ul {
margin: 0;
padding-left: 1em;
}
.field-list p {
margin: 0;
}
.refcount {
color: #060;
}
.optional {
font-size: 1.3em;
}
.versionmodified {
font-style: italic;
}
.system-message {
background-color: #fda;
padding: 5px;
border: 3px solid red;
}
.footnote:target {
background-color: #ffa
}
.line-block {
display: block;
margin-top: 1em;
margin-bottom: 1em;
}
.line-block .line-block {
margin-top: 0;
margin-bottom: 0;
margin-left: 1.5em;
}
/* -- code displays --------------------------------------------------------- */
pre {
overflow: auto;
}
td.linenos pre {
padding: 5px 0px;
border: 0;
background-color: transparent;
color: #aaa;
}
table.highlighttable {
margin-left: 0.5em;
}
table.highlighttable td {
padding: 0 0.5em 0 0.5em;
}
tt.descname {
background-color: transparent;
font-weight: bold;
font-size: 1.2em;
}
tt.descclassname {
background-color: transparent;
}
tt.xref, a tt {
background-color: transparent;
font-weight: bold;
}
h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
background-color: transparent;
}
/* -- math display ---------------------------------------------------------- */
img.math {
vertical-align: middle;
}
div.body div.math p {
text-align: center;
}
span.eqno {
float: right;
}
/* -- printout stylesheet --------------------------------------------------- */
@media print {
div.document,
div.documentwrapper,
div.bodywrapper {
margin: 0 !important;
width: 100%;
}
div.sphinxsidebar,
div.related,
div.footer,
#top-link {
display: none;
}
}

@ -1,230 +0,0 @@
/**
* Sphinx stylesheet -- default theme
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
@import url("basic.css");
/* -- page layout ----------------------------------------------------------- */
body {
font-family: sans-serif;
font-size: 100%;
background-color: #11303d;
color: #000;
margin: 0;
padding: 0;
}
div.document {
background-color: #1c4e63;
}
div.documentwrapper {
float: left;
width: 100%;
}
div.bodywrapper {
margin: 0 0 0 230px;
}
div.body {
background-color: #ffffff;
color: #000000;
padding: 0 20px 30px 20px;
}
div.footer {
color: #ffffff;
width: 100%;
padding: 9px 0 9px 0;
text-align: center;
font-size: 75%;
}
div.footer a {
color: #ffffff;
text-decoration: underline;
}
div.related {
background-color: #133f52;
line-height: 30px;
color: #ffffff;
}
div.related a {
color: #ffffff;
}
div.sphinxsidebar {
}
div.sphinxsidebar h3 {
font-family: 'Trebuchet MS', sans-serif;
color: #ffffff;
font-size: 1.4em;
font-weight: normal;
margin: 0;
padding: 0;
}
div.sphinxsidebar h3 a {
color: #ffffff;
}
div.sphinxsidebar h4 {
font-family: 'Trebuchet MS', sans-serif;
color: #ffffff;
font-size: 1.3em;
font-weight: normal;
margin: 5px 0 0 0;
padding: 0;
}
div.sphinxsidebar p {
color: #ffffff;
}
div.sphinxsidebar p.topless {
margin: 5px 10px 10px 10px;
}
div.sphinxsidebar ul {
margin: 10px;
padding: 0;
color: #ffffff;
}
div.sphinxsidebar a {
color: #98dbcc;
}
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
/* -- body styles ----------------------------------------------------------- */
a {
color: #355f7c;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
div.body p, div.body dd, div.body li {
text-align: left;
line-height: 130%;
}
div.body h1,
div.body h2,
div.body h3,
div.body h4,
div.body h5,
div.body h6 {
font-family: 'Trebuchet MS', sans-serif;
background-color: #f2f2f2;
font-weight: normal;
color: #20435c;
border-bottom: 1px solid #ccc;
margin: 20px -20px 10px -20px;
padding: 3px 0 3px 10px;
}
div.body h1 { margin-top: 0; font-size: 200%; }
div.body h2 { font-size: 160%; }
div.body h3 { font-size: 140%; }
div.body h4 { font-size: 120%; }
div.body h5 { font-size: 110%; }
div.body h6 { font-size: 100%; }
a.headerlink {
color: #c60f0f;
font-size: 0.8em;
padding: 0 4px 0 4px;
text-decoration: none;
}
a.headerlink:hover {
background-color: #c60f0f;
color: white;
}
div.body p, div.body dd, div.body li {
text-align: left;
line-height: 130%;
}
div.admonition p.admonition-title + p {
display: inline;
}
div.admonition p {
margin-bottom: 5px;
}
div.admonition pre {
margin-bottom: 5px;
}
div.admonition ul, div.admonition ol {
margin-bottom: 5px;
}
div.note {
background-color: #eee;
border: 1px solid #ccc;
}
div.seealso {
background-color: #ffc;