Skip to content

Commit d9680ca

Browse files
mickemmickem
committed
fixed script to make prettier reference docs
1 parent 201e10d commit d9680ca

34 files changed

+10148
-9805
lines changed

‎docs/reference/check/CheckExternalScripts.md

+893-787
Large diffs are not rendered by default.

‎docs/reference/check/CheckHelpers.md

+309-328
Large diffs are not rendered by default.

‎docs/reference/check/CheckLogFile.md

+248-270
Large diffs are not rendered by default.

‎docs/reference/check/CheckMKClient.md

+194-215
Large diffs are not rendered by default.

‎docs/reference/check/CheckMKServer.md

+304-269
Large diffs are not rendered by default.

‎docs/reference/check/CheckNSCP.md

+164-170
Large diffs are not rendered by default.

‎docs/reference/client/GraphiteClient.md

+286-277
Large diffs are not rendered by default.

‎docs/reference/client/NRDPClient.md

+266-262
Large diffs are not rendered by default.

‎docs/reference/client/NRPEClient.md

+517-493
Large diffs are not rendered by default.

‎docs/reference/client/NRPEServer.md

+382-322
Large diffs are not rendered by default.

‎docs/reference/client/NSCAClient.md

+514-472
Large diffs are not rendered by default.

‎docs/reference/client/NSCAServer.md

+354-299
Large diffs are not rendered by default.

‎docs/reference/client/SMTPClient.md

+190-204
Large diffs are not rendered by default.

‎docs/reference/client/SyslogClient.md

+204-215
Large diffs are not rendered by default.

‎docs/reference/generic/CommandClient.md

-4
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,10 @@ A command line client, generally not used except with "nscp test".
66

77

88

9-
## Command list
109

11-
**TODO:** Add a list of all external commands (this is not check commands)
1210

1311

1412

1513

1614

1715

18-
# Configuration
19-

‎docs/reference/generic/LUAScript.md

+10-26
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,9 @@ Loads and processes internal Lua scripts
66

77

88

9-
## Command list
109

11-
**TODO:** Add a list of all external commands (this is not check commands)
1210

13-
## Configuration list
11+
## List of Configuration
1412

1513

1614

@@ -22,23 +20,12 @@ Loads and processes internal Lua scripts
2220

2321
# Configuration
2422

25-
26-
27-
## /settings/lua
28-
29-
`/settings/lua`
30-
31-
**LUA SCRIPT SECTION**
23+
<a name="/settings/lua"/>
24+
## LUA SCRIPT SECTION
3225

3326
Section for the LUAScripts module.
3427

35-
36-
37-
38-
**Sample**::
39-
40-
```
41-
# LUA SCRIPT SECTION
28+
```ini
4229
# Section for the LUAScripts module.
4330
[/settings/lua]
4431

@@ -47,24 +34,21 @@ Section for the LUAScripts module.
4734

4835

4936

50-
## /settings/lua/scripts
5137

52-
`/settings/lua/scripts`
5338

54-
**LUA SCRIPTS SECTION**
39+
<a name="/settings/lua/scripts"/>
40+
## LUA SCRIPTS SECTION
5541

5642
A list of scripts available to run from the LuaSCript module.
5743

44+
```ini
45+
# A list of scripts available to run from the LuaSCript module.
46+
[/settings/lua/scripts]
5847

48+
```
5949

6050

61-
**Sample**::
6251

63-
```
64-
# LUA SCRIPTS SECTION
65-
# A list of scripts available to run from the LuaSCript module.
66-
[/settings/lua/scripts]
6752

68-
```
6953

7054

‎docs/reference/generic/PythonScript.md

+10-26
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,9 @@ Loads and processes internal Python scripts
66

77

88

9-
## Command list
109

11-
**TODO:** Add a list of all external commands (this is not check commands)
1210

13-
## Configuration list
11+
## List of Configuration
1412

1513

1614

@@ -22,23 +20,12 @@ Loads and processes internal Python scripts
2220

2321
# Configuration
2422

25-
26-
27-
## /settings/python
28-
29-
`/settings/python`
30-
31-
**LUA SCRIPT SECTION**
23+
<a name="/settings/python"/>
24+
## LUA SCRIPT SECTION
3225

3326
Section for the PythonScripts module.
3427

35-
36-
37-
38-
**Sample**::
39-
40-
```
41-
# LUA SCRIPT SECTION
28+
```ini
4229
# Section for the PythonScripts module.
4330
[/settings/python]
4431

@@ -47,24 +34,21 @@ Section for the PythonScripts module.
4734

4835

4936

50-
## /settings/python/scripts
5137

52-
`/settings/python/scripts`
5338

54-
**PYTHON SCRIPTS SECTION**
39+
<a name="/settings/python/scripts"/>
40+
## PYTHON SCRIPTS SECTION
5541

5642
A list of scripts available to run from the PythonScript module.
5743

44+
```ini
45+
# A list of scripts available to run from the PythonScript module.
46+
[/settings/python/scripts]
5847

48+
```
5949

6050

61-
**Sample**::
6251

63-
```
64-
# PYTHON SCRIPTS SECTION
65-
# A list of scripts available to run from the PythonScript module.
66-
[/settings/python/scripts]
6752

68-
```
6953

7054

‎docs/reference/generic/Scheduler.md

+29-42
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,16 @@ Use this to schedule check commands and jobs in conjunction with for instance pa
66

77

88

9-
## Command list
109

11-
**TODO:** Add a list of all external commands (this is not check commands)
1210

13-
## Configuration list
11+
## List of Configuration
1412

1513

16-
Common Keys:
14+
### Common Keys
1715

18-
| Path / Section | Key | Description|
19-
| -------------- | --- | -----------|
20-
| [/settings/scheduler](#/settings/scheduler) | [threads](#/settings/scheduler_threads) | THREAD COUNT|
16+
| Path / Section | Key | Description |
17+
|---------------------------------------------|-----------------------------------------|--------------|
18+
| [/settings/scheduler](#/settings/scheduler) | [threads](#/settings/scheduler_threads) | THREAD COUNT |
2119

2220

2321

@@ -27,49 +25,45 @@ Common Keys:
2725

2826
# Configuration
2927

30-
31-
32-
## /settings/scheduler
33-
34-
`/settings/scheduler`
35-
36-
**SCHEDULER SECTION**
28+
<a name="/settings/scheduler"/>
29+
## SCHEDULER SECTION
3730

3831
Section for the Scheduler module.
3932

40-
41-
| Key | Default Value | Description|
42-
| --- | ------------- | -----------|
43-
| [threads](#/settings/scheduler_threads) | 5 | THREAD COUNT|
44-
45-
46-
**Sample**::
47-
48-
```
49-
# SCHEDULER SECTION
33+
```ini
5034
# Section for the Scheduler module.
5135
[/settings/scheduler]
5236
threads=5
5337

5438
```
5539

5640

41+
| Key | Default Value | Description |
42+
|-----------------------------------------|---------------|--------------|
43+
| [threads](#/settings/scheduler_threads) | 5 | THREAD COUNT |
44+
45+
46+
47+
5748
<a name="/settings/scheduler_threads"/>
5849
### threads
5950

6051
**THREAD COUNT**
6152

6253
Number of threads to use.
6354

64-
**Path**: /settings/scheduler
6555

66-
**Key**: threads
6756

68-
**Default value**: 5
6957

70-
**Used by**: :module:`Scheduler`
58+
| Key | Description |
59+
|----------------|---------------------------------------------|
60+
| Path: | [/settings/scheduler](#/settings/scheduler) |
61+
| Key: | threads |
62+
| Default value: | `5` |
63+
| Used by: | Scheduler |
7164

72-
**Sample**::
65+
66+
#### Sample
7367

7468
```
7569
[/settings/scheduler]
@@ -78,26 +72,19 @@ threads=5
7872
```
7973

8074

81-
82-
83-
## /settings/scheduler/schedules
84-
85-
`/settings/scheduler/schedules`
86-
87-
**SCHEDULER SECTION**
75+
<a name="/settings/scheduler/schedules"/>
76+
## SCHEDULER SECTION
8877

8978
Section for the Scheduler module.
9079

80+
```ini
81+
# Section for the Scheduler module.
82+
[/settings/scheduler/schedules]
9183

84+
```
9285

9386

94-
**Sample**::
9587

96-
```
97-
# SCHEDULER SECTION
98-
# Section for the Scheduler module.
99-
[/settings/scheduler/schedules]
10088

101-
```
10289

10390

0 commit comments

Comments
 (0)