Doctools
Provides tools to assist with generating documentation for SSVC decision points.
Writes the following files for each decision point: - a json example that can be used in the decision point documentation
Examples
To generate the documentation for the decision points, use the following command:
python -m ssvc.doctools --overwrite --jsondir ./tmp/json_out`
To regenerate the existing docs, use the following command:
python -m ssvc.doctools --overwrite --jsondir data/json/decision_points
EnsureDirExists
A runtime context that ensures that a directory exists or creates it otherwise.
Example:
with EnsureDirExists(dir):
assert os.path.exists(dir)
Source code in src/ssvc/doctools.py
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 |
|
__init__(dir)
Create a new EnsureDirExists context.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
dir
|
str
|
The directory to ensure exists. |
required |
Returns:
Name | Type | Description |
---|---|---|
EnsureDirExists |
The new EnsureDirExists context. |
Source code in src/ssvc/doctools.py
112 113 114 115 116 117 118 119 120 121 122 |
|
dump_decision_point(jsondir, dp, overwrite)
Generate the markdown table, json example, and markdown table file for a decision point.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
jsondir
|
str
|
The directory to write the json example to. |
required |
outdir
|
str
|
The directory to write the markdown table file to. |
required |
dp
|
SsvcDecisionPoint
|
The decision point to generate documentation for. |
required |
overwrite
|
bool
|
Whether to overwrite existing files. |
required |
Returns:
Name | Type | Description |
---|---|---|
dict |
None
|
A dictionary with the following keys: - include_file: The path to the markdown table file. - symlink: The path to the symlink that points to the markdown table file. - json_file: The path to the json example file. |
Source code in src/ssvc/doctools.py
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 |
|
dump_json(basename, dp, jsondir, overwrite)
Generate the json example for a decision point.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
basename
|
str
|
The basename of the json example file. |
required |
dp
|
SsvcDecisionPoint
|
The decision point to generate documentation for. |
required |
jsondir
|
str
|
The directory to write the json example to. |
required |
overwrite
|
bool
|
Whether to overwrite existing files. |
required |
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
The path to the json example file. |
Source code in src/ssvc/doctools.py
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
|
dump_selection_schema(filepath)
Dump the schema for the SelectionList model to a file. Args: filepath: The path to the file to write the schema to.
Returns:
Type | Description |
---|---|
None
|
None |
Source code in src/ssvc/doctools.py
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
|
find_modules_to_import(directory='../decision_points', package='ssvc.decision_points')
Find all modules that contain decision points and import them.
This is necessary to ensure that all decision points are registered.
Source code in src/ssvc/doctools.py
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
|