Browse Source

Merge "Build pdf doc"

master
Zuul 1 week ago
parent
commit
0c8dbfaf26
4 changed files with 16 additions and 11 deletions
  1. 5
    9
      doc/source/conf.py
  2. 1
    1
      lower-constraints.txt
  3. 1
    1
      test-requirements.txt
  4. 9
    0
      tox.ini

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

@@ -26,7 +26,6 @@ source_suffix = '.rst'
26 26
 master_doc = 'index'
27 27
 
28 28
 # General information about the project.
29
-project = u'Ironic Lib'
30 29
 copyright = u'OpenStack Foundation'
31 30
 
32 31
 # The version info for the project you're documenting, acts as replacement for
@@ -64,15 +63,12 @@ html_theme = 'openstackdocs'
64 63
 
65 64
 # openstackdocstheme options
66 65
 repository_name = 'openstack/ironic-lib'
67
-bug_project = 'ironic-lib'
68
-bug_tag = ''
69
-
70
-# Must set this variable to include year, month, day, hours, and minutes.
71
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
66
+use_storyboard = True
72 67
 
73 68
 # Output file base name for HTML help builder.
74
-htmlhelp_basename = '%sdoc' % project
69
+htmlhelp_basename = 'ironic-libdoc'
75 70
 
71
+latex_use_xindy = False
76 72
 
77 73
 # Grouping the document tree into LaTeX files. List of tuples
78 74
 # (source start file, target name, title, author, documentclass
@@ -80,8 +76,8 @@ htmlhelp_basename = '%sdoc' % project
80 76
 latex_documents = [
81 77
     (
82 78
         'index',
83
-        '%s.tex' % project,
84
-        u'%s Documentation' % project,
79
+        'doc-ironic-lib.tex',
80
+        u'Ironic Lib Documentation',
85 81
         u'OpenStack Foundation',
86 82
         'manual'
87 83
     ),

+ 1
- 1
lower-constraints.txt View File

@@ -29,7 +29,7 @@ mox3==0.20.0
29 29
 msgpack-python==0.4.0
30 30
 netaddr==0.7.18
31 31
 netifaces==0.10.4
32
-openstackdocstheme==1.18.1
32
+openstackdocstheme==1.20.0
33 33
 os-client-config==1.28.0
34 34
 os-testr==1.0.0
35 35
 oslo.concurrency==3.26.0

+ 1
- 1
test-requirements.txt View File

@@ -16,4 +16,4 @@ testtools>=2.2.0 # MIT
16 16
 doc8>=0.6.0 # Apache-2.0
17 17
 sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7'  # BSD
18 18
 sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4'  # BSD
19
-openstackdocstheme>=1.18.1 # Apache-2.0
19
+openstackdocstheme>=1.20.0 # Apache-2.0

+ 9
- 0
tox.ini View File

@@ -60,6 +60,15 @@ envdir = {toxworkdir}/venv
60 60
 commands =
61 61
   python setup.py build_sphinx
62 62
 
63
+[testenv:pdf-docs]
64
+whitelist_externals = make
65
+basepython = python3
66
+setenv = PYTHONHASHSEED=0
67
+sitepackages = False
68
+envdir = {toxworkdir}/venv
69
+commands = sphinx-build -b latex doc/source doc/build/pdf
70
+           make -C doc/build/pdf
71
+
63 72
 [testenv:lower-constraints]
64 73
 basepython = python3
65 74
 deps =

Loading…
Cancel
Save