<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type"/>
<title>OpenStack Docs: OpenStack Sphinx Extensions</title>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- CSS references are in the css.html template -->
<!-- Bootstrap Core CSS -->
<link href="_static/css/bootstrap.min.css" rel="stylesheet">
<!-- Custom CSS -->
<link href="_static/css/combined.css" rel="stylesheet">
<link href="_static/css/styles.css" rel="stylesheet">
<!-- Fonts -->
<!--<link href="font-awesome.min.css" rel="stylesheet">-->
<link href="http://maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet">
<link href='http://fonts.googleapis.com/css?family=Open+Sans:300,400,700' rel='stylesheet' type='text/css'>
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
<!-- Page-specific CSS -->
</head>
<body>
<!-- Header -->
<!-- Header Navigation -->
<nav class="navbar navbar-default inner" role="navigation">
<div class="container">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" class="navbar-toggle"
data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<div class="brand-wrapper">
<a class="navbar-brand" href="/"></a>
</div>
<div class="search-icon show"><i class="fa fa-search"></i>
Search</div>
</div>
<!-- Collect the nav links, forms, and other content for toggling
-->
<div class="collapse navbar-collapse"
id="bs-example-navbar-collapse-1">
<div class="search-container tiny">
<div id="gcse">
<script type="text/javascript">
(function() {
var cx = '000108871792296872333:noj9nikm74i';
var gcse = document.createElement('script');
gcse.type = 'text/javascript';
gcse.async = true;
gcse.src = (document.location.protocol == 'https:' ? 'https:' :
'http:') +
'//www.google.com/cse/cse.js?cx=' + cx;
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(gcse, s);
})();
</script>
<gcse:search gname="standard"></gcse:search>
</div>
<i class="fa fa-times close-search"></i>
</div>
<ul class="nav navbar-nav navbar-main show">
<li>
<div id="gcse-mobile">
<gcse:search gname="mobile"></gcse:search>
</div>
</li>
<li>
<a href="http://www.openstack.org/software/" class="drop"
id="dropdownMenuSoftware">Software <i class="fa fa-caret-down"></i></a>
<ul class="dropdown-menu" role="menu"
aria-labelledby="dropdownMenuSoftware">
<li role="presentation"><a
role="menuitem" tabindex="-1" href="http://www.openstack.org/software/">Overview</a></li>
<li role="presentation"
class="divider"></li>
<li role="presentation"><a
role="menuitem" tabindex="-1"
href="http://www.openstack.org/software/openstack-compute/">Compute</a></li>
<li role="presentation"><a
role="menuitem" tabindex="-1"
href="http://www.openstack.org/software/openstack-storage/">Storage</a></li>
<li role="presentation"><a
role="menuitem" tabindex="-1"
href="http://www.openstack.org/software/openstack-networking/">Networking</a></li>
<li role="presentation"><a
role="menuitem" tabindex="-1"
href="http://www.openstack.org/software/openstack-dashboard/">Dashboard</a></li>
<li role="presentation"><a
role="menuitem" tabindex="-1"
href="http://www.openstack.org/software/openstack-shared-services/">Shared Services</a></li>
<li role="presentation"
class="divider"></li>
<li role="presentation"><a
role="menuitem" tabindex="-1" href="http://www.openstack.org/software/start/">Get
Started</a></li>
</ul>
</li>
<li>
<a href="http://www.openstack.org/user-stories/" class="drop"
id="dropdownMenuUsers">Users <i class="fa fa-caret-down"></i></a>
<ul class="dropdown-menu" role="menu"
aria-labelledby="dropdownMenuUsers">
<li role="presentation"><a
role="menuitem" tabindex="-1" href="http://www.openstack.org/user-stories/">Overview</a></li>
<li role="presentation"
class="divider"></li>
<li role="presentation"><a
role="menuitem" tabindex="-1" href="//superuser.openstack.org/">Superuser
Magazine</a></li>
<li role="presentation"><a
role="menuitem" tabindex="-1"
href="http://www.openstack.org/enterprise/auto/">Featured: Top 10
Automaker</a></li>
</ul>
</li>
<li>
<a href="http://www.openstack.org/community/" class="drop"
id="dropdownMenuCommunity">Community <i class="fa fa-caret-down"></i></a>
<ul class="dropdown-menu" role="menu"
aria-labelledby="dropdownMenuCommunity">
<li role="presentation"><a
role="menuitem" tabindex="-1" href="http://www.openstack.org/community/">Welcome! Start Here</a></li>
<li role="presentation"><a
role="menuitem" tabindex="-1" href="//ask.openstack.org/">Ask A Technical
Question</a></li>
<li role="presentation"><a
role="menuitem" tabindex="-1"
href="//wiki.openstack.org/wiki/Main_Page">OpenStack Wiki</a></li>
<li role="presentation"><a
role="menuitem" tabindex="-1"
href="//www.openstack.org/community/events/">Community Events</a></li>
<li role="presentation"><a
role="menuitem" tabindex="-1"
href="//wiki.openstack.org/wiki/Getting_The_Code">Source Code</a></li>
<li role="presentation"
class="divider"></li>
<li role="presentation"><a
role="menuitem" tabindex="-1"
href="//www.openstack.org/foundation/companies/">Supporting Companies</a></li>
<li role="presentation"><a
role="menuitem" tabindex="-1"
href="//www.openstack.org/community/jobs/">Jobs</a></li>
<li role="presentation"
class="divider"></li>
<li role="presentation"><a
role="menuitem" tabindex="-1" href="//www.openstack.org/join/">Join The
Community</a></li>
</ul>
</li>
<li>
<a href="http://www.openstack.org/marketplace/">Marketplace</a>
</li>
<li>
<a href="http://www.openstack.org/events/" class="drop"
id="dropdownMenuEvents">Events <i class="fa fa-caret-down"></i></a>
<ul class="dropdown-menu" role="menu"
aria-labelledby="dropdownMenuEvents">
<li role="presentation"><a
role="menuitem" tabindex="-1"
href="//www.openstack.org/community/events/">Overview</a></li>
<li role="presentation"><a
role="menuitem" tabindex="-1"
href="//www.openstack.org/summit/openstack-paris-summit-2014/">The OpenStack
Summit</a></li>
<li role="presentation"><a
role="menuitem" tabindex="-1" href="//www.openstack.org/community/events/">More
OpenStack Events</a></li>
</ul>
</li>
<li>
<a href="http://www.openstack.org/blog/">Blog</a>
</li>
<li>
<a href="http://docs.openstack.org/">Docs</a>
</li>
<li>
<a href="http://openstack.org/Security/login/"
class="sign-in-btn">Sign In</a>
</li>
</ul>
</div>
<!-- /.navbar-collapse -->
</div>
<!-- /.container -->
</nav>
<!-- Begin Page Content -->
<div class="container docs-book-wrapper">
<div class="row">
<div class="col-lg-9 col-md-8 col-sm-8 col-lg-push-3 col-md-push-4 col-sm-push-4">
<!-- Row with title and buttons-->
<div class="row">
<div class="col-lg-8">
<h2>OpenStack Sphinx Extensions</h2>
</div>
<div class="col-lg-4">
<div class="docs-actions">
<a href="#"><i class="fa fa-rss" data-toggle="tooltip" data-placement="top" title="RSS Feed"></i></a>
<a href="#"><i class="fa fa-cloud-download" data-toggle="tooltip" data-placement="top" title="Download PDF"></i></a>
<a href="#"><i class="fa fa-info-circle" data-toggle="tooltip" data-placement="top" title="Toggle Definitions" id="toggle-definitions"></i></a>
<a href="http://bugs.launchpad.net"><i class="fa fa-bug" data-toggle="tooltip" data-placement="top" title="Report a Bug"></i></a>
</div>
</div>
</div>
<div class="row docs-byline">
<div class="docs-updated">
updated: None | release: 1.0
</div>
<a href="http://git.openstack.org/" class="docs-edit">
<i class="fa fa-pencil"></i> suggest edits
</a>
</div>
<div class="row">
<div class="col-lg-12">
<div class="docs-top-contents">
<h5>Contents</h5>
<ul>
<li><a class="reference internal" href="#">OpenStack Sphinx Extensions</a></li>
</ul>
</div>
<div class="docs-body">
<div class="section" id="openstack-sphinx-extensions">
<h1>OpenStack Sphinx Extensions<a class="headerlink" href="#openstack-sphinx-extensions" title="Permalink to this headline">¶</a></h1>
<p>Theme and extension support for Sphinx documentation from the
OpenStack project.</p>
<ul class="simple">
<li>Free software: Apache License, Version 2.0</li>
<li>Documentation: <a class="reference external" href="http://docs.openstack.org/developer/oslosphinx">http://docs.openstack.org/developer/oslosphinx</a></li>
<li>Source: <a class="reference external" href="http://git.openstack.org/cgit/openstack/oslosphinx">http://git.openstack.org/cgit/openstack/oslosphinx</a></li>
<li>Bugs: <a class="reference external" href="http://bugs.launchpad.net/oslosphinx">http://bugs.launchpad.net/oslosphinx</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="docs-tags">
<a href="#" class="docs-tag">Network Time Protocol (NTP)</a>
<a href="#" class="docs-tag">Security</a>
<a href="#" class="docs-tag">Conceptual architecture</a>
</div>
<div class="row docs-byline bottom">
<div class="docs-updated">
updated: None | release: 1.0
</div>
<a href="http://git.openstack.org/" class="docs-edit">
<i class="fa fa-pencil"></i> suggest edits
</a>
</div>
<div class="row">
<div class="col-lg-8 col-md-8 col-sm-8 docs-license">
<img src="_static/images/docs/license.jpg" alt="Creative Commons Attribution Share Alike 3.0 License"/>
<p>
Except where otherwise noted, this document is licensed under Creative Commons Attribution Share Alike 3.0 License
<a href="#">http://creativecommons.org/licenses/by-sa/3.0/legalcode</a>.
</p>
<p>
<a href="http://www.openstack.org/legal">See All Legal Notices</a>
</p>
</div>
<div class="col-lg-4 col-md-4 col-sm-4 docs-actions-wrapper">
<a href="#" class="docs-footer-actions">
<i class="fa fa-bug"></i>found an error? report a bug
</a>
<a href="http://ask.openstack.org" class="docs-footer-actions">
<i class="fa fa-question-circle"></i>questions? <a href="http://ask.openstack.org/">ask.openstack.org</a>
</a>
</div>
</div>
</div>
<!-- Docs Sidebar --><!-- Docs Sidebar -->
<div class="col-lg-3 col-md-4 col-sm-4 col-lg-pull-9 col-md-pull-8 col-sm-pull-8 docs-sidebar">
<div class="docs-sidebar-search">
<form class='docs-main-search-form' method='post'><input type='hidden' name='form-name' value='form 1' />
<i class="fa fa-search docs-search-icon"></i>
<input type="search" class="docs-main-search" id="docs-book-search" placeholder="Search OpenStack Documentation">
</form>
</div>
<div class="btn-group docs-sidebar-releases">
<button onclick="location.href='/docs/'" class="btn docs-sidebar-home" data-toggle="tooltip" data-placement="top" title="Docs Home"><i class="fa fa-arrow-circle-o-left"></i></button>
<button href="#" type="button" data-toggle="dropdown" class="btn docs-sidebar-release-select">Release: Icehouse (May 2014)<i class="fa fa-caret-down"></i></button>
<ul class="dropdown-menu docs-sidebar-dropdown" role="menu" aria-labelledby="dLabel">
<li role="presentation" class="dropdown-header">Releases</li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="/trunk/">In progress (master branch)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="/juno/">Juno (current release)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="/icehouse/">Icehouse (May 2014)</a></li>
<li role="presentation" class="dropdown-header">Languages</li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="/ja/">日本語 (Japanese)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="/de/">Deutsch (German)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="/fr/">Français (French)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="/pt_BR/">Português (Portuguese)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="/zh_CN/">简体中文 (Simplified Chinese)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="/ko_KR/">한국의 (Korean)</a></li>
</ul>
</div>
<div class="docs-sidebar-toc">
<div class="docs-sidebar-section" id="install-guides">
<a class="docs-sidebar-section-title" href="http://docs.openstack.org/index.html#install-guides"><h4>Install Guides</h4></a>
</div>
<div class="docs-sidebar-section" id="user-guides">
<a class="docs-sidebar-section-title" href="http://docs.openstack.org/index.html#user-guides"><h4>User Guides</h4></a>
</div>
<div class="docs-sidebar-section" id="configuration-guides">
<a class="docs-sidebar-section-title" href="http://docs.openstack.org/index.html#configuration-guides"><h4>Configuration Guides</h4></a>
</div>
<div class="docs-sidebar-section" id="operations-guides">
<a class="docs-sidebar-section-title"><h4>Operations Guides</h4></a>
</div>
<div class="docs-sidebar-section" id="api-guides">
<a class="docs-sidebar-section-title" href="http://docs.openstack.org/index.html#api-guides"><h4>API Guides</h4></a>
</div>
<div class="docs-sidebar-section" id="contributor-guides">
<a class="docs-sidebar-section-title" href="http://docs.openstack.org/index.html#contributor-guides"><h4>Contributor Guides</h4></a>
</div>
</div>
</div>
</div>
</div>
<!-- End Page Content -->
<!-- Footer -->
<!-- Footer -->
<footer>
<div class="container">
<div class="row footer-links">
<div class="col-lg-2 col-sm-2">
<h3>OpenStack</h3>
<ul>
<li><a href="/foundation">About the Foundation</a></li>
<li><a
href="http://openstack.org/projects/">Projects</a></li>
<li><a
href="http://openstack.org/projects/openstack-security/">OpenStack
Security</a></li>
<li><a
href="http://openstack.org/projects/openstack-faq/">Common Questions</a></li>
<li><a href="http://openstack.org/blog/">Blog</a></li>
</ul>
</div>
<div class="col-lg-2 col-sm-2">
<h3>Community</h3>
<ul>
<li><a href="http://openstack.org/community/">User
Groups</a></li>
<li><a
href="http://openstack.org/community/events/">Events</a></li>
<li><a
href="http://openstack.org/community/jobs/">Jobs</a></li>
<li><a
href="http://openstack.org/foundation/companies/">Companies</a></li>
<li><a
href="https://wiki.openstack.org/wiki/How_To_Contribute">Contribute</a></li>
</ul>
</div>
<div class="col-lg-2 col-sm-2">
<h3>Documentation</h3>
<ul>
<li><a href="http://docs.openstack.org">OpenStack
Manuals</a></li>
<li><a
href="http://openstack.org/software/start/">Getting Started</a></li>
<li><a href="http://developer.openstack.org">API
Documentation</a></li>
<li><a href="https://wiki.openstack.org">Wiki</a></li>
</ul>
</div>
<div class="col-lg-2 col-sm-2">
<h3>Branding & Legal</h3>
<ul>
<li><a href="http://openstack.org/brand/">Logos &
Guidelines</a></li>
<li><a
href="http://openstack.org/brand/openstack-trademark-policy/">Trademark
Policy</a></li>
<li><a href="http://openstack.org/privacy/">Privacy
Policy</a></li>
<li><a
href="https://wiki.openstack.org/wiki/How_To_Contribute#Contributors_License_Agreement">OpenStack
CLA</a></li>
</ul>
</div>
<div class="col-lg-4 col-sm-4">
<h3>Stay In Touch</h3>
<a href="https://twitter.com/OpenStack" target="_blank"
class="social-icons footer-twitter"></a>
<a href="https://www.facebook.com/openstack"
target="_blank" class="social-icons footer-facebook"></a>
<a href="https://www.linkedin.com/company/openstack"
target="_blank" class="social-icons footer-linkedin"></a>
<a href="https://www.youtube.com/user/OpenStackFoundation"
target="_blank" class="social-icons footer-youtube"></a>
<!-- <form class="form-inline">
<div class="form-group newsletter-form">
<label>Join Our Newsletter</label>
<input class="newsletter-input" type="input"
placeholder="Email">
<button type="submit"
class="newsletter-btn">Join</button>
</div>
</form> -->
<p class="fine-print">
The OpenStack project is provided under the Apache 2.0
license. Openstack.org is powered by <a href="http://rackspace.com"
target="_blank">Rackspace Cloud Computing</a>.
</p>
</div>
</div>
</div>
</footer>
<div class="footer-bottom">
<div class="container">
<form class="form-inline" id="FeedbackForm_FeedbackForm" action="/home/FeedbackForm" method="post" enctype="application/x-www-form-urlencoded">
<div class="form-group">
<div>
<input class="feedback-input" type="input" placeholder="Give Us Your Feedback On This Page">
<button type="submit" class="feedback-btn">Submit</button>
</div>
</div>
</form>
</div>
</div>
<!-- Scripts in: static directory-->
<!-- jQuery Version 1.11.0 -->
<script type="text/javascript" src="_static/jquery/jquery-1.11.0.js"></script>
<!-- Bootstrap Core JavaScript -->
<script type="text/javascript" src="_static/js/bootstrap.min.js"></script>
<!-- The rest of the JS -->
<script type="text/javascript" src="_static/js/navigation.js"></script>
<!-- Docs JS -->
<script type="text/javascript" src="_static/js/docs.js"></script>
<!-- Popovers -->
<script type="text/javascript" src="_static/js/webui-popover.js"></script>
<!-- Javascript for page -->
</body>
</html>
fbbcd7346e