diff --git a/doc/source/conf.py b/doc/source/conf.py index 4ca29af1..a2dd4deb 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -18,7 +18,7 @@ import sys sys.path.insert(0, os.path.abspath('../..')) -# -- General configuration ------------------------------------------------ +# -- General configuration ---------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' @@ -35,7 +35,7 @@ extensions = [ 'wsmeext.sphinxext', 'sphinxcontrib.pecanwsme.rest', 'sphinxcontrib.httpdomain', - 'oslosphinx', + 'openstackdocstheme' ] wsme_protocols = ['restjson', 'restxml'] @@ -104,11 +104,11 @@ modindex_common_prefix = ['cloudkitty.'] #keep_warnings = False -# -- Options for HTML output ---------------------------------------------- +# -- 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 = 'default' +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 @@ -116,7 +116,7 @@ html_theme = 'default' #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = ["."] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -147,6 +147,7 @@ html_theme = 'default' # 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' +html_last_updated_fmt = '%Y-%m-%d %H:%M' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. @@ -189,7 +190,7 @@ html_theme = 'default' htmlhelp_basename = 'cloudkittydoc' -# -- Options for LaTeX output --------------------------------------------- +# -- Options for LaTeX output ------------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). @@ -231,7 +232,7 @@ latex_documents = [ #latex_domain_indices = True -# -- Options for manual page output --------------------------------------- +# -- Options for manual page output ------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). @@ -244,7 +245,7 @@ man_pages = [ #man_show_urls = False -# -- Options for Texinfo output ------------------------------------------- +# -- Options for Texinfo output ----------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, @@ -266,3 +267,8 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False + +# -- Options for openstackdocstheme ------------------------------------------- +repository_name = 'openstack/cloudkitty' +bug_project = 'cloudkitty' +bug_tag = '' diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index efdff4a0..709d2716 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -17,7 +17,7 @@ #sys.path.insert(0, os.path.abspath('.')) import pbr.version -# -- General configuration ------------------------------------------------ +# -- General configuration ---------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' @@ -26,8 +26,8 @@ import pbr.version # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', 'reno.sphinxext', + 'openstackdocstheme' ] # Add any paths that contain templates here, relative to this directory. @@ -96,11 +96,11 @@ pygments_style = 'sphinx' #keep_warnings = False -# -- Options for HTML output ---------------------------------------------- +# -- 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 = 'default' +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 @@ -108,7 +108,7 @@ html_theme = 'default' #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = ["."] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -139,6 +139,7 @@ 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' +html_last_updated_fmt = '%Y-%m-%d %H:%M' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. @@ -181,7 +182,7 @@ html_static_path = ['_static'] htmlhelp_basename = 'CloudkittyReleaseNotestdoc' -# -- Options for LaTeX output --------------------------------------------- +# -- Options for LaTeX output ------------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). @@ -223,7 +224,7 @@ latex_documents = [ #latex_domain_indices = True -# -- Options for manual page output --------------------------------------- +# -- Options for manual page output ------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). @@ -237,7 +238,7 @@ man_pages = [ #man_show_urls = False -# -- Options for Texinfo output ------------------------------------------- +# -- Options for Texinfo output ----------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, @@ -261,3 +262,7 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False +# -- Options for openstackdocstheme ------------------------------------------- +repository_name = 'openstack/cloudkitty' +bug_project = 'cloudkitty' +bug_tag = '' diff --git a/test-requirements.txt b/test-requirements.txt index 1a15bf24..1de1d4e0 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -12,8 +12,8 @@ gabbi>=1.11.0,<=1.25.0 # Apache-2.0 testscenarios>=0.4 # Apache-2.0/BSD testrepository>=0.0.18 # Apache-2.0/BSD mock>=1.2 # BSD -sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 # BSD -oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0 +sphinx>=1.6.2 # BSD +openstackdocstheme>=1.11.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 sphinxcontrib-httpdomain # BSD sphinxcontrib-pecanwsme>=0.8 # Apache-2.0