Browse Source

Merge "Build pdf doc"

changes/31/682331/1
Zuul 1 week ago
parent
commit
7e1581bc06
3 changed files with 10 additions and 6 deletions
  1. 3
    5
      doc/source/conf.py
  2. 1
    1
      test-requirements.txt
  3. 6
    0
      tox.ini

+ 3
- 5
doc/source/conf.py View File

@@ -37,13 +37,11 @@ source_suffix = '.rst'
37 37
 master_doc = 'index'
38 38
 
39 39
 # General information about the project.
40
-project = u'ironic-python-agent-builder'
41 40
 copyright = u'2017, OpenStack Developers'
42 41
 
43 42
 # openstackdocstheme options
44 43
 repository_name = 'openstack/ironic-python-agent-builder'
45
-bug_project = 'ironic-python-agent'
46
-bug_tag = ''
44
+use_storyboard = True
47 45
 
48 46
 # If true, '()' will be appended to :func: etc. cross-reference text.
49 47
 add_function_parentheses = True
@@ -66,14 +64,14 @@ html_theme = 'openstackdocs'
66 64
 html_last_updated_fmt = '%Y-%m-%d %H:%M'
67 65
 
68 66
 # Output file base name for HTML help builder.
69
-htmlhelp_basename = '%sdoc' % project
67
+htmlhelp_basename = 'ironic-python-agent-builderdoc'
70 68
 
71 69
 # Grouping the document tree into LaTeX files. List of tuples
72 70
 # (source start file, target name, title, author, documentclass
73 71
 # [howto/manual]).
74 72
 latex_documents = [
75 73
     ('index',
76
-     '%s.tex' % project,
74
+     'doc-ironic-python-agent-builder.tex',
77 75
      u'Ironic Python Agent Builder Documentation',
78 76
      u'OpenStack Developers', 'manual'),
79 77
 ]

+ 1
- 1
test-requirements.txt View File

@@ -9,6 +9,6 @@ flake8-import-order>=0.13 # LGPLv3
9 9
 doc8>=0.6.0 # Apache-2.0
10 10
 sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
11 11
 sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD
12
-openstackdocstheme>=1.17.0 # Apache-2.0
12
+openstackdocstheme>=1.20.0 # Apache-2.0
13 13
 # releasenotes
14 14
 reno>=2.5.0 # Apache-2.0

+ 6
- 0
tox.ini View File

@@ -25,6 +25,12 @@ commands = {posargs}
25 25
 basepython = python3
26 26
 commands = python setup.py build_sphinx
27 27
 
28
+[testenv:pdf-docs]
29
+whitelist_externals = make
30
+basepython = python3
31
+commands = sphinx-build -b latex doc/source doc/build/pdf
32
+           make -C doc/build/pdf
33
+
28 34
 [testenv:releasenotes]
29 35
 basepython = python3
30 36
 commands =

Loading…
Cancel
Save