diff --git a/doc/source/conf.py b/doc/source/conf.py index dd04564..aed6f5c 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -9,10 +9,7 @@ # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. -# -# python-searchlightclient documentation build configuration file, created by -# sphinx-quickstart on Sun Dec 6 14:19:25 2009. -# + # This file is execfile()d with the current directory set to its containing # dir. # @@ -32,7 +29,7 @@ # 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', 'oslosphinx'] +extensions = ['sphinx.ext.autodoc', 'openstackdocstheme'] autoclass_content = 'both' @@ -52,6 +49,11 @@ master_doc = 'index' project = 'python-searchlightclient' copyright = 'OpenStack Contributors' +# openstackdocstheme options +repository_name = 'openstack/python-searchlightclient' +bug_project = 'python-searchlightclient' +bug_tag = '' + # 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. @@ -111,7 +113,7 @@ man_pages = [ # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. -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 @@ -144,7 +146,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. diff --git a/setup.cfg b/setup.cfg index a16279d..d52ea49 100644 --- a/setup.cfg +++ b/setup.cfg @@ -39,6 +39,7 @@ setup-hooks = source-dir = doc/source build-dir = doc/build all_files = 1 +warning-is-error = 1 [upload_sphinx] upload-dir = doc/build/html diff --git a/test-requirements.txt b/test-requirements.txt index 1292e1b..06e1358 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,7 +7,7 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 coverage!=4.4,>=4.0 # Apache-2.0 fixtures>=3.0.0 # Apache-2.0/BSD mock>=2.0 # BSD -oslosphinx>=4.7.0 # Apache-2.0 -sphinx!=1.6.1,>=1.5.1 # BSD +openstackdocstheme>=1.11.0 # Apache-2.0 +sphinx>=1.6.2 # BSD testrepository>=0.0.18 # Apache-2.0/BSD testtools>=1.4.0 # MIT