diff --git a/doc/requirements.txt b/doc/requirements.txt index 3fefc1d..0eb62b8 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,4 +1,4 @@ reno>=3.1.0 # Apache-2.0 sphinx>=2.0.0,!=2.1.0 # BSD openstackdocstheme>=2.2.1 # Apache-2.0 -sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD \ No newline at end of file +sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index cefaa8d..bc9f842 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -20,7 +20,7 @@ sys.path.insert(0, os.path.abspath('../..')) # 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', + 'openstackdocstheme' ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -34,8 +34,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'virtualpdu' -copyright = u'2016, OpenStack Foundation' +copyright = '2016, OpenStack Foundation' # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -45,27 +44,36 @@ add_function_parentheses = True add_module_names = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' + +# openstackdocstheme options +openstackdocs_repo_name = 'openstack/virtualpdu' +openstackdocs_use_storyboard = True +openstackdocs_pdf_link = True # -- Options for HTML output -------------------------------------------------- # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. # html_theme_path = ["."] -# html_theme = '_theme' +html_theme = 'openstackdocs' # html_static_path = ['static'] # Output file base name for HTML help builder. -htmlhelp_basename = '%sdoc' % project +htmlhelp_basename = 'virtualpdudoc' + +latex_use_xindy = False # 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, - u'OpenStack Foundation', 'manual'), + 'doc-virtualpdu.tex', + 'VirtualPDU Documentation', + 'OpenStack Foundation', + 'manual' + ), ] # Example configuration for intersphinx: refer to the Python standard library. diff --git a/tox.ini b/tox.ini index f66757e..c595571 100644 --- a/tox.ini +++ b/tox.ini @@ -55,12 +55,11 @@ deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/up commands = sphinx-build -W -b html doc/source doc/build/html [testenv:pdf-docs] -usedevelop = False allowlist_externals = make -deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} - -r{toxinidir}/doc/requirements.txt -commands = sphinx-build -b latex doc/source doc/build/pdf - make -C doc/build/pdf +deps = {[testenv:docs]deps} +commands = + sphinx-build -W -b latex doc/source doc/build/pdf + make -C doc/build/pdf [testenv:releasenotes] usedevelop = False