diff --git a/doc/source/conf.py b/doc/source/conf.py index 6444a247..6b3d6b7e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -26,7 +26,6 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Ironic Lib' copyright = u'OpenStack Foundation' # The version info for the project you're documenting, acts as replacement for @@ -64,15 +63,12 @@ html_theme = 'openstackdocs' # openstackdocstheme options repository_name = 'openstack/ironic-lib' -bug_project = 'ironic-lib' -bug_tag = '' - -# Must set this variable to include year, month, day, hours, and minutes. -html_last_updated_fmt = '%Y-%m-%d %H:%M' +use_storyboard = True # Output file base name for HTML help builder. -htmlhelp_basename = '%sdoc' % project +htmlhelp_basename = 'ironic-libdoc' +latex_use_xindy = False # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass @@ -80,8 +76,8 @@ htmlhelp_basename = '%sdoc' % project latex_documents = [ ( 'index', - '%s.tex' % project, - u'%s Documentation' % project, + 'doc-ironic-lib.tex', + u'Ironic Lib Documentation', u'OpenStack Foundation', 'manual' ), diff --git a/lower-constraints.txt b/lower-constraints.txt index 198e90ac..9c6f026c 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -29,7 +29,7 @@ mox3==0.20.0 msgpack-python==0.4.0 netaddr==0.7.18 netifaces==0.10.4 -openstackdocstheme==1.18.1 +openstackdocstheme==1.20.0 os-client-config==1.28.0 os-testr==1.0.0 oslo.concurrency==3.26.0 diff --git a/test-requirements.txt b/test-requirements.txt index 2c5c4e20..72143b5e 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -16,4 +16,4 @@ testtools>=2.2.0 # MIT doc8>=0.6.0 # Apache-2.0 sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 +openstackdocstheme>=1.20.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 33aa9db7..4db9c788 100644 --- a/tox.ini +++ b/tox.ini @@ -60,6 +60,15 @@ envdir = {toxworkdir}/venv commands = python setup.py build_sphinx +[testenv:pdf-docs] +whitelist_externals = make +basepython = python3 +setenv = PYTHONHASHSEED=0 +sitepackages = False +envdir = {toxworkdir}/venv +commands = sphinx-build -b latex doc/source doc/build/pdf + make -C doc/build/pdf + [testenv:lower-constraints] basepython = python3 deps =