diff --git a/doc/source/conf.py b/doc/source/conf.py index 178bf62be3..cf838c0032 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -11,7 +11,8 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys, os +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 @@ -25,7 +26,14 @@ import sys, os # 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.todo', 'sphinx.ext.viewcode'] +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.viewcode', + 'oslo.sphinx' + ] + +todo_include_todos = True # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -41,16 +49,18 @@ master_doc = 'index' # General information about the project. project = u'Tempest' -copyright = u'2013, Sean Dague' +copyright = u'2013, OpenStack QA Team' # 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. # # The short X.Y version. -version = 'havana' +import pbr.version +version_info = pbr.version.VersionInfo('tempest') +version = version_info.version_string() # The full version, including alpha/beta/rc tags. -release = 'havana' +release = version_info.release_string() # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -74,17 +84,17 @@ exclude_patterns = ['_build'] # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +add_module_names = False # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +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 = [] +modindex_common_prefix = ['tempest.'] # -- Options for HTML output --------------------------------------------------- @@ -124,7 +134,8 @@ html_static_path = ['_static'] # 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' +git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1" +html_last_updated_fmt = os.popen(git_cmd).read() # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. @@ -184,7 +195,7 @@ latex_elements = { # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'Tempest.tex', u'Tempest Documentation', - u'Sean Dague', 'manual'), + u'OpenStack QA Team', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -214,7 +225,7 @@ latex_documents = [ # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'tempest', u'Tempest Documentation', - [u'Sean Dague'], 1) + [u'OpenStack QA Team'], 1) ] # If true, show URL addresses after external links. @@ -228,7 +239,7 @@ man_pages = [ # dir menu entry, description, category) texinfo_documents = [ ('index', 'Tempest', u'Tempest Documentation', - u'Sean Dague', 'Tempest', 'One line description of project.', + u'OpenStack QA Team', 'Tempest', 'One line description of project.', 'Miscellaneous'), ] @@ -247,8 +258,8 @@ texinfo_documents = [ # Bibliographic Dublin Core info. epub_title = u'Tempest' epub_author = u'Sean Dague' -epub_publisher = u'Sean Dague' -epub_copyright = u'2013, Sean Dague' +epub_publisher = u'OpenStack QA Team' +epub_copyright = u'2013, OpenStack QA Team' # The language of the text. It defaults to the language option # or en if the language is not set. diff --git a/test-requirements.txt b/test-requirements.txt index 1ede25eb26..8aa6ed9f72 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -3,3 +3,4 @@ hacking>=0.5.6,<0.8 docutils==0.9.1 sphinx>=1.1.2 python-subunit +oslo.sphinx