Starting point for Sphinx theme for docs.openstack.org content
This commit is contained in:
commit
cf9c89fa9b
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
@ -0,0 +1 @@
|
||||
_build
|
16
CONTRIBUTING.rst
Normal file
16
CONTRIBUTING.rst
Normal file
@ -0,0 +1,16 @@
|
||||
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, using a doc-tools tag:
|
||||
|
||||
https://bugs.launchpad.net/openstack-manuals
|
12
HACKING.rst
Normal file
12
HACKING.rst
Normal file
@ -0,0 +1,12 @@
|
||||
OpenStack Docs Theme Style Commandments
|
||||
=======================================
|
||||
|
||||
- Step 1: Read the OpenStack Style Commandments
|
||||
http://docs.openstack.org/developer/hacking/
|
||||
- Step 2: Read on
|
||||
|
||||
Our Specific Commandments
|
||||
---------------------------------
|
||||
|
||||
Refer to https://wiki.openstack.org/wiki/Documentation/Conventions
|
||||
|
176
LICENSE
Normal file
176
LICENSE
Normal file
@ -0,0 +1,176 @@
|
||||
|
||||
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.
|
||||
|
177
Makefile
Normal file
177
Makefile
Normal file
@ -0,0 +1,177 @@
|
||||
# Makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = _build
|
||||
|
||||
# User-friendly check for sphinx-build
|
||||
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
|
||||
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
|
||||
endif
|
||||
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
|
||||
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
|
||||
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " singlehtml to make a single large HTML file"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " devhelp to make HTML files and a Devhelp project"
|
||||
@echo " epub to make an epub"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
||||
@echo " text to make text files"
|
||||
@echo " man to make manual pages"
|
||||
@echo " texinfo to make Texinfo files"
|
||||
@echo " info to make Texinfo files and run them through makeinfo"
|
||||
@echo " gettext to make PO message catalogs"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " xml to make Docutils-native XML files"
|
||||
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
|
||||
clean:
|
||||
rm -rf $(BUILDDIR)/*
|
||||
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
singlehtml:
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
htmlhelp:
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||
|
||||
qthelp:
|
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/os-doc-demo.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/os-doc-demo.qhc"
|
||||
|
||||
devhelp:
|
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/os-doc-demo"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/os-doc-demo"
|
||||
@echo "# devhelp"
|
||||
|
||||
epub:
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
latex:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||
"(use \`make latexpdf' here to do that automatically)."
|
||||
|
||||
latexpdf:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through pdflatex..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
latexpdfja:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through platex and dvipdfmx..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
text:
|
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
texinfo:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo
|
||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||
"(use \`make info' here to do that automatically)."
|
||||
|
||||
info:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo "Running Texinfo files through makeinfo..."
|
||||
make -C $(BUILDDIR)/texinfo info
|
||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||
|
||||
gettext:
|
||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||
@echo
|
||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
linkcheck:
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
|
||||
xml:
|
||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
||||
@echo
|
||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
||||
|
||||
pseudoxml:
|
||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
||||
@echo
|
||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
10
README.rst
Normal file
10
README.rst
Normal file
@ -0,0 +1,10 @@
|
||||
OpenStack Sphinx Extensions
|
||||
===========================
|
||||
|
||||
Theme and extension support for Sphinx documentation from the
|
||||
OpenStack project.
|
||||
|
||||
* Free software: Apache License, Version 2.0
|
||||
* Documentation: http://docs.openstack.org/developer/oslosphinx
|
||||
* Source: http://git.openstack.org/cgit/openstack/oslosphinx
|
||||
* Bugs: http://bugs.launchpad.net/oslosphinx
|
BIN
_build/doctrees/CONTRIBUTING.doctree
Normal file
BIN
_build/doctrees/CONTRIBUTING.doctree
Normal file
Binary file not shown.
BIN
_build/doctrees/HACKING.doctree
Normal file
BIN
_build/doctrees/HACKING.doctree
Normal file
Binary file not shown.
BIN
_build/doctrees/README.doctree
Normal file
BIN
_build/doctrees/README.doctree
Normal file
Binary file not shown.
BIN
_build/doctrees/environment.pickle
Normal file
BIN
_build/doctrees/environment.pickle
Normal file
Binary file not shown.
BIN
_build/doctrees/index.doctree
Normal file
BIN
_build/doctrees/index.doctree
Normal file
Binary file not shown.
4
_build/html/.buildinfo
Normal file
4
_build/html/.buildinfo
Normal file
@ -0,0 +1,4 @@
|
||||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: ff14f43a0a8d75b7349a6a31a4060e6b
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
460
_build/html/CONTRIBUTING.html
Normal file
460
_build/html/CONTRIBUTING.html
Normal file
@ -0,0 +1,460 @@
|
||||
<!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: </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/bootstrap.min.css" rel="stylesheet">
|
||||
|
||||
<!-- Custom CSS -->
|
||||
<link href="_static/combined.css" rel="stylesheet">
|
||||
<link href="_static/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 -->
|
||||
|
||||
<p>If you would like to contribute to the development of OpenStack,
|
||||
you must follow the steps in this page:</p>
|
||||
<blockquote>
|
||||
<div><a class="reference external" href="http://docs.openstack.org/infra/manual/developers.html">http://docs.openstack.org/infra/manual/developers.html</a></div></blockquote>
|
||||
<p>Once those steps have been completed, changes to OpenStack
|
||||
should be submitted for review via the Gerrit tool, following
|
||||
the workflow documented at:</p>
|
||||
<blockquote>
|
||||
<div><a class="reference external" href="http://docs.openstack.org/infra/manual/developers.html#development-workflow">http://docs.openstack.org/infra/manual/developers.html#development-workflow</a></div></blockquote>
|
||||
<p>Pull requests submitted through GitHub will be ignored.</p>
|
||||
<p>Bugs should be filed on Launchpad, using a doc-tools tag:</p>
|
||||
<blockquote>
|
||||
<div><a class="reference external" href="https://bugs.launchpad.net/openstack-manuals">https://bugs.launchpad.net/openstack-manuals</a></div></blockquote>
|
||||
|
||||
|
||||
|
||||
<!-- 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: -->
|
||||
<!-- jQuery Version 1.11.0 -->
|
||||
<script type="text/javascript" src="jquery-1.11.0.js"></script>
|
||||
|
||||
<!-- Bootstrap Core JavaScript -->
|
||||
<script type="text/javascript" src="bootstrap.min.js"></script>
|
||||
|
||||
<!-- The rest of the JS -->
|
||||
<script type="text/javascript" src="navigation.js"></script>
|
||||
|
||||
<!-- Docs JS -->
|
||||
<script type="text/javascript" src="docs.js"></script>
|
||||
|
||||
<!-- Popovers -->
|
||||
<script type="text/javascript" src="webui-popover.js"></script>
|
||||
|
||||
<!-- Javascript for page -->
|
||||
</body>
|
||||
</html>
|
459
_build/html/HACKING.html
Normal file
459
_build/html/HACKING.html
Normal file
@ -0,0 +1,459 @@
|
||||
<!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: </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/bootstrap.min.css" rel="stylesheet">
|
||||
|
||||
<!-- Custom CSS -->
|
||||
<link href="_static/combined.css" rel="stylesheet">
|
||||
<link href="_static/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="section" id="openstack-docs-theme-style-commandments">
|
||||
<h1>OpenStack Docs Theme Style Commandments<a class="headerlink" href="#openstack-docs-theme-style-commandments" title="Permalink to this headline">¶</a></h1>
|
||||
<ul class="simple">
|
||||
<li>Step 1: Read the OpenStack Style Commandments
|
||||
<a class="reference external" href="http://docs.openstack.org/developer/hacking/">http://docs.openstack.org/developer/hacking/</a></li>
|
||||
<li>Step 2: Read on</li>
|
||||
</ul>
|
||||
<div class="section" id="our-specific-commandments">
|
||||
<h2>Our Specific Commandments<a class="headerlink" href="#our-specific-commandments" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Refer to <a class="reference external" href="https://wiki.openstack.org/wiki/Documentation/Conventions">https://wiki.openstack.org/wiki/Documentation/Conventions</a></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<!-- 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: -->
|
||||
<!-- jQuery Version 1.11.0 -->
|
||||
<script type="text/javascript" src="jquery-1.11.0.js"></script>
|
||||
|
||||
<!-- Bootstrap Core JavaScript -->
|
||||
<script type="text/javascript" src="bootstrap.min.js"></script>
|
||||
|
||||
<!-- The rest of the JS -->
|
||||
<script type="text/javascript" src="navigation.js"></script>
|
||||
|
||||
<!-- Docs JS -->
|
||||
<script type="text/javascript" src="docs.js"></script>
|
||||
|
||||
<!-- Popovers -->
|
||||
<script type="text/javascript" src="webui-popover.js"></script>
|
||||
|
||||
<!-- Javascript for page -->
|
||||
</body>
|
||||
</html>
|
458
_build/html/README.html
Normal file
458
_build/html/README.html
Normal file
@ -0,0 +1,458 @@
|
||||
<!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: </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/bootstrap.min.css" rel="stylesheet">
|
||||
|
||||
<!-- Custom CSS -->
|
||||
<link href="_static/combined.css" rel="stylesheet">
|
||||
<link href="_static/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>
|
||||
|
||||