From d04b5f6d8045b1854cce248c933a3d054d9da799 Mon Sep 17 00:00:00 2001 From: Kaifeng Wang Date: Fri, 14 Jun 2019 11:20:26 +0800 Subject: [PATCH] Build pdf doc The is one of community goals that each project could produce a single PDF file. The pdf should be in the output of openstack-tox-docs job. TeX packages are required to build PDF locally, following is recommended: * inkscape * texlive-latex-base * texlive-latex-extra * texlive-fonts-recommended More about the goal: https://governance.openstack.org/tc/goals/train/pdf-doc-generation.html https://etherpad.openstack.org/p/train-pdf-support-goal https://etherpad.openstack.org/p/pdf-goal-train-common-problems Change-Id: Iade8e60f5e272d70b2bbfdcd8429a19e1f95f365 --- doc/source/conf.py | 2 +- requirements.txt | 2 +- specs/kilo-implemented/irmc-management-driver.rst | 4 ++-- tox.ini | 7 +++++++ 4 files changed, 11 insertions(+), 4 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 4f6f47b3..6bd82ace 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -182,7 +182,7 @@ latex_elements = { # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'Ironic-specs.tex', u'Ironic Specs', + ('index', 'doc-ironic-specs.tex', u'Ironic Specs', u'OpenStack Ironic Team', 'manual'), ] diff --git a/requirements.txt b/requirements.txt index 09241dbe..106d2558 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ pbr>=0.6,!=0.7,<1.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 yasfb>=0.5.1 diff --git a/specs/kilo-implemented/irmc-management-driver.rst b/specs/kilo-implemented/irmc-management-driver.rst index 64b384c3..c8056f24 100644 --- a/specs/kilo-implemented/irmc-management-driver.rst +++ b/specs/kilo-implemented/irmc-management-driver.rst @@ -27,7 +27,7 @@ Proposed change =============== This module inherits ipmitool.IPMIManagement and overrides the following two functions for iRMC Drivers, namely pxe_irmc, iscsi_irmc, -and agent_irmc [*]_, in order to make use of iRMC IPMI boot mode +and agent_irmc [#]_, in order to make use of iRMC IPMI boot mode get/set capability and SCCI get sensor data. This module will be re-factored, when Ironic set/get boot mode I/F @@ -50,7 +50,7 @@ is standardized in Ironic Management Interface. 'sensor_method=ipmitool', this function just calls the parent class function, ipmitool.IPMIManagement.get_sensors_data() as default. -.. [*] Driver consists of five elements. +.. [#] Driver consists of five elements. In the initial implementation, iRMC driver supports three combinations out of all combinations. diff --git a/tox.ini b/tox.ini index c4a168d7..9f877bcf 100644 --- a/tox.ini +++ b/tox.ini @@ -22,3 +22,10 @@ commands = {posargs} [testenv:docs] basepython = python3 commands = sphinx-build -W -b html doc/source doc/build/html + +[testenv:pdf-docs] +basepython = python3 +whitelist_externals = make +commands = sphinx-build -W -b latex doc/source doc/build/pdf + make -C doc/build/pdf +