Skip to content

Commit b465ebc

Browse files
committed
docs: fix warnings
1 parent 4515fbc commit b465ebc

File tree

9 files changed

+26
-20
lines changed

9 files changed

+26
-20
lines changed

app/display/editor/doc/dynamic.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,5 @@ and behaviour of Phoebus.
1414
.. toctree::
1515
:maxdepth: 1
1616

17-
formula_functions
1817
rules
19-
scripts
18+
scripts

app/display/editor/doc/macros.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Simple Macros can be defined in several places.
1717

1818
1. On the command line when launching a display using the -resource option:
1919

20-
.. code-block:: python
20+
.. code-block:: bash
2121
2222
java -jar /path/to/application.jar -resource file:///path/to/display.bob?MyMacroValue=Some%20Value
2323

app/logbook/olog/ui/doc/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ The log entry editor may also be launched from context menus, where applicable.
4646
the background of an OPI the launched context menu will include the Create Log item:
4747

4848
.. image:: images/ContextMenu.png
49+
4950
The Create Log context menu item is available also in a Databrowser plot area.
5051

5152
Editing a log entry
@@ -74,6 +75,7 @@ When the log entry editor is launched from a context menu, a screen shot is auto
7475
Additional images (or other type of attachments) may be added by expanding the Attachments editor:
7576

7677
.. image:: images/Attachments.png
78+
7779
Here user may attach any number of files of arbitrary types:
7880

7981
- :guilabel:`Add Files` will launch the native file browser dialog from which user may select any number of files.
@@ -103,6 +105,7 @@ Images may be embedded in the body text using markup. The user should consult th
103105
for details on how to do this. In general, users should use the Embed Image button to add image markup at the cursor position:
104106

105107
.. image:: images/EmbedImage.png
108+
106109
External image resources may be edited manually, e.g.:
107110
``![alt-text](https://foo.com/bar.jpg)``.
108111
File URLs are not supported.
@@ -117,6 +120,7 @@ Properties are edited by expanding the Properties editor. The below screen shot
117120
(LCR shift info) holding five keys has been configured in the service:
118121

119122
.. image:: images/PropertiesEditor.png
123+
120124
User may select what properties to include in the log entry, and edit the values for the items in the property.
121125

122126

app/save-and-restore/app/doc/index.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -316,12 +316,14 @@ write operations is hence undefined.
316316
Prior to restore user has the option to:
317317

318318
* Exclude PVs using the checkboxes in the left-most column. To simplify selection, user may use the Filter input field to find matching PV names:
319-
.. image:: images/snapshot-restore-filter.png
320-
:width: 80%
319+
320+
.. image:: images/snapshot-restore-filter.png
321+
:width: 80%
321322

322323
* Specify a multiplier factor :math:`{\neq}` 1 applied to scalar data type PVs:
323-
.. image:: images/restore-with-scale.png
324-
:width: 80%
324+
325+
.. image:: images/restore-with-scale.png
326+
:width: 80%
325327

326328
Restoring from a composite snapshot works in the same manner as the restore operation from a single-snapshot.
327329

core/formula/doc/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ A prefix of the form "=xx(..)" is typically used to select the formula.
66

77

88
Operators
9-
----
9+
---------
10+
1011
You can use the following operators :
1112

1213
| **Arithmetic and maths operators :**

docs/source/converter.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Table:
1313
+ Converter application
1414

1515
Description
16-
------------
16+
-----------
1717

1818
AdvancedConverter is a tool to convert massively and recursively CSS OPI to Phoebus BOB files. It will automatically convert the widgets and their properties from the legacy file format.
1919

@@ -42,7 +42,7 @@ Exemples :
4242
**-main org.csstudio.display.builder.model.AdvancedConverter input/path/to/folder**
4343

4444
Converter application
45-
----------------------
45+
---------------------
4646

4747
Located in *Utility -> OPI converter*, it will generate a pop up window. In this pop up, you can choose a input file or folder with the Browse button in the input section. In a similar way, you can choose or not a output folder.
4848
To run the conversion you need to press the run button.

docs/source/convertor.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Table:
1313
+ Converter application
1414

1515
Description
16-
------------
16+
-----------
1717

1818
AdvancedConverter is a tool to convert massively and recursively CSS OPI to Phoebus BOB files. It will automatically convert the widgets and their properties from the legacy file format.
1919

@@ -42,7 +42,7 @@ Exemples :
4242
**-main org.csstudio.display.builder.model.AdvancedConverter input/path/to/folder**
4343

4444
Converter application
45-
----------------------
45+
---------------------
4646

4747
Located in *Utility -> OPI converter*, it will generate a pop up window. In this pop up, you can choose a input file or folder with the Browse button in the input section. In a similar way, you can choose or not a output folder.
4848
To run the conversion you need to press the run button.

docs/source/trouble_shooting.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ Impossible to run Phoebus under linux
2727

2828
| If you get the following error message:
2929
30-
.. code-block:: kmsg
31-
32-
/bin/java : permission denied
30+
.. code-block::
31+
32+
/bin/java : permission denied
3333
3434
| or
3535
36-
.. code-block:: kmsg
36+
.. code-block::
3737
3838
Error initializing QuantumRenderer: no suitable pipeline found
3939
java.lang.RuntimeException: java.lang.RuntimeException: Error initializing QuantumRenderer: no suitable pipeline found

services/save-and-restore/doc/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ Body:
135135

136136
.. code-block:: JSON
137137
138-
["nodeId-1", "nodeId-2",..., "nodeId-N"]
138+
["nodeId-1", "nodeId-2", "...", "nodeId-N"]
139139
140140
Return:
141141
Details of the nodes listed as unique node ids in the request body.
@@ -207,15 +207,15 @@ updated.
207207
Delete nodes
208208
""""""""""""
209209

210-
**.../node
210+
**.../node**
211211

212212
Method: DELETE
213213

214214
Caller must specify a body, which is a list of the unique ids of the nodes subject to deletion:
215215

216216
.. code-block:: JSON
217217
218-
["id_1", "id_2",...., "id_n"]
218+
["id_1", "id_2", "...", "id_n"]
219219
220220
Note that deletion is recursive and non-reversible:
221221

@@ -1051,7 +1051,7 @@ Authorization uses a role-based approach like so:
10511051
* Save-and-restore role "sar-admin": no restrictions
10521052

10531053
Authentication endpoint
1054-
"""""""""""""""""""""""
1054+
-----------------------
10551055

10561056
A client can may use the /login endpoint to check if user is authenticated:
10571057

0 commit comments

Comments
 (0)