Metadata-Version: 1.1
Name: openstackdocstheme
Version: 1.0.8
Summary: OpenStack Docs Theme
Home-page: http://docs.openstack.org/
Author: OpenStack
Author-email: openstack-dev@lists.openstack.org
License: UNKNOWN
Description: OpenStack docs.openstack.org Sphinx Theme
        =========================================
        
        Theme and extension support for Sphinx documentation that is published to
        docs.openstack.org. Intended for use by OpenStack projects.
        
        Using the Theme
        ===============
        
        Prior to using this theme, ensure your project can use the OpenStack
        brand by referring to the brand guidelines at
        http://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::
        
           import openstackdocstheme
        
           html_theme = 'openstackdocs'
           html_theme_path = [openstackdocstheme.get_html_theme_path()]
        
        Also, you must include these variables so that the "Log a bug" link sends
        metadata for the project where the docs reside::
        
           # We ask git for the SHA checksum
           # The git SHA checksum is used by "log-a-bug"
           git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
           gitsha = os.popen(git_cmd).read().strip('\n')
           # source tree
           pwd = os.popen("pwd").read().strip('\n')
           # html_context allows us to pass arbitrary values into the html template
           html_context = {"pwd": pwd, "gitsha": gitsha}
           # 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
        * Documentation: http://docs.openstack.org/developer/openstackdocstheme
        * Source: http://git.openstack.org/cgit/openstack/openstackdocstheme
        * Bugs: http://bugs.launchpad.net/openstack-manuals
        
        
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.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Topic :: Documentation
