diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 3c7c80d..0000000 --- a/.gitignore +++ /dev/null @@ -1,24 +0,0 @@ -*~ -*.pyc -*.dat -TAGS -*.egg-info -build -.coverage -.tox -cover -.testrepository -subunit.log -AUTHORS -ChangeLog -*.deb -dist -*.egg -ceilometer/versioninfo -doc/source/api/ceilometer.*.rst -doc/source/api/tests.*.rst -doc/source/api/autoindex.rst -doc/source/sourcecode -*.mo -.update-venv -releasenotes/build diff --git a/.zuul.yaml b/.zuul.yaml deleted file mode 100644 index 6511484..0000000 --- a/.zuul.yaml +++ /dev/null @@ -1,15 +0,0 @@ -- project: - gate: - jobs: - - openstack-tox-pep8 - check: - jobs: - - openstack-tox-pep8 - post: - jobs: - - publish-openstack-python-branch-tarball - templates: - - publish-openstack-docs-pti - - check-requirements - - release-notes-jobs-python3 - - periodic-stable-jobs diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index 29a43ac..0000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,16 +0,0 @@ -If you would like to contribute to the development of OpenStack, -you must follow the steps in this page: - - http://docs.openstack.org/infra/manual/developers.html - -Once those steps have been completed, changes to OpenStack -should be submitted for review via the Gerrit tool, following -the workflow documented at: - - http://docs.openstack.org/infra/manual/developers.html#development-workflow - -Pull requests submitted through GitHub will be ignored. - -Bugs should be filed on Launchpad, not GitHub: - - https://bugs.launchpad.net/oslosphinx diff --git a/HACKING.rst b/HACKING.rst deleted file mode 100644 index a9272a3..0000000 --- a/HACKING.rst +++ /dev/null @@ -1,12 +0,0 @@ -oslosphinx Style Commandments -============================= - -- Step 1: Read the OpenStack Style Commandments - https://docs.openstack.org/hacking/latest/ -- Step 2: Read on - -oslosphinx Specific Commandments --------------------------------- - -None so far - diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 68c771a..0000000 --- a/LICENSE +++ /dev/null @@ -1,176 +0,0 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - diff --git a/README b/README new file mode 100644 index 0000000..eb99bcd --- /dev/null +++ b/README @@ -0,0 +1,9 @@ +This project is no longer maintained. + +The contents of this repository are still available in the Git +source code management system. To see the contents of this +repository before it reached its end of life, please check out the +previous commit with "git checkout HEAD^1". + +For any further questions, please email +openstack-discuss@lists.openstack.org. diff --git a/README.rst b/README.rst deleted file mode 100644 index de8f86c..0000000 --- a/README.rst +++ /dev/null @@ -1,17 +0,0 @@ -============================= - OpenStack Sphinx Extensions -============================= - -oslosphinx is obsolete. The openstackdocstheme package should be used -instead. oslosphinx will be maintained for the pike, ocata, and newton -release series and completely remove after that pike is marked -end-of-life. - -The contents of this repository are still available in the Git source -code management system. To see the contents of this repository before -it reached its end of life, please check out the previous commit with -"git checkout HEAD^1", or check out one of the supported stable -branches. - -For any further questions, please email -openstack-dev@lists.openstack.org or join #openstack-oslo on Freenode. diff --git a/doc/source/check_blueprints.rst b/doc/source/check_blueprints.rst deleted file mode 100644 index 1d3ed2a..0000000 --- a/doc/source/check_blueprints.rst +++ /dev/null @@ -1,48 +0,0 @@ -=========================================================== - Using oslosphinx.check_blueprints with Specs Repositories -=========================================================== - -The ``oslosphinx.check_blueprints`` extension verifies that the -filenames in spec repositories match a blueprint under a given -launchpad project. - -Enabling -======== - -Add ``'oslosphinx.check_blueprints'`` to the ``extensions`` list in -the ``conf.py`` file in your Sphinx project. - -Specifying the Launchpad Project -================================ - -Most projects should set ``check_blueprints_project`` to the name of -their launchpad project. This limits the search to the single project -named. - -:: - - check_blueprints_project = 'nova' - -Projects with multiple launchpad projects under their own project -group (such as Oslo), should instead set -``check_blueprints_project_group``. All projects in the group will be -scanned for each spec/blueprint name. - -:: - - check_blueprints_project_group = 'oslo' - -Checking Only the Current Release -================================= - -By default, all files under ``specs/`` are checked. For large specs -repositories, this can take a long time. To limit the checks to a -subdirectory for the current release, set -``check_blueprints_release``. - -For example:: - - check_blueprints_release = 'kilo' - -will cause files under ``specs/kilo`` to be checked, and other files -to be ignored. diff --git a/doc/source/conf.py b/doc/source/conf.py deleted file mode 100755 index 04d3623..0000000 --- a/doc/source/conf.py +++ /dev/null @@ -1,85 +0,0 @@ -# -*- coding: utf-8 -*- -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or -# implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -import os -import sys - -sys.path.insert(0, os.path.abspath('../..')) -# -- General configuration ---------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = [ - 'sphinx.ext.autodoc', - #'sphinx.ext.intersphinx', - 'openstackdocstheme' -] - -# -- Options for openstackdocstheme ------------------------------------------- -repository_name = 'openstack/oslosphinx' -bug_project = 'oslosphinx' -bug_tag = '' - -# Must set this variable to include year, month, day, hours, and minutes. -html_last_updated_fmt = '%Y-%m-%d %H:%M' - -oslosphinx_cgit_link = 'https://git.openstack.org/cgit/openstack/oslosphinx' - -# autodoc generation is a bit aggressive and a nuisance when doing heavy -# text edit cycles. -# execute "export SPHINX_DEBUG=1" in your terminal to disable - -# The suffix of source filenames. -source_suffix = '.rst' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'oslosphinx' -copyright = u'2013, OpenStack Foundation' - -# If true, '()' will be appended to :func: etc. cross-reference text. -add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -add_module_names = True - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# -- Options for HTML output -------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. Major themes that come with -# Sphinx are currently 'default' and 'sphinxdoc'. -# html_theme_path = ["."] -html_theme = 'openstackdocs' -# html_static_path = ['static'] - -# Output file base name for HTML help builder. -htmlhelp_basename = '%sdoc' % project - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass -# [howto/manual]). -latex_documents = [ - ('index', - '%s.tex' % project, - u'%s Documentation' % project, - u'OpenStack Foundation', 'manual'), -] - -# Example configuration for intersphinx: refer to the Python standard library. -#intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index 2ca75d1..0000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1,5 +0,0 @@ -============== - Contributing -============== - -.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/history.rst b/doc/source/history.rst deleted file mode 100644 index 69ed4fe..0000000 --- a/doc/source/history.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../ChangeLog diff --git a/doc/source/index.rst b/doc/source/index.rst deleted file mode 100644 index a665e91..0000000 --- a/doc/source/index.rst +++ /dev/null @@ -1,36 +0,0 @@ -============================================ - oslosphinx --- OpenStack Sphinx Extensions -============================================ - -oslosphinx contains the theme and extension support for Sphinx -documentation from the OpenStack project. - -.. toctree:: - :maxdepth: 2 - - usage - check_blueprints - contributing - -Release Notes -============= - -.. toctree:: - :maxdepth: 1 - - history - -Development -=========== - -.. toctree:: - :maxdepth: 1 - - theme_check - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/doc/source/theme_check.rst b/doc/source/theme_check.rst deleted file mode 100644 index 6ab5563..0000000 --- a/doc/source/theme_check.rst +++ /dev/null @@ -1,25 +0,0 @@ -=========== -Theme check -=========== - -This page is used to check the themes provided by oslosphinx. - -.. note:: - - A comment with additional information that explains a part of the text. - -.. important:: - - Something you must be aware of before proceeding. - -.. tip:: - - An extra but helpful piece of practical advice. - -.. Caution:: - - Helpful information that prevents the user from making mistakes. - -.. Warning:: - - Critical information about the risk of data loss or security issues. diff --git a/doc/source/usage.rst b/doc/source/usage.rst deleted file mode 100644 index 53525c8..0000000 --- a/doc/source/usage.rst +++ /dev/null @@ -1,52 +0,0 @@ -============================ - Using the oslosphinx Theme -============================ - -Guidelines -========== - -Prior to using this theme, ensure your project can use the OpenStack -brand by referring to the brand guidelines at -https://www.openstack.org/brand. In particular, if the project is not -under OpenStack governance as an "official" project, it should not use -this theme. - -If your documentation is not being published to an openstack.org site, -that may be a signal that you should not use this theme. - -Sphinx Configuration -==================== - -To use the theme, add ``'oslosphinx'`` to the ``extensions`` list in -the ``conf.py`` file in your Sphinx project. - -Incubating Projects -=================== - -If you are an incubating project, set:: - - html_theme_options = {'incubating': True} - -in your conf.py as well, to enable the Incubation theme. - -Linking to a Source Repository -============================== - -``oslosphinx`` defines a configuration option ``oslosphinx_cgit_link`` -which should be the URL to the git repository browser for the project -being documented. The default is a guess, and will be right for a lot -of projects, but to ensure that it is correct in all situations it is -best to set the value in conf.py:: - - oslosphinx_cgit_link = 'https://git.openstack.org/cgit/openstack/oslosphinx' - -Showing Older Versions of Documentation -======================================= - -``oslosphinx`` can automatically add links for previous versions of your -project's documentation to the sidebar. If this feature is enabled links -will be generated for each git tag. To enable this behavior, set:: - - html_theme_options = {'show_other_versions': True} - -in your conf.py. diff --git a/oslosphinx/__init__.py b/oslosphinx/__init__.py deleted file mode 100644 index f979aa1..0000000 --- a/oslosphinx/__init__.py +++ /dev/null @@ -1,101 +0,0 @@ -# Copyright 2013 New Dream Network, LLC (DreamHost) -# -# Licensed under the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. You may obtain -# a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. - -import os -import re -import six -from six.moves.urllib import parse -import string -import subprocess - - -CGIT_BASE = 'http://git.openstack.org/cgit/' - - -def _guess_cgit_link(): - try: - git_remote = subprocess.check_output( - ['git', 'config', '--local', '--get', 'remote.origin.url'] - ) - except Exception: - # git is not present or the command failed - return None - else: - if six.PY3: - git_remote = os.fsdecode(git_remote) - parsed = parse.urlparse(git_remote) - parsed = '/'.join(parsed.path.rstrip('/').split('/')[-2:]) - parsed = re.sub(r'\.git$', '', parsed) - return CGIT_BASE + parsed - - -def _html_page_context(app, pagename, templatename, context, doctree): - # Insert the cgit link into the template context. - context['cgit_link'] = app.config.oslosphinx_cgit_link - context['other_versions'] = _get_other_versions(app) - return None - - -def _get_other_versions(app): - if not app.config.html_theme_options.get('show_other_versions', False): - return [] - - git_cmd = ["git", "tag"] - try: - raw_version_list = subprocess.Popen( - git_cmd, stdout=subprocess.PIPE).communicate()[0] - raw_version_list = raw_version_list.decode("utf8") - except OSError: - app.warn('Cannot get tags from git repository. ' - 'Not setting "other_versions".') - raw_version_list = u'' - - # grab last five that start with a number and reverse the order - _tags = [t.strip("'") for t in raw_version_list.split('\n')] - other_versions = [ - t for t in _tags if t and t[0] in string.digits - # Don't show alpha, beta or release candidate tags - and 'rc' not in t and 'a' not in t and 'b' not in t - ][:-5:-1] - return other_versions - - -def builder_inited(app): - theme_dir = os.path.join(os.path.dirname(__file__), 'theme') - app.info('Using openstack theme from %s' % theme_dir) - # Insert our theme directory at the front of the search path and - # force the theme setting to use the one in the package unless - # another openstack theme is already selected. This is done here, - # instead of in setup(), because conf.py is read after setup() - # runs, so if the conf contains these values the user values - # overwrite these. That's not bad for the theme, but it breaks the - # search path. - app.config.html_theme_path.insert(0, theme_dir) - # Set the theme name - if not app.config.html_theme.startswith('openstack'): - app.config.html_theme = 'openstack' - # Re-initialize the builder, if it has the method for setting up - # the templates and theme. - if hasattr(app.builder, 'init_templates'): - app.builder.init_templates() - # Register our page context additions - app.connect('html-page-context', _html_page_context) - - -def setup(app): - app.connect('builder-inited', builder_inited) - # Try to guess at the default value for where the cgit repository - # is. - cgit_link = _guess_cgit_link() - app.add_config_value('oslosphinx_cgit_link', cgit_link, 'env') diff --git a/oslosphinx/check_blueprints.py b/oslosphinx/check_blueprints.py deleted file mode 100644 index e241edc..0000000 --- a/oslosphinx/check_blueprints.py +++ /dev/null @@ -1,130 +0,0 @@ -# All Rights Reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. You may obtain -# a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -"""Ensure that the name of the spec file matches the name of a blueprint. -""" - -import requests - - -class BlueprintChecker(object): - - def __init__(self, app): - self.app = app - self.project_names = [] - self._good_bps = set() - self._prefix = None - self._warn_search = 'unset' - - BP_URL_TEMPLATE = 'https://api.launchpad.net/devel/%s/+spec/%s' - PROJ_LIST_URL_TEMPLATE = 'https://api.launchpad.net/1.0/%s/projects' - - def _load_project_settings(self): - if self.project_names: - return - # If a project_name is set in the configuration, use - # that. Otherwise, allow any project in the project group. - project_name = self.app.config.check_blueprints_project - pg_name = self.app.config.check_blueprints_project_group - if project_name: - self.project_names = [project_name] - self._warn_search = 'the %s project' % project_name - else: - proj_list_response = requests.get(self.PROJ_LIST_URL_TEMPLATE - % pg_name) - projects = proj_list_response.json()['entries'] - self.project_names = [p['name'] for p in projects] - self._warn_search = ('any projects in the %s project group' - % pg_name) - - @property - def desired_prefix(self): - """Determine the prefix for files we care to check. - - We only care about blueprints in the current release, if the - check_blueprints_release option is set. - - """ - if self._prefix is None: - release = self.app.config.check_blueprints_release - if release: - self._prefix = 'specs/%s/' % release - else: - self._prefix = 'specs/' - return self._prefix - - def doctree_resolved(self, app, doctree, docname): - """Hook registered as event handler.""" - if not docname.startswith(self.desired_prefix): - return - bp_name = docname.split('/')[-1] - if bp_name == 'index': - return - self.check(bp_name) - - def blueprint_exists(self, project_name, bp_name): - """Return boolean indicating whether the blueprint exists.""" - self.app.info('Checking for %s in %s' % (bp_name, project_name)) - url = self.BP_URL_TEMPLATE % (project_name, bp_name) - response = requests.get(url) - if response.status_code == 200: - self.app.info('Found %s in %s' % (bp_name, project_name)) - return True - return False - - def check(self, bp_name): - """Given one blueprint name, check to see if it is valid.""" - if bp_name in self._good_bps: - return True - self._load_project_settings() - self.app.info('') # emit newline - candidate_project, dash, bp_name_to_find = bp_name.partition('-') - if candidate_project in self.project_names: - # First check the shortened name of the blueprint in the project. - if self.blueprint_exists(candidate_project, bp_name_to_find): - return - # Then check the full name of the blueprint in the project. - if self.blueprint_exists(candidate_project, bp_name): - return - self.app.info( - ('Blueprint name %r looks like it starts with a project ' - 'name, but %r was not found in project %r') % - (bp_name, bp_name_to_find, candidate_project) - ) - else: - self.app.info( - 'Blueprint checking is faster if the file names ' - 'start with the launchpad project name.' - ) - for project_name in self.project_names: - if self.blueprint_exists(project_name, bp_name): - self._good_bps.add(bp_name) - break - else: - self.app.warn( - 'Could not find a blueprint called %r in %s' - % (bp_name, self._warn_search), - location=(bp_name, 0), - ) - raise ValueError( - 'Document %s does not match any blueprint name in %s' - % (bp_name, self._warn_search)) - - -def setup(app): - app.info('Initializing %s' % __name__) - checker = BlueprintChecker(app) - app.connect('doctree-resolved', checker.doctree_resolved) - app.add_config_value('check_blueprints_project_group', 'openstack', 'env') - app.add_config_value('check_blueprints_project', '', 'env') - app.add_config_value('check_blueprints_release', '', 'env') diff --git a/oslosphinx/intersphinx.py b/oslosphinx/intersphinx.py deleted file mode 100644 index f534110..0000000 --- a/oslosphinx/intersphinx.py +++ /dev/null @@ -1,71 +0,0 @@ -# Copyright (c) 2013 Hewlett-Packard Development Company, L.P. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or -# implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -"""Intersphinx mapping file for the OpenStack projects. - -To use this mapping in a project, first add 'sphinx.ext.intersphinx' to -your extensions list in conf.py. Then:: - - from oslosphinx import intersphinx - intersphinx_mapping = intersphinx.mapping - -You'll be able to link to other project's documentation, such as: - - :ref:`virtual-environments ` -""" - -mapping = dict( - # OpenStack Projects - ceilometer=('http://docs.openstack.org/developer/ceilometer/', None), - cinder=('http://docs.openstack.org/developer/cinder/', None), - glance=('http://docs.openstack.org/developer/glance/', None), - heat=('http://docs.openstack.org/developer/heat/', None), - horizon=('http://docs.openstack.org/developer/horizon/', None), - ironic=('http://docs.openstack.org/developer/ironic/', None), - keystone=('http://docs.openstack.org/developer/keystone/', None), - nova=('http://docs.openstack.org/developer/nova/', None), - oslo_config=('http://docs.openstack.org/developer/oslo.config/', None), - oslo_messaging=( - 'http://docs.openstack.org/developer/oslo.messaging/', None), - ceilometerclient=( - 'http://docs.openstack.org/developer/python-ceilometerclient/', None), - cinderclient=( - 'http://docs.openstack.org/developer/python-cinderclient/', None), - glanceclient=( - 'http://docs.openstack.org/developer/python-glanceclient/', None), - heatclient=( - 'http://docs.openstack.org/developer/python-heatclient/', None), - ironicclient=( - 'http://docs.openstack.org/developer/python-ironicclient/', None), - keystoneclient=( - 'http://docs.openstack.org/developer/python-keystoneclient/', None), - novaclient=( - 'http://docs.openstack.org/developer/python-novaclient/', None), - openstackclient=( - 'http://docs.openstack.org/developer/python-openstackclient/', None), - neutronclient=( - 'http://docs.openstack.org/developer/python-neutronclient/', None), - swiftclient=( - 'http://docs.openstack.org/developer/python-swiftclient/', None), - troveclient=( - 'http://docs.openstack.org/developer/python-troveclient/', None), - neutron=('http://docs.openstack.org/developer/neutron/', None), - swift=('http://docs.openstack.org/developer/swift/', None), - trove=('http://docs.openstack.org/developer/trove/', None), - # Other things of note - python=('http://docs.python.org/', None), - infra=('http://docs.openstack.org/infra/system-config/', None), - zuul=('http://docs.openstack.org/infra/zuul/', None), -) diff --git a/oslosphinx/theme/openstack/layout.html b/oslosphinx/theme/openstack/layout.html deleted file mode 100644 index 0cd61c7..0000000 --- a/oslosphinx/theme/openstack/layout.html +++ /dev/null @@ -1,121 +0,0 @@ -{% extends "basic/layout.html" %} -{% set css_files = css_files + ['_static/tweaks.css'] %} - -{% block sidebar2 %} -
-
- {%- if not embedded %}{% if not theme_nosidebar|tobool %} - {%- block sidebarlogo %} - {%- if logo %} - - {%- endif %} - {%- endblock %} - {%- block sidebartoc %} - {%- if display_toc %} -

{{ _('Table Of Contents') }}

- - {{ toc }} - {%- endif %} - {%- endblock %} - {%- block sidebarrel %} - {%- if prev %} -

{{ _('Previous topic') }}

-

{{ prev.title }}

- {%- endif %} - {%- if next %} -

{{ _('Next topic') }}

-

{{ next.title }}

- {%- endif %} - {%- endblock %} - {%- block otherversions %} - {%- if other_versions %} -

{{ _('Other Versions') }}

- - {%- endif %} - {%- endblock %} - {%- block projectsource %} - {%- if cgit_link %} -

{{ _('Project Source') }}

- - {%- endif %} - {%- endblock %} - {%- block sidebarsourcelink %} - {%- if show_source and has_source and sourcename %} -

{{ _('This Page') }}

- - {%- endif %} - {%- endblock %} - {%- if customsidebar %} - {% include customsidebar %} - {%- endif %} - {%- block sidebarsearch %} - {%- if pagename != "search" %} - - - {%- endif %} - {%- endblock %} - {%- endif %}{% endif %} -
-
-{% endblock %} - -{% block relbar1 %}{% endblock relbar1 %} - -{% block header %} - -{% endblock %} - -{% block footer %} -{{ super() }} - - -{% endblock %} diff --git a/oslosphinx/theme/openstack/static/basic.css b/oslosphinx/theme/openstack/static/basic.css deleted file mode 100644 index 5542eea..0000000 --- a/oslosphinx/theme/openstack/static/basic.css +++ /dev/null @@ -1,419 +0,0 @@ -/** - * Sphinx stylesheet -- basic theme - * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - */ - -/* -- main layout ----------------------------------------------------------- */ - -div.clearer { - clear: both; -} - -/* -- relbar ---------------------------------------------------------------- */ - -div.related { - font-size: 90%; -} - -div.related h3 { - display: none; -} - -div.related ul { - margin: 0; - padding: 0 0 0 10px; - list-style: none; -} - -div.related li { - display: inline; -} - -div.related li.right { - float: right; - margin-right: 5px; -} - -/* -- sidebar --------------------------------------------------------------- */ - -div.sphinxsidebarwrapper { - padding: 10px 5px 0 10px; -} - -div.sphinxsidebar { - float: left; - width: 260px; - margin-left: -100%; - font-size: 90%; -} - -div.sphinxsidebar ul { - list-style: none; -} - -div.sphinxsidebar ul ul, -div.sphinxsidebar ul.want-points { - margin-left: 20px; - list-style: square; -} - -div.sphinxsidebar ul ul { - margin-top: 0; - margin-bottom: 0; -} - -div.sphinxsidebar form { - margin-top: 10px; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - -div.sphinxsidebar span.pre { - word-wrap: break-word; -} - -img { - border: 0; -} - -/* -- search page ----------------------------------------------------------- */ - -ul.search { - margin: 10px 0 0 20px; - padding: 0; -} - -ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; -} - -ul.search li a { - font-weight: bold; -} - -ul.search li div.context { - color: #888; - margin: 2px 0 0 30px; - text-align: left; -} - -ul.keywordmatches li.goodmatch a { - font-weight: bold; -} - -/* -- index page ------------------------------------------------------------ */ - -table.contentstable { - width: 90%; -} - -table.contentstable p.biglink { - line-height: 150%; -} - -a.biglink { - font-size: 1.3em; -} - -span.linkdescr { - font-style: italic; - padding-top: 5px; - font-size: 90%; -} - -/* -- general index --------------------------------------------------------- */ - -table.indextable td { - text-align: left; - vertical-align: top; -} - -table.indextable dl, table.indextable dd { - margin-top: 0; - margin-bottom: 0; -} - -table.indextable tr.pcap { - height: 10px; -} - -table.indextable tr.cap { - margin-top: 10px; - background-color: #f2f2f2; -} - -img.toggler { - margin-right: 3px; - margin-top: 3px; - cursor: pointer; -} - -/* -- general body styles --------------------------------------------------- */ - -a.headerlink { - visibility: hidden; -} - -h1:hover > a.headerlink, -h2:hover > a.headerlink, -h3:hover > a.headerlink, -h4:hover > a.headerlink, -h5:hover > a.headerlink, -h6:hover > a.headerlink, -dt:hover > a.headerlink { - visibility: visible; -} - -div.body p.caption { - text-align: inherit; -} - -div.body td { - text-align: left; -} - -.field-list ul { - padding-left: 1em; -} - -.first { -} - -p.rubric { - margin-top: 30px; - font-weight: bold; -} - -/* -- sidebars -------------------------------------------------------------- */ - -div.sidebar { - margin: 0 0 0.5em 1em; - border: 1px solid #ddb; - padding: 7px 7px 0 7px; - background-color: #ffe; - width: 40%; - float: right; -} - -p.sidebar-title { - font-weight: bold; -} - -/* -- topics ---------------------------------------------------------------- */ - -div.topic { - border: 1px solid #ccc; - padding: 7px 7px 0 7px; - margin: 10px 0 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* -- admonitions ----------------------------------------------------------- */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -div.admonition dt { - font-weight: bold; -} - -div.admonition dl { - margin-bottom: 0; -} - -p.admonition-title { - margin: 0px 10px 5px 0px; - font-weight: bold; -} - -div.body p.centered { - text-align: center; - margin-top: 25px; -} - -/* -- tables ---------------------------------------------------------------- */ - -table.docutils { - border: 0; - border-collapse: collapse; -} - -table.docutils td, table.docutils th { - padding: 1px 8px 1px 0; - border-top: 0; - border-left: 0; - border-right: 0; - border-bottom: 1px solid #aaa; -} - -table.field-list td, table.field-list th { - border: 0 !important; -} - -table.footnote td, table.footnote th { - border: 0 !important; -} - -th { - text-align: left; - padding-right: 5px; -} - -/* -- other body styles ----------------------------------------------------- */ - -dl { - margin-bottom: 15px; -} - -dd p { - margin-top: 0px; -} - -dd ul, dd table { - margin-bottom: 10px; -} - -dd { - margin-top: 3px; - margin-bottom: 10px; - margin-left: 30px; -} - -dt:target, .highlight { - background-color: #fbe54e; -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - -.refcount { - color: #060; -} - -.optional { - font-size: 1.3em; -} - -.versionmodified { - font-style: italic; -} - -.system-message { - background-color: #fda; - padding: 5px; - border: 3px solid red; -} - -.footnote:target { - background-color: #ffa -} - -.line-block { - display: block; - margin-top: 1em; - margin-bottom: 1em; -} - -.line-block .line-block { - margin-top: 0; - margin-bottom: 0; - margin-left: 1.5em; -} - -/* -- code displays --------------------------------------------------------- */ - -pre { - overflow: auto; -} - -td.linenos pre { - padding: 5px 0px; - border: 0; - background-color: transparent; - color: #aaa; -} - -table.highlighttable { - margin-left: 0.5em; -} - -table.highlighttable td { - padding: 0 0.5em 0 0.5em; -} - -tt.descname { - background-color: transparent; - font-weight: bold; - font-size: 1.2em; -} - -tt.descclassname { - background-color: transparent; -} - -tt.xref, a tt { - background-color: transparent; - font-weight: bold; -} - -h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { - background-color: transparent; -} - -/* -- math display ---------------------------------------------------------- */ - -img.math { - vertical-align: middle; -} - -div.body div.math p { - text-align: center; -} - -span.eqno { - float: right; -} - -/* -- printout stylesheet --------------------------------------------------- */ - -@media print { - div.document, - div.documentwrapper, - div.bodywrapper { - margin: 0 !important; - width: 100%; - } - - div.sphinxsidebar, - div.related, - div.footer, - #top-link { - display: none; - } -} diff --git a/oslosphinx/theme/openstack/static/default.css b/oslosphinx/theme/openstack/static/default.css deleted file mode 100644 index c8091ec..0000000 --- a/oslosphinx/theme/openstack/static/default.css +++ /dev/null @@ -1,230 +0,0 @@ -/** - * Sphinx stylesheet -- default theme - * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - */ - -@import url("basic.css"); - -/* -- page layout ----------------------------------------------------------- */ - -body { - font-family: sans-serif; - font-size: 100%; - background-color: #11303d; - color: #000; - margin: 0; - padding: 0; -} - -div.document { - background-color: #1c4e63; -} - -div.documentwrapper { - float: left; - width: 100%; -} - -div.bodywrapper { - margin: 0 0 0 230px; -} - -div.body { - background-color: #ffffff; - color: #000000; - padding: 0 20px 30px 20px; -} - -div.footer { - color: #ffffff; - width: 100%; - padding: 9px 0 9px 0; - text-align: center; - font-size: 75%; -} - -div.footer a { - color: #ffffff; - text-decoration: underline; -} - -div.related { - background-color: #133f52; - line-height: 30px; - color: #ffffff; -} - -div.related a { - color: #ffffff; -} - -div.sphinxsidebar { -} - -div.sphinxsidebar h3 { - font-family: 'Trebuchet MS', sans-serif; - color: #ffffff; - font-size: 1.4em; - font-weight: normal; - margin: 0; - padding: 0; -} - -div.sphinxsidebar h3 a { - color: #ffffff; -} - -div.sphinxsidebar h4 { - font-family: 'Trebuchet MS', sans-serif; - color: #ffffff; - font-size: 1.3em; - font-weight: normal; - margin: 5px 0 0 0; - padding: 0; -} - -div.sphinxsidebar p { - color: #ffffff; -} - -div.sphinxsidebar p.topless { - margin: 5px 10px 10px 10px; -} - -div.sphinxsidebar ul { - margin: 10px; - padding: 0; - color: #ffffff; -} - -div.sphinxsidebar a { - color: #98dbcc; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - -/* -- body styles ----------------------------------------------------------- */ - -a { - color: #355f7c; - text-decoration: none; -} - -a:hover { - text-decoration: underline; -} - -div.body p, div.body dd, div.body li { - text-align: left; - line-height: 130%; -} - -div.body h1, -div.body h2, -div.body h3, -div.body h4, -div.body h5, -div.body h6 { - font-family: 'Trebuchet MS', sans-serif; - background-color: #f2f2f2; - font-weight: normal; - color: #20435c; - border-bottom: 1px solid #ccc; - margin: 20px -20px 10px -20px; - padding: 3px 0 3px 10px; -} - -div.body h1 { margin-top: 0; font-size: 200%; } -div.body h2 { font-size: 160%; } -div.body h3 { font-size: 140%; } -div.body h4 { font-size: 120%; } -div.body h5 { font-size: 110%; } -div.body h6 { font-size: 100%; } - -a.headerlink { - color: #c60f0f; - font-size: 0.8em; - padding: 0 4px 0 4px; - text-decoration: none; -} - -a.headerlink:hover { - background-color: #c60f0f; - color: white; -} - -div.body p, div.body dd, div.body li { - text-align: left; - line-height: 130%; -} - -div.admonition p.admonition-title + p { - display: inline; -} - -div.admonition p { - margin-bottom: 5px; -} - -div.admonition pre { - margin-bottom: 5px; -} - -div.admonition ul, div.admonition ol { - margin-bottom: 5px; -} - -div.note { - background-color: #eee; - border: 1px solid #ccc; -} - -div.seealso { - background-color: #ffc; - border: 1px solid #ff6; -} - -div.topic { - background-color: #eee; -} - -div.warning { - background-color: #ffe4e4; - border: 1px solid #f66; -} - -p.admonition-title { - display: inline; -} - -p.admonition-title:after { - content: ":"; -} - -pre { - padding: 5px; - background-color: #eeffcc; - color: #333333; - line-height: 120%; - border: 1px solid #ac9; - border-left: none; - border-right: none; -} - -tt { - background-color: #ecf0f3; - padding: 0 1px 0 1px; - font-size: 0.95em; -} - -.warning tt { - background: #efc2c2; -} - -.note tt { - background: #d6d6d6; -} diff --git a/oslosphinx/theme/openstack/static/header-line.gif b/oslosphinx/theme/openstack/static/header-line.gif deleted file mode 100644 index 3601730..0000000 Binary files a/oslosphinx/theme/openstack/static/header-line.gif and /dev/null differ diff --git a/oslosphinx/theme/openstack/static/header_bg.jpg b/oslosphinx/theme/openstack/static/header_bg.jpg deleted file mode 100644 index f788c41..0000000 Binary files a/oslosphinx/theme/openstack/static/header_bg.jpg and /dev/null differ diff --git a/oslosphinx/theme/openstack/static/nature.css b/oslosphinx/theme/openstack/static/nature.css deleted file mode 100644 index aa80995..0000000 --- a/oslosphinx/theme/openstack/static/nature.css +++ /dev/null @@ -1,260 +0,0 @@ -/* - * nature.css_t - * ~~~~~~~~~~~~ - * - * Sphinx stylesheet -- nature theme. - * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -@import url("basic.css"); - -/* -- page layout ----------------------------------------------------------- */ - -body { - font-family: Arial, sans-serif; - font-size: 100%; - background-color: #111; - color: #555; - margin: 0; - padding: 0; -} - -div.documentwrapper { - float: left; - width: 100%; -} - -div.bodywrapper { - margin: 0 0 0 {{ theme_sidebarwidth|toint }}px; -} - -hr { - border: 1px solid #B1B4B6; -} - -div.document { - background-color: #eee; -} - -div.body { - background-color: #ffffff; - color: #3E4349; - padding: 0 30px 30px 30px; - font-size: 0.9em; -} - -div.footer { - color: #555; - width: 100%; - padding: 13px 0; - text-align: center; - font-size: 75%; -} - -div.footer a { - color: #444; - text-decoration: underline; -} - -div.related { - background-color: #6BA81E; - line-height: 32px; - color: #fff; - text-shadow: 0px 1px 0 #444; - font-size: 0.9em; -} - -div.related a { - color: #E2F3CC; -} - -div.sphinxsidebar { - font-size: 0.75em; - line-height: 1.5em; -} - -div.sphinxsidebarwrapper{ - padding: 20px 0; -} - -div.sphinxsidebar h3, -div.sphinxsidebar h4 { - font-family: Arial, sans-serif; - color: #222; - font-size: 1.2em; - font-weight: normal; - margin: 0; - padding: 5px 10px; - background-color: #ddd; - text-shadow: 1px 1px 0 white -} - -div.sphinxsidebar h4{ - font-size: 1.1em; -} - -div.sphinxsidebar h3 a { - color: #444; -} - - -div.sphinxsidebar p { - color: #888; - padding: 5px 20px; -} - -div.sphinxsidebar p.topless { -} - -div.sphinxsidebar ul { - margin: 10px 20px; - padding: 0; - color: #000; -} - -div.sphinxsidebar a { - color: #444; -} - -div.sphinxsidebar input { - border: 1px solid #ccc; - font-family: sans-serif; - font-size: 1em; -} - -div.sphinxsidebar input[type=text]{ - margin-left: 20px; -} - -/* -- body styles ----------------------------------------------------------- */ - -a { - color: #005B81; - text-decoration: none; -} - -a:hover { - color: #E32E00; - text-decoration: underline; -} - -div.body h1, -div.body h2, -div.body h3, -div.body h4, -div.body h5, -div.body h6 { - font-family: Arial, sans-serif; - background-color: #BED4EB; - font-weight: normal; - color: #212224; - margin: 30px 0px 10px 0px; - padding: 5px 0 5px 10px; - text-shadow: 0px 1px 0 white -} - -div.body h1 { border-top: 20px solid white; margin-top: 0; font-size: 200%; } -div.body h2 { font-size: 150%; background-color: #C8D5E3; } -div.body h3 { font-size: 120%; background-color: #D8DEE3; } -div.body h4 { font-size: 110%; background-color: #D8DEE3; } -div.body h5 { font-size: 100%; background-color: #D8DEE3; } -div.body h6 { font-size: 100%; background-color: #D8DEE3; } - -a.headerlink { - color: #c60f0f; - font-size: 0.8em; - padding: 0 4px 0 4px; - text-decoration: none; -} - -a.headerlink:hover { - background-color: #c60f0f; - color: white; -} - -div.body p, div.body dd, div.body li { - line-height: 1.5em; -} - -div.admonition p.admonition-title + p { - display: inline; -} - -div.highlight{ - background-color: white; -} - -div.note { - background-color: #edf2f7; - border: 1px solid #2a4e68; -} - -div.seealso { - background-color: #ffc; - border: 1px solid #ff6; -} - -div.topic { - background-color: #eee; -} - -div.warning { - background-color: #ffe4e4; - border: 1px solid #f66; -} - -div.important { - background-color: #feffbe; - border: 1px solid #d7aa16; -} - -div.caution { - background-color: #eee; - border: 1px solid #ccc; -} - -div.tip { - background-color: #eee; - border: 1px solid #ccc; -} - -p.admonition-title { - display: inline; -} - -p.admonition-title:after { - content: ":"; -} - -pre { - padding: 10px; - background-color: White; - color: #222; - line-height: 1.2em; - border: 1px solid #C6C9CB; - font-size: 1.1em; - margin: 1.5em 0 1.5em 0; - -webkit-box-shadow: 1px 1px 1px #d8d8d8; - -moz-box-shadow: 1px 1px 1px #d8d8d8; -} - -tt { - background-color: #ecf0f3; - color: #222; - /* padding: 1px 2px; */ - font-size: 1.1em; - font-family: monospace; -} - -.viewcode-back { - font-family: Arial, sans-serif; -} - -div.viewcode-block:target { - background-color: #f4debf; - border-top: 1px solid #ac9; - border-bottom: 1px solid #ac9; -} diff --git a/oslosphinx/theme/openstack/static/openstack_logo.png b/oslosphinx/theme/openstack/static/openstack_logo.png deleted file mode 100644 index 146faec..0000000 Binary files a/oslosphinx/theme/openstack/static/openstack_logo.png and /dev/null differ diff --git a/oslosphinx/theme/openstack/static/tweaks.css b/oslosphinx/theme/openstack/static/tweaks.css deleted file mode 100644 index 5bd5ff2..0000000 --- a/oslosphinx/theme/openstack/static/tweaks.css +++ /dev/null @@ -1,128 +0,0 @@ -body { - background: #fff url(../_static/header_bg.jpg) top left no-repeat; -} - -#header { - width: 950px; - margin: 0 auto; - height: 102px; -} - -#header h1#logo { - background: url(../_static/openstack_logo.png) top left no-repeat; - display: block; - float: left; - text-indent: -9999px; - width: 175px; - height: 55px; -} - -#navigation { - background: url(../_static/header-line.gif) repeat-x 0 bottom; - display: block; - float: left; - margin: 27px 0 0 25px; - padding: 0; -} - -#navigation li{ - float: left; - display: block; - margin-right: 25px; -} - -#navigation li a { - display: block; - font-weight: normal; - text-decoration: none; - background-position: 50% 0; - padding: 20px 0 5px; - color: #353535; - font-size: 14px; -} - -#navigation li a.current, #navigation li a.section { - border-bottom: 3px solid #cf2f19; - color: #cf2f19; -} - -div.related { - background-color: #cde2f8; - border: 1px solid #b0d3f8; -} - -div.related a { - color: #4078ba; - text-shadow: none; -} - -div.sphinxsidebarwrapper { - padding-top: 0; -} - -pre { - color: #555; -} - -div.documentwrapper h1, div.documentwrapper h2, div.documentwrapper h3, div.documentwrapper h4, div.documentwrapper h5, div.documentwrapper h6 { - font-family: 'PT Sans', sans-serif !important; - color: #264D69; - border-bottom: 1px dotted #C5E2EA; - padding: 0; - background: none; - padding-bottom: 5px; -} - -div.documentwrapper h3 { - color: #CF2F19; -} - -a.headerlink { - color: #fff !important; - margin-left: 5px; - background: #CF2F19 !important; -} - -div.body { - margin-top: -25px; - margin-left: 260px; -} - -div.document { - width: 960px; - margin: 0 auto; -} - -div.sphinxsidebar h3.highlighted { - background-color: #cf2f19; - color: #EEE; - text-shadow: 1px 1px 0 #740101; -} - -div.sphinxsidebar h3.highlighted a { - color: #EEE; -} - -/** provide visual separation for sidebar for increased readability. */ -div.sphinxsidebar ul li { - margin-top: 1em; - font-weight: bold; -} - -div.sphinxsidebar ul li ul li { - margin-top: 0; - font-weight: normal; -} - -/** Provide the sidebar to allow long words to go to the next line - making them easier to read.*/ -div.sphinxsidebar a { - display: block; - text-indent: -1em; - margin-left: 1em; - word-wrap: break-word; -} - -div.sphinxsidebar ul { - margin: 10px 10px; -} \ No newline at end of file diff --git a/oslosphinx/theme/openstack/theme.conf b/oslosphinx/theme/openstack/theme.conf deleted file mode 100644 index 2d5cc29..0000000 --- a/oslosphinx/theme/openstack/theme.conf +++ /dev/null @@ -1,8 +0,0 @@ -[theme] -inherit = basic -stylesheet = nature.css -pygments_style = tango - -[options] -incubating = false -show_other_versions = false diff --git a/releasenotes/notes/add-reno-996dd44974d53238.yaml b/releasenotes/notes/add-reno-996dd44974d53238.yaml deleted file mode 100644 index 2234c38..0000000 --- a/releasenotes/notes/add-reno-996dd44974d53238.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -other: - - Introduce reno for deployer release notes. diff --git a/releasenotes/notes/obsolete-3da30e6cd2867d0e.yaml b/releasenotes/notes/obsolete-3da30e6cd2867d0e.yaml deleted file mode 100644 index 70f4461..0000000 --- a/releasenotes/notes/obsolete-3da30e6cd2867d0e.yaml +++ /dev/null @@ -1,6 +0,0 @@ ---- -prelude: >- - oslosphinx is obsolete. The openstackdocstheme package should be used - instead. oslosphinx will be maintained for the pike, ocata, and newton - release series and completely remove after that pike is marked - end-of-life. diff --git a/releasenotes/source/_static/.placeholder b/releasenotes/source/_static/.placeholder deleted file mode 100644 index e69de29..0000000 diff --git a/releasenotes/source/_templates/.placeholder b/releasenotes/source/_templates/.placeholder deleted file mode 100644 index e69de29..0000000 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py deleted file mode 100644 index e5e414f..0000000 --- a/releasenotes/source/conf.py +++ /dev/null @@ -1,277 +0,0 @@ -# -*- coding: utf-8 -*- -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or -# implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# 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. - -# 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 = [ - 'openstackdocstheme', - 'reno.sphinxext', -] - -# 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' - -# General information about the project. -project = u'oslosphinx Release Notes' -copyright = u'2016, oslosphinx Developers' - -# Release notes do not need a version in the title, they span -# multiple versions. -# The full version, including alpha/beta/rc tags. -release = '' -# The short X.Y version. -version = '' - -# 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 = [] - -# 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. -# html_theme_options = {} - -# 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'] - -# 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 = '%Y-%m-%d %H:%M' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'oslosphinxReleaseNotesDoc' - - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # 'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ('index', 'oslosphinxReleaseNotes.tex', - u'oslosphinx Release Notes Documentation', - u'oslosphinx Developers', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'oslosphinxReleaseNotes', - u'oslosphinx Release Notes Documentation', - [u'oslosphinx Developers'], 1) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ('index', 'oslosphinxReleaseNotes', - u'oslosphinx Release Notes Documentation', - u'oslosphinx Developers', 'oslosphinxReleaseNotes', - 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - -# -- Options for Internationalization output ------------------------------ -locale_dirs = ['locale/'] - -# -- Options for openstackdocstheme ------------------------------------------- -repository_name = 'openstack/oslosphinx' -bug_project = 'oslosphinx' -bug_tag = '' diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst deleted file mode 100644 index e515a95..0000000 --- a/releasenotes/source/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -========================== - oslosphinx Release Notes -========================== - - .. toctree:: - :maxdepth: 1 - - unreleased - queens - pike - ocata diff --git a/releasenotes/source/ocata.rst b/releasenotes/source/ocata.rst deleted file mode 100644 index ebe62f4..0000000 --- a/releasenotes/source/ocata.rst +++ /dev/null @@ -1,6 +0,0 @@ -=================================== - Ocata Series Release Notes -=================================== - -.. release-notes:: - :branch: origin/stable/ocata diff --git a/releasenotes/source/pike.rst b/releasenotes/source/pike.rst deleted file mode 100644 index e43bfc0..0000000 --- a/releasenotes/source/pike.rst +++ /dev/null @@ -1,6 +0,0 @@ -=================================== - Pike Series Release Notes -=================================== - -.. release-notes:: - :branch: stable/pike diff --git a/releasenotes/source/queens.rst b/releasenotes/source/queens.rst deleted file mode 100644 index 36ac616..0000000 --- a/releasenotes/source/queens.rst +++ /dev/null @@ -1,6 +0,0 @@ -=================================== - Queens Series Release Notes -=================================== - -.. release-notes:: - :branch: stable/queens diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst deleted file mode 100644 index cd22aab..0000000 --- a/releasenotes/source/unreleased.rst +++ /dev/null @@ -1,5 +0,0 @@ -============================== - Current Series Release Notes -============================== - -.. release-notes:: diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index ad13f8c..0000000 --- a/requirements.txt +++ /dev/null @@ -1,7 +0,0 @@ -# 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 -requests>=2.14.2 # Apache-2.0 -six>=1.10.0 # MIT diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index dfcfce8..0000000 --- a/setup.cfg +++ /dev/null @@ -1,37 +0,0 @@ -[metadata] -name = oslosphinx -summary = OpenStack Sphinx Extensions and Theme -description-file = - README.rst -author = OpenStack -author-email = openstack-discuss@lists.openstack.org -home-page = https://docs.openstack.org/oslosphinx/latest/ -classifier = - Environment :: OpenStack - Intended Audience :: Information Technology - Intended Audience :: System Administrators - License :: OSI Approved :: Apache Software License - Operating System :: POSIX :: Linux - Programming Language :: Python - Programming Language :: Python :: 2 - Programming Language :: Python :: 2.7 - Programming Language :: Python :: 3 - Programming Language :: Python :: 3.5 - Topic :: Documentation - -[global] -setup-hooks = - pbr.hooks.setup_hook - -[files] -packages = - oslosphinx - -[build_sphinx] -all_files = 1 -build-dir = doc/build -source-dir = doc/source -warning-is-error = 1 - -[wheel] -universal = 1 diff --git a/setup.py b/setup.py deleted file mode 100644 index 566d844..0000000 --- a/setup.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright (c) 2013 Hewlett-Packard Development Company, L.P. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or -# implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT -import setuptools - -# In python < 2.7.4, a lazy loading of package `pbr` will break -# setuptools if some other modules registered functions in `atexit`. -# solution from: http://bugs.python.org/issue15881#msg170215 -try: - import multiprocessing # noqa -except ImportError: - pass - -setuptools.setup( - setup_requires=['pbr>=2.0.0'], - pbr=True) diff --git a/test-requirements.txt b/test-requirements.txt deleted file mode 100644 index b6391eb..0000000 --- a/test-requirements.txt +++ /dev/null @@ -1,10 +0,0 @@ -# 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>=1.1.0,<1.2.0 # Apache-2.0 - -# this is required for the docs build jobs -sphinx>=1.6.2 # BSD -openstackdocstheme>=1.17.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini deleted file mode 100644 index a8c9c38..0000000 --- a/tox.ini +++ /dev/null @@ -1,31 +0,0 @@ -[tox] -minversion = 2.0 -envlist = pep8 - -[testenv] -basepython = python3 -install_command = pip install {opts} {packages} -deps = - -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} - -r{toxinidir}/test-requirements.txt - -r{toxinidir}/requirements.txt - -[testenv:py27] -basepython = python2.7 - -[testenv:pep8] -commands = - flake8 oslosphinx - -[testenv:venv] -commands = {posargs} - -[testenv:docs] -commands = python setup.py build_sphinx - -[flake8] -exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,tools -show-source = True - -[testenv:releasenotes] -commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html