Commit ff64c93
Add Event Writer docstrings and industrial section to block docs (#2214)
* Add Event Writer docstrings and industrial section to block docs (#ENT-1106)
- Add docstrings to BlockManifest, EventWriterSinkBlockV1, and run() so
mkdocstrings renders content on the API reference page
- Add "industrial" entry to BLOCK_SECTIONS so industrial blocks (Event
Writer, OPC Writer, MQTT Writer, PLC Ethernet/IP, PLC Modbus) appear
in the workflow block docs nav and index
Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
* Move Event Writer block from industrial to data_storage section
Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
* Trim Event Writer docstrings to match PLC block style
Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
* List Event Writer in both data_storage and industrial doc sections
Adds additional_sections support to build_block_docs.py so a block can
appear in multiple doc sections. Event Writer uses this to show up under
both Data Storage (its primary section) and Industrial.
Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
* Use industrial section for Event Writer, drop additional_sections logic
Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
---------
Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]>1 parent 5df1795 commit ff64c93
2 files changed
Lines changed: 33 additions & 0 deletions
File tree
- development/docs
- inference/enterprise/workflows/enterprise_blocks/sinks/event_writer
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
249 | 249 | | |
250 | 250 | | |
251 | 251 | | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
252 | 257 | | |
253 | 258 | | |
254 | 259 | | |
| |||
Lines changed: 28 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
95 | 95 | | |
96 | 96 | | |
97 | 97 | | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
98 | 106 | | |
99 | 107 | | |
100 | 108 | | |
| |||
294 | 302 | | |
295 | 303 | | |
296 | 304 | | |
| 305 | + | |
| 306 | + | |
| 307 | + | |
| 308 | + | |
| 309 | + | |
| 310 | + | |
| 311 | + | |
297 | 312 | | |
298 | 313 | | |
299 | 314 | | |
| |||
336 | 351 | | |
337 | 352 | | |
338 | 353 | | |
| 354 | + | |
| 355 | + | |
| 356 | + | |
| 357 | + | |
| 358 | + | |
| 359 | + | |
| 360 | + | |
| 361 | + | |
| 362 | + | |
| 363 | + | |
| 364 | + | |
| 365 | + | |
| 366 | + | |
339 | 367 | | |
340 | 368 | | |
341 | 369 | | |
| |||
0 commit comments