openstackdocstheme-1.18.1/ 0000775 0001751 0001751 00000000000 13227214134 015510 5 ustar zuul zuul 0000000 0000000 openstackdocstheme-1.18.1/HACKING.rst 0000666 0001751 0001751 00000000501 13227213640 017305 0 ustar zuul zuul 0000000 0000000 OpenStack Docs Theme Style Commandments ======================================= - Step 1: Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/ - Step 2: Read on Our Specific Commandments --------------------------------- Refer to https://wiki.openstack.org/wiki/Documentation/Conventions openstackdocstheme-1.18.1/test-requirements.txt 0000666 0001751 0001751 00000000477 13227213640 021764 0 ustar zuul zuul 0000000 0000000 # The order of packages is significant, because pip processes them in the order # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 # this is required for the docs build jobs sphinx>=1.6.2 # BSD openstackdocstheme-1.18.1/CONTRIBUTING.rst 0000666 0001751 0001751 00000001052 13227213640 020152 0 ustar zuul zuul 0000000 0000000 If you would like to contribute to the development of OpenStack, you must follow the steps in this page: https://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: https://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 theme tag: https://launchpad.net/openstack-doc-tools openstackdocstheme-1.18.1/ChangeLog 0000664 0001751 0001751 00000026011 13227214133 017261 0 ustar zuul zuul 0000000 0000000 CHANGES ======= 1.18.1 ------ * Fix giturl parsing 1.18.0 ------ * Replace the http links with the right ones in docs * Attempt to guess valid Git URLs * Revert "Fix the incorrect git source url" * trivial: Remove use of 'Application.{warn,info}' * Fix the incorrect git source url * Do not print the release if empty * Adds -p option in mkdir for buildpdf tox env * bindep: Add dependencies for PDFs on Fedora * gitignore: Ignore more files * Updated from global requirements * Remove -U from pip install * Avoid tox\_install.sh for constraints support * Remove setting of version/release from releasenotes * Add zuulv3 native job * Adds Turkish landing page to sidebartoc\_menu * No red with double backticks markup 1.17.0 ------ * Updated from global requirements * Fix link to openstackdays * [www] Fix link to COA * Add support for sphinx sidebar role * Remove stray characters from demo * Update the configuration of generating a PDF document * Updated from global requirements * Sync language list with openstack-manuals repo * Bring back local search * Cleanup setup.cfg * Updated from global requirements * Break cycle dependency with reno * Updated from global requirements * Break cycle dependency with os-api-ref * Remove navigation.html * Update links in README * Updated from global requirements * Documents how to set conf.py for PDF generation * show release series names not version tags * Link to latest version 1.16.1 ------ * fix alignment of toc tree items in sidebar 1.16.0 ------ * Fix a logic issue in the JS * move the localtoc for the page into the sidebar * Serve minified CSS 1.15.0 ------ * Remove rules linked to a "Status" ID * Update 2 documentation URLs according to doc migration * Move from 3rd party fonts to native font stack * Fix Added / Changed / Deprecated notices * Standardise header styling * Add spaces in demo for deprecation notices * remove smooth scrolling 1.14.0 ------ * add a comment to all output HTML pages showing the input file * CSS: Add margin-left to
so that you can see white text on dark grey background * Adds another sample RST file for testing * Adds section for testing purposes * fix path to jquery * fix rst syntax * Use pathto() to compute relative paths to static files * Rename \_static to static * Clean up get\_html\_theme\_path * Don't force-inject the theme * Move theme files into correct formation * Update flake8 commands * Update .gitignore * Removes redundant static files and template files * Removes uneeded files * Adds rearranged files for rename to openstackdocstheme * Adds working links to navigation dropdown and column * Templates now support divs correctly * Adds title row, button row, updated rows, and sidebar * Starting point for Sphinx theme for docs.openstack.org content openstackdocstheme-1.18.1/requirements.txt 0000666 0001751 0001751 00000000420 13227213640 020773 0 ustar zuul zuul 0000000 0000000 # The order of packages is significant, because pip processes them in the order # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. pbr!=2.1.0,>=2.0.0 # Apache-2.0 dulwich>=0.15.0 # Apache-2.0 openstackdocstheme-1.18.1/LICENSE 0000666 0001751 0001751 00000023637 13227213640 016533 0 ustar zuul zuul 0000000 0000000 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. openstackdocstheme-1.18.1/openstackdocstheme.egg-info/ 0000775 0001751 0001751 00000000000 13227214134 023065 5 ustar zuul zuul 0000000 0000000 openstackdocstheme-1.18.1/openstackdocstheme.egg-info/requires.txt 0000664 0001751 0001751 00000000043 13227214133 025461 0 ustar zuul zuul 0000000 0000000 pbr!=2.1.0,>=2.0.0 dulwich>=0.15.0 openstackdocstheme-1.18.1/openstackdocstheme.egg-info/SOURCES.txt 0000664 0001751 0001751 00000015354 13227214134 024761 0 ustar zuul zuul 0000000 0000000 .zuul.yaml AUTHORS CONTRIBUTING.rst ChangeLog HACKING.rst LICENSE Makefile README.rst bindep.txt index.rst requirements.txt setup.cfg setup.py test-requirements.txt tox.ini api-ref/source/conf.py api-ref/source/image.inc api-ref/source/index.rst api-ref/source/parameters.yaml api-ref/source/service.inc api-ref/source/status.yaml api-ref/source/update-server-resp.json api-ref/source/_static/css/README.md doc/requirements.txt doc/source/conf.py doc/source/index.rst doc/source/_static/css/.placeholder doc/source/demo/configure_access_and_security_for_instances.rst doc/source/demo/create_and_manage_databases.rst doc/source/demo/create_and_manage_networks.rst doc/source/demo/dashboard_demo.rst doc/source/demo/index.rst doc/source/demo/launch-instance.rst doc/source/demo/section_dashboard_access_and_security.rst doc/source/demo/figures/dashboard-project-tab.png doc/source/demo/figures/dashboard_admin_project_tab.png doc/source/demo/figures/doc-logo-fox.jpg openstackdocstheme/__init__.py openstackdocstheme/version.py openstackdocstheme.egg-info/PKG-INFO openstackdocstheme.egg-info/SOURCES.txt openstackdocstheme.egg-info/dependency_links.txt openstackdocstheme.egg-info/not-zip-safe openstackdocstheme.egg-info/pbr.json openstackdocstheme.egg-info/requires.txt openstackdocstheme.egg-info/top_level.txt openstackdocstheme/theme/openstackdocs/css.html openstackdocstheme/theme/openstackdocs/footer.html openstackdocstheme/theme/openstackdocs/header.html openstackdocstheme/theme/openstackdocs/layout.html openstackdocstheme/theme/openstackdocs/license_cc.html openstackdocstheme/theme/openstackdocs/localtoc.html openstackdocstheme/theme/openstackdocs/script_footer.html openstackdocstheme/theme/openstackdocs/script_search.html openstackdocstheme/theme/openstackdocs/search.html openstackdocstheme/theme/openstackdocs/sidebartoc.html openstackdocstheme/theme/openstackdocs/sidebartoc_menu.html openstackdocstheme/theme/openstackdocs/sidebartoc_menu_apiref.html openstackdocstheme/theme/openstackdocs/swiftype_search.html openstackdocstheme/theme/openstackdocs/swiftype_search_install.html openstackdocstheme/theme/openstackdocs/swiftype_search_mobile.html openstackdocstheme/theme/openstackdocs/theme.conf openstackdocstheme/theme/openstackdocs/titlerow.html openstackdocstheme/theme/openstackdocs/static/favicon.ico openstackdocstheme/theme/openstackdocs/static/css/bootstrap.css openstackdocstheme/theme/openstackdocs/static/css/bootstrap.min.css openstackdocstheme/theme/openstackdocs/static/css/combined.css openstackdocstheme/theme/openstackdocs/static/css/font-awesome.css openstackdocstheme/theme/openstackdocs/static/css/font-awesome.min.css openstackdocstheme/theme/openstackdocs/static/css/native.css openstackdocstheme/theme/openstackdocs/static/fonts/.gitkeep openstackdocstheme/theme/openstackdocs/static/fonts/FontAwesome.otf openstackdocstheme/theme/openstackdocs/static/fonts/fontawesome-webfont.eot openstackdocstheme/theme/openstackdocs/static/fonts/fontawesome-webfont.svg openstackdocstheme/theme/openstackdocs/static/fonts/fontawesome-webfont.ttf openstackdocstheme/theme/openstackdocs/static/fonts/fontawesome-webfont.woff openstackdocstheme/theme/openstackdocs/static/fonts/fontawesome-webfont.woff2 openstackdocstheme/theme/openstackdocs/static/fonts/glyphicons-halflings-regular.eot openstackdocstheme/theme/openstackdocs/static/fonts/glyphicons-halflings-regular.svg openstackdocstheme/theme/openstackdocs/static/fonts/glyphicons-halflings-regular.ttf openstackdocstheme/theme/openstackdocs/static/fonts/glyphicons-halflings-regular.woff openstackdocstheme/theme/openstackdocs/static/fonts/glyphicons-halflings-regular.woff2 openstackdocstheme/theme/openstackdocs/static/images/footer-facebook-hover.png openstackdocstheme/theme/openstackdocs/static/images/footer-facebook.png openstackdocstheme/theme/openstackdocs/static/images/footer-linkedin-hover.png openstackdocstheme/theme/openstackdocs/static/images/footer-linkedin.png openstackdocstheme/theme/openstackdocs/static/images/footer-twitter-hover.png openstackdocstheme/theme/openstackdocs/static/images/footer-twitter.png openstackdocstheme/theme/openstackdocs/static/images/footer-youtube-hover.png openstackdocstheme/theme/openstackdocs/static/images/footer-youtube.png openstackdocstheme/theme/openstackdocs/static/images/loading.gif openstackdocstheme/theme/openstackdocs/static/images/openstack-logo-full.png openstackdocstheme/theme/openstackdocs/static/images/openstack-logo-vert.png openstackdocstheme/theme/openstackdocs/static/images/search-icon.png openstackdocstheme/theme/openstackdocs/static/images/docs/license.png openstackdocstheme/theme/openstackdocs/static/images/docs/superuser1.png openstackdocstheme/theme/openstackdocs/static/images/docs/superuser2.png openstackdocstheme/theme/openstackdocs/static/images/docs/superuser3.png openstackdocstheme/theme/openstackdocs/static/images/docs/superuser4.png openstackdocstheme/theme/openstackdocs/static/js/bootstrap.js openstackdocstheme/theme/openstackdocs/static/js/bootstrap.min.js openstackdocstheme/theme/openstackdocs/static/js/docs.js openstackdocstheme/theme/openstackdocs/static/js/jquery-3.2.1.js openstackdocstheme/theme/openstackdocs/static/js/jquery-3.2.1.min.js openstackdocstheme/theme/openstackdocs/static/js/navigation.js openstackdocstheme/theme/openstackdocs/static/js/webui-popover.js openstackdocstheme/theme/openstackdocs_pdf/openstack-logo-full.png openstackdocstheme/theme/openstackdocs_pdf/pdftheme.sty releasenotes/notes/add-reno-8da9bd3ccb7bbeab.yaml releasenotes/notes/allow-disabling-toc-in-body-d98d3a6e633fa28e.yaml releasenotes/notes/bug-project-e9ff50f6149d2be1.yaml releasenotes/notes/bug-title-fdbefea0408e2cbf.yaml releasenotes/notes/bug_project-d26160cfe5324694.yaml releasenotes/notes/custom-bug-link-ec64bdf9ce357d16.yaml releasenotes/notes/disable_analytics-45d98d6fab71d2b1.yaml releasenotes/notes/do-not-display-local-toc-title-without-subtitles-4e1fc48705d66289.yaml releasenotes/notes/doc-bug-template-7234e7f00e0ff599.yaml releasenotes/notes/double-backticks-not-red-5ce6dbc828221929.yaml releasenotes/notes/local-project-search-e6f00a84f2eed0a6.yaml releasenotes/notes/lp1516819-b4bb7b0f10004cef.yaml releasenotes/notes/norelease-ccd7722c078a73a2.yaml releasenotes/notes/side-bar-config-d7e66388e252cadf.yaml releasenotes/notes/sidebar-top-page-link-252532ddf42a5acf.yaml releasenotes/notes/sidebar_dropdown_apiref-993b4dba4c0369f6.yaml releasenotes/notes/sidebarlinks-db0a8463f32ab95d.yaml releasenotes/notes/storyboard-5f67da8941aec6ae.yaml releasenotes/notes/strip-html-tags-from-navigation-titles-929c92a339413015.yaml releasenotes/notes/version-dropdown-1aa39974f524dd75.yaml releasenotes/source/conf.py releasenotes/source/current.rst releasenotes/source/historic.rst releasenotes/source/index.rst releasenotes/source/_static/.placeholder releasenotes/source/_templates/.placeholder openstackdocstheme-1.18.1/openstackdocstheme.egg-info/pbr.json 0000664 0001751 0001751 00000000056 13227214133 024543 0 ustar zuul zuul 0000000 0000000 {"git_version": "93f7174", "is_release": true} openstackdocstheme-1.18.1/openstackdocstheme.egg-info/dependency_links.txt 0000664 0001751 0001751 00000000001 13227214133 027132 0 ustar zuul zuul 0000000 0000000 openstackdocstheme-1.18.1/openstackdocstheme.egg-info/not-zip-safe 0000664 0001751 0001751 00000000001 13227214072 025314 0 ustar zuul zuul 0000000 0000000 openstackdocstheme-1.18.1/openstackdocstheme.egg-info/PKG-INFO 0000664 0001751 0001751 00000003752 13227214133 024170 0 ustar zuul zuul 0000000 0000000 Metadata-Version: 1.1 Name: openstackdocstheme Version: 1.18.1 Summary: OpenStack Docs Theme Home-page: https://docs.openstack.org/openstackdocstheme/latest/ Author: OpenStack Author-email: openstack-dev@lists.openstack.org License: UNKNOWN Description-Content-Type: UNKNOWN Description: ======================== Team and repository tags ======================== .. image:: https://governance.openstack.org/tc/badges/openstackdocstheme.svg :target: https://governance.openstack.org/tc/reference/tags/index.html .. Change things from this point on OpenStack docs.openstack.org Sphinx Theme ========================================= Theme and extension support for Sphinx documentation that is published to docs.openstack.org and developer.openstack.org. Intended for use by OpenStack `projects governed by the Technical Committee`_. .. _`projects governed by the Technical Committee`: https://governance.openstack.org/tc/reference/projects/index.html * Free software: Apache License, Version 2.0 * Documentation: https://docs.openstack.org/openstackdocstheme/latest/ * Release notes: https://docs.openstack.org/releasenotes/openstackdocstheme/ * Source: https://git.openstack.org/cgit/openstack/openstackdocstheme * Bugs: https://launchpad.net/openstack-doc-tools Platform: UNKNOWN Classifier: Environment :: OpenStack Classifier: Intended Audience :: Information Technology Classifier: Intended Audience :: System Administrators Classifier: License :: OSI Approved :: Apache Software License Classifier: Operating System :: POSIX :: Linux Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 2 Classifier: Programming Language :: Python :: 2.7 Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.5 Classifier: Topic :: Documentation openstackdocstheme-1.18.1/openstackdocstheme.egg-info/top_level.txt 0000664 0001751 0001751 00000000023 13227214133 025611 0 ustar zuul zuul 0000000 0000000 openstackdocstheme openstackdocstheme-1.18.1/AUTHORS 0000664 0001751 0001751 00000003613 13227214133 016562 0 ustar zuul zuul 0000000 0000000 Akihiro MotokiAkihiro Motoki Alexandra Settle Andreas Jaeger Andreas Jaeger Anne Gentle Anne Gentle Anne Gentle Bernd Bernd Bausch Brian Moss Christian Berendt Christian Berendt Cory Benfield Dave Walker (Daviey) Doug Hellmann Flavio Percoco Gauvain Pocentek Graham Hayes Hangdong Zhang Harshada Mangesh Kakad Ian Y. Choi James E. Blair Jesse Pretorius KATO Tomoyuki Karen Bradshaw Leif Madsen Luong Anh Tuan Major Hayden Nick Chase Ondřej Nový Peter Tran Petronio Carlos Bezerra Rob Cresswell Ruby Loo Ryan Selden Sean Dague Sean M. Collins Sebastian Marcet SeongSoo Cho Stephen Finucane Thomas Bechtold Tony Breeds Zuul blue55 chenxing chenxing gecong1973 johnsom shangxiaobj venkatamahesh zhangdebo1987 openstackdocstheme-1.18.1/api-ref/ 0000775 0001751 0001751 00000000000 13227214134 017033 5 ustar zuul zuul 0000000 0000000 openstackdocstheme-1.18.1/api-ref/source/ 0000775 0001751 0001751 00000000000 13227214134 020333 5 ustar zuul zuul 0000000 0000000 openstackdocstheme-1.18.1/api-ref/source/conf.py 0000666 0001751 0001751 00000012571 13227213640 021643 0 ustar zuul zuul 0000000 0000000 # -*- coding: utf-8 -*- # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys import os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'os_api_ref', 'openstackdocstheme' ] # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # "project" contains the name of the book, such as # 'security guide' or 'network guide' # It's used by the "log-a-bug" button on each page # and should ultimately be set automatically by the build process project = u'Test API Reference' copyright = u'2016, OpenStack Contributors' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # "version" and "release" are used by the "log-a-bug" feature # # The short X.Y version. version = '1.0' # The full version, including alpha/beta/rc tags. release = '1.0' # A few variables have to be set for the log-a-bug feature. bug_tag = "doc-builds" bug_project = 'openstack-doc-tools' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build'] # The reST default role (used for this markup: `text`) to use for all # documents. #default_role = None # 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 # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. #keep_warnings = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'openstackdocs' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # To use the API Reference sidebar dropdown menu, # uncomment the html_theme_options parameter. The theme # variable, sidebar_dropdown, should be set to `api_ref`. # Otherwise, the list of links for the User and Ops docs # appear in the sidebar dropdown menu. html_theme_options = {"sidebar_dropdown": "api_ref", "sidebar_mode": "toc"} # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". # html_static_path = ['_static/css'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. #html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # So that we can enable "log-a-bug" links from each output HTML page, this # variable must be set to a format that includes year, month, day, hours and # minutes. html_last_updated_fmt = '%Y-%m-%d %H:%M' openstackdocstheme-1.18.1/api-ref/source/update-server-resp.json 0000666 0001751 0001751 00000000064 13227213640 024766 0 ustar zuul zuul 0000000 0000000 { "server": { "name": "server1" } } openstackdocstheme-1.18.1/api-ref/source/parameters.yaml 0000666 0001751 0001751 00000001217 13227213640 023366 0 ustar zuul zuul 0000000 0000000 id: in: path required: true type: string description: | The id of the service. image_id: in: path required: true type: string description: | The id for the image. host: in: body required: true type: string description: | The host name. name: in: body required: true type: string description: | The name of the service. role_id: in: body required: true type: string description: | The unique identifier for the role, which enables defining role assignments for multiple users in multiple projects. server.obj: in: body required: true type: object description: | The server object. openstackdocstheme-1.18.1/api-ref/source/service.inc 0000666 0001751 0001751 00000006074 13227213640 022500 0 ustar zuul zuul 0000000 0000000 .. -*- rst -*- ========= Service ========= **Introductory Concepts** When you create a server, you can specify a password through the optional adminPass attribute. The password must meet the complexity requirements set by your OpenStack Compute provider. The server might enter an ``ERROR`` state if the complexity requirements are not met. In this case, a client might issue a change password action to reset the server password. If you do not specify a password, the API generates and assigns a random password that it returns in the response object. This password meets the security requirements set by the compute provider. For security reasons, subsequent GET calls do not require this password. Follow these guidelines when you inject files: - The maximum size of the file path data is 255 bytes. - Encode the file contents as a Base64 string. The compute provider determines the maximum size of the file contents. The image that you use to create the server determines this value. .. note:: The maximum limit refers to the number of bytes in the decoded data and not to the number of characters in the encoded data. - The ``maxPersonality`` absolute limit defines the maximum number of file path and content pairs that you can supply. The compute provider determines this value. - The ``maxPersonalitySize`` absolute limit is a byte limit that applies to all images in the deployment. Providers can set additional per-image personality limits. The file injection might not occur until after the server builds and boots. After file injection, only system administrators can access personality files. For example, on Linux, all files have root as the owner and the root group as the group owner, and allow only user and group read access (``chmod 440``). List the Servers ================ .. rest_method:: GET /v3/servers/{role_id}/role Short explanation about this GET method. HTTP Status codes ----------------- .. rest_status_code:: success status.yaml - 200 - 201 .. rest_status_code:: error status.yaml - 400 - 500 Response -------- .. rest_parameters:: parameters.yaml - host: host - name: name - role_id: role_id Copy the Server =============== .. rest_method:: COPY /v3/servers/{role_id} Short explanation about this COPY method. Response -------- .. rest_parameters:: parameters.yaml - host: host - name: name - role_id: role_id Change or Update the Servers ============================ .. rest_method:: PUT /servers Explantory text about this PUT method. List of information: - Item 1 - Item 2 - Item 3 Request ------- .. rest_parameters:: parameters.yaml - name: name Response -------- .. rest_parameters:: parameters.yaml - server: server.obj - name: name **Example List Servers:** .. literalinclude:: update-server-resp.json :language: javascript Delete a Server =============== .. rest_method:: DELETE /servers/{id} Explain what the DELETE method does here. Request ------- .. rest_parameters:: parameters.yaml - id: id Response -------- No content in body of response. openstackdocstheme-1.18.1/api-ref/source/image.inc 0000666 0001751 0001751 00000004520 13227213640 022114 0 ustar zuul zuul 0000000 0000000 .. -*- rst -*- ======= Image ======= **Introductory Concepts** When you create a server, you can specify a password through the optional adminPass attribute. The password must meet the complexity requirements set by your OpenStack Compute provider. The server might enter an ``ERROR`` state if the complexity requirements are not met. In this case, a client might issue a change password action to reset the server password. List the Images =============== .. rest_method:: GET /v3/images/{role_id}/role/{id}/role/{image_id} Short explanation about this GET method. HTTP Status codes ----------------- .. rest_status_code:: success status.yaml - 200 - 201 .. rest_status_code:: error status.yaml - 400 - 500 Response -------- .. rest_parameters:: parameters.yaml - host: host - id: id - image_id: image_id - name: name - role_id: role_id Create an Image =============== .. rest_method:: POST /images Explantory text about this POST method. List of information: - Item 1 - Item 2 - Item 3 Request ------- .. rest_parameters:: parameters.yaml - name: name Response -------- .. rest_parameters:: parameters.yaml - server: server.obj - name: name **Example List Servers:** .. literalinclude:: update-server-resp.json :language: javascript Change or Update the Images =========================== .. rest_method:: PATCH /servers Explantory text about this PATCH method. List of information: - Item 1 - Item 2 - Item 3 Request ------- .. rest_parameters:: parameters.yaml - name: name Response -------- .. rest_parameters:: parameters.yaml - server: server.obj - name: name **Example List Servers:** .. literalinclude:: update-server-resp.json :language: javascript Change or Update the Images =========================== .. rest_method:: PUT /images Explantory text about this PUT method. Request ------- .. rest_parameters:: parameters.yaml - name: name Response -------- .. rest_parameters:: parameters.yaml - server: server.obj - name: name **Example List Servers:** .. literalinclude:: update-server-resp.json :language: javascript Delete an Image =============== .. rest_method:: DELETE /image/{id} Explain what the DELETE method does here. Request ------- .. rest_parameters:: parameters.yaml - id: id Response -------- No content in body of response. openstackdocstheme-1.18.1/api-ref/source/_static/ 0000775 0001751 0001751 00000000000 13227214134 021761 5 ustar zuul zuul 0000000 0000000 openstackdocstheme-1.18.1/api-ref/source/_static/css/ 0000775 0001751 0001751 00000000000 13227214134 022551 5 ustar zuul zuul 0000000 0000000 openstackdocstheme-1.18.1/api-ref/source/_static/css/README.md 0000666 0001751 0001751 00000000240 13227213640 024027 0 ustar zuul zuul 0000000 0000000