diff --git a/doc/requirements.txt b/doc/requirements.txt index 6aad60bb5..b1b1aaec9 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,6 +2,7 @@ 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 sphinxcontrib-httpdomain>=1.3.0 # BSD sphinxcontrib-blockdiag>=1.5.4 # BSD +sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD reno>=2.5.0 # Apache-2.0 os-api-ref>=1.4.0 # Apache-2.0 -openstackdocstheme>=1.18.1 # Apache-2.0 +openstackdocstheme>=1.20.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 27126d174..e5cc66f60 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -22,6 +22,7 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', + 'sphinxcontrib.rsvgconverter', 'openstackdocstheme' ] @@ -36,7 +37,6 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'bifrost' copyright = u'2015, OpenStack Foundation' # If true, '()' will be appended to :func: etc. cross-reference text. @@ -60,22 +60,18 @@ html_theme = 'openstackdocs' # openstackdocstheme options repository_name = 'openstack/bifrost' -bug_project = '941' -bug_tag = 'doc' - -# 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 = 'bifrostdoc' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass # [howto/manual]). latex_documents = [ ('index', - '%s.tex' % project, - u'%s Documentation' % project, + 'doc-bifrost.tex', + u'Bifrost Documentation', u'OpenStack Foundation', 'manual'), ] diff --git a/lower-constraints.txt b/lower-constraints.txt index e3c05aeb6..2e761635c 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -65,6 +65,7 @@ six==1.11.0 snowballstemmer==1.2.1 Sphinx==1.6.5 sphinxcontrib-websupport==1.0.1 +sphinxcontrib-svg2pdfconverter==0.1.0 stevedore==1.28.0 testrepository==0.0.18 testscenarios==0.4 diff --git a/tox.ini b/tox.ini index e223af0e7..b7aa97e69 100644 --- a/tox.ini +++ b/tox.ini @@ -38,6 +38,13 @@ deps = -r{toxinidir}/doc/requirements.txt commands = sphinx-build -W -b html doc/source doc/build/html +[testenv:pdf-docs] +basepython = python3 +whitelist_externals = make +deps = {[testenv:docs]deps} +commands = sphinx-build -W -b latex doc/source doc/build/pdf + make -C doc/build/pdf + [testenv:debug] basepython = python3 commands = oslo_debug_helper -t bifrost/tests {posargs}