Metadata-Version: 1.1
Name: openstackdocstheme
Version: 1.11.0
Summary: OpenStack Docs Theme
Home-page: http://docs.openstack.org/
Author: OpenStack
Author-email: openstack-dev@lists.openstack.org
License: UNKNOWN
Description: ========================
        Team and repository tags
        ========================
        
        .. image:: https://governance.openstack.org/badges/openstackdocstheme.svg
            :target: https://governance.openstack.org/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/reference/projects/index.html
        
        Using the Theme
        ===============
        
        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.
        
        Update the requirements list for your project to
        include ``openstackdocstheme`` (usually in test-requirements.txt).
        
        If your project previously used the oslosphinx theme (without modifying
        the header navigation), remove oslosphinx from your requirements list,
        and then in your ``conf.py`` you can remove the import statement and
        extension listing for oslosphinx.
        
        Some of the settings below are included in the file generated by Sphinx when
        you initialize a project, so they may already have values that need to be
        changed.
        
        Then modify your Sphinx settings in ``conf.py`` to include::
        
           html_theme = 'openstackdocs'
        
        and to add ``'openstackdocstheme'`` to the list of extensions Sphinx
        needs to initialize::
        
           extensions = [
               # ...
               'openstackdocstheme',
               # ...
           ]
        
        Set the options to link to the git repository and bug tracker.
        
        ``repository_name``
            The prefix and repo name. For example,
            ``'openstack/python-glanceclient'``.
        
        ``bug_project``
            The launchpad project name. For example, ``python-glanceclient``.
        
        ``bug_tag``
           Launchpad bug tag. If unspecified, no tag is set.  The default is
           empty.
        
        For example::
        
            # openstackdocstheme options
            repository_name = 'openstack/python-glanceclient'
            bug_project = 'python-glanceclient'
            bug_tag = ''
        
        Enable the "last-updated" information by setting the format for the
        timestamp::
        
           # Must set this variable to include year, month, day, hours, and minutes.
           html_last_updated_fmt = '%Y-%m-%d %H:%M'
        
        * Free software: Apache License, Version 2.0
        * 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
