Browse Source

Adjust documentation for PDF

This change wraps lines when needed and tunes the configuration for PDF
generation.

Change-Id: Ia483681e196aea4c6e291231131ab0447a586aef
(cherry picked from commit 45fcf4ff2a)
tags/0.8.0^0
Simon Pasquier 3 years ago
parent
commit
afb2dfaa27
4 changed files with 13 additions and 4 deletions
  1. 5
    0
      doc/source/conf.py
  2. 3
    1
      doc/source/dev/outputs.rst
  3. 2
    1
      doc/source/user/alarms.rst
  4. 3
    2
      doc/source/user/installation.rst

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

@@ -261,3 +261,8 @@ texinfo_documents = [
261 261
 
262 262
 # If true, do not generate a @detailmenu in the "Top" node's menu.
263 263
 #texinfo_no_detailmenu = False
264
+
265
+# make latex stop printing blank pages between sections
266
+# http://stackoverflow.com/questions/5422997/sphinx-docs-remove-blank-pages-from-generated-pdfs
267
+latex_elements = {'classoptions': ',openany,oneside', 'babel':
268
+                  '\\usepackage[english]{babel}'}

+ 3
- 1
doc/source/dev/outputs.rst View File

@@ -55,7 +55,9 @@ For instance, lets take the following Heka message::
55 55
     :Pid: 15595
56 56
     :Uuid: e67f91c5-259b-489f-adfa-8eea0b389eb2
57 57
     :Logger: collectd
58
-    :Payload: {"type":"cpu","values":[0],"type_instance":"idle","dsnames":["value"],"plugin":"cpu","time":1442333737.646,"interval":10,"host":"node-1","dstypes":["derive"],"plugin_instance":"0"}
58
+    :Payload: {"type":"cpu","values":[0],"type_instance":"idle","dsnames":["value"],
59
+              "plugin":"cpu","time":1442333737.646,"interval":10,"host":"node-1",
60
+              "dstypes":["derive"],"plugin_instance":"0"}
59 61
     :EnvVersion:
60 62
     :Severity: 6
61 63
     :Fields:

+ 2
- 1
doc/source/user/alarms.rst View File

@@ -387,7 +387,8 @@ defines the default status in case none of the previous rules could be matched.
387 387
 
388 388
 A policy rule is defined as shown in the example below::
389 389
 
390
-   # The following rule definition reads as: "the cluster's status is critical if more than 50% of its members are either down or criticial"
390
+   # The following rule definition reads as: "the cluster's status is critical
391
+   # if more than 50% of its members are either down or criticial"
391 392
    - status: critical
392 393
      trigger:
393 394
        logical_operator: or

+ 3
- 2
doc/source/user/installation.rst View File

@@ -30,7 +30,8 @@ Catalog, you need to follow these steps:
30 30
 
31 31
 2. Copy the RPM file to the Fuel Master node::
32 32
 
33
-    [root@home ~]# scp lma_collector-0.8-0.8.0-1.noarch.rpm root@<Fuel Master node IP address>:
33
+    [root@home ~]# scp lma_collector-0.8-0.8.0-1.noarch.rpm \
34
+    root@<Fuel Master node IP address>:
34 35
 
35 36
 3. Install the plugin using the `Fuel CLI <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#using-fuel-cli>`_::
36 37
 
@@ -91,4 +92,4 @@ if you need further instructions about how to build the Fuel Plugin Builder.
91 92
 
92 93
 7. Now that you have created the RPM file, you can install the plugin using the `fuel plugins --install` command::
93 94
 
94
-    [root@fuel ~] fuel plugins --install ./fuel-plugin-lma_collector/lma_collector-0.8-0.8.0-1.noarch.rpm
95
+    [root@fuel ~] fuel plugins --install ./fuel-plugin-lma_collector/*.noarch.rpm

Loading…
Cancel
Save