Skip to content

Commit fd10545

Browse files
committed
Use plain text
1 parent 223e80f commit fd10545

File tree

2 files changed

+108
-97
lines changed

2 files changed

+108
-97
lines changed

docs/source/ProtobufStructures.rst

Lines changed: 103 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,16 @@ SimulatorTableData
3636
.. list-table::
3737
:header-rows: 1
3838
:widths: 30 20 50
39+
:class: plain-table
3940

4041
* - Field
4142
- Type
4243
- Description
43-
* - ``compdat``
44-
- ``list[SimulatorCompdatEntry]``
44+
* - compdat
45+
- list[SimulatorCompdatEntry]
4546
-
46-
* - ``welspecs``
47-
- ``list[SimulatorWelspecsEntry]``
47+
* - welspecs
48+
- list[SimulatorWelspecsEntry]
4849
-
4950

5051

@@ -59,27 +60,28 @@ SimulatorCompdatEntry
5960
.. list-table::
6061
:header-rows: 1
6162
:widths: 30 20 50
63+
:class: plain-table
6264

6365
* - Field
6466
- Type
6567
- Description
66-
* - ``well_name``
67-
- ``str``
68+
* - well_name
69+
- str
6870
-
69-
* - ``grid_i``
70-
- ``int``
71+
* - grid_i
72+
- int
7173
-
72-
* - ``grid_j``
73-
- ``int``
74+
* - grid_j
75+
- int
7476
-
75-
* - ``upper_k``
76-
- ``int``
77+
* - upper_k
78+
- int
7779
-
78-
* - ``lower_k``
79-
- ``int``
80+
* - lower_k
81+
- int
8082
-
81-
* - ``open_shut_flag``
82-
- ``str``
83+
* - open_shut_flag
84+
- str
8385
-
8486

8587

@@ -88,39 +90,40 @@ SimulatorCompdatEntry
8890
.. list-table::
8991
:header-rows: 1
9092
:widths: 30 20 50
93+
:class: plain-table
9194

9295
* - Field
9396
- Type
9497
- Description
95-
* - ``saturation``
96-
- ``float | None``
98+
* - saturation
99+
- float | None
97100
-
98-
* - ``transmissibility``
99-
- ``float | None``
101+
* - transmissibility
102+
- float | None
100103
-
101-
* - ``diameter``
102-
- ``float | None``
104+
* - diameter
105+
- float | None
103106
-
104-
* - ``kh``
105-
- ``float | None``
107+
* - kh
108+
- float | None
106109
-
107-
* - ``skin_factor``
108-
- ``float | None``
110+
* - skin_factor
111+
- float | None
109112
-
110-
* - ``d_factor``
111-
- ``float | None``
113+
* - d_factor
114+
- float | None
112115
-
113-
* - ``direction``
114-
- ``str | None``
116+
* - direction
117+
- str | None
115118
-
116-
* - ``start_md``
117-
- ``float | None``
119+
* - start_md
120+
- float | None
118121
-
119-
* - ``end_md``
120-
- ``float | None``
122+
* - end_md
123+
- float | None
121124
-
122-
* - ``comment``
123-
- ``str | None``
125+
* - comment
126+
- str | None
124127
-
125128

126129

@@ -135,24 +138,25 @@ SimulatorWelspecsEntry
135138
.. list-table::
136139
:header-rows: 1
137140
:widths: 30 20 50
141+
:class: plain-table
138142

139143
* - Field
140144
- Type
141145
- Description
142-
* - ``well_name``
143-
- ``str``
146+
* - well_name
147+
- str
144148
-
145-
* - ``group_name``
146-
- ``str``
149+
* - group_name
150+
- str
147151
-
148-
* - ``grid_i``
149-
- ``int``
152+
* - grid_i
153+
- int
150154
-
151-
* - ``grid_j``
152-
- ``int``
155+
* - grid_j
156+
- int
153157
-
154-
* - ``phase``
155-
- ``str``
158+
* - phase
159+
- str
156160
-
157161

158162

@@ -161,33 +165,34 @@ SimulatorWelspecsEntry
161165
.. list-table::
162166
:header-rows: 1
163167
:widths: 30 20 50
168+
:class: plain-table
164169

165170
* - Field
166171
- Type
167172
- Description
168-
* - ``bhp_depth``
169-
- ``float | None``
173+
* - bhp_depth
174+
- float | None
170175
-
171-
* - ``drainage_radius``
172-
- ``float | None``
176+
* - drainage_radius
177+
- float | None
173178
-
174-
* - ``inflow_equation``
175-
- ``str | None``
179+
* - inflow_equation
180+
- str | None
176181
-
177-
* - ``auto_shut_in``
178-
- ``str | None``
182+
* - auto_shut_in
183+
- str | None
179184
-
180-
* - ``cross_flow``
181-
- ``str | None``
185+
* - cross_flow
186+
- str | None
182187
-
183-
* - ``pvt_num``
184-
- ``int | None``
188+
* - pvt_num
189+
- int | None
185190
-
186-
* - ``hydrostatic_density_calc``
187-
- ``str | None``
191+
* - hydrostatic_density_calc
192+
- str | None
188193
-
189-
* - ``fip_region``
190-
- ``int | None``
194+
* - fip_region
195+
- int | None
191196
-
192197

193198

@@ -202,15 +207,16 @@ SimulatorTableRequest
202207
.. list-table::
203208
:header-rows: 1
204209
:widths: 30 20 50
210+
:class: plain-table
205211

206212
* - Field
207213
- Type
208214
- Description
209-
* - ``wellpath_name``
210-
- ``str``
215+
* - wellpath_name
216+
- str
211217
-
212-
* - ``case_id``
213-
- ``int``
218+
* - case_id
219+
- int
214220
-
215221

216222

@@ -225,18 +231,19 @@ Vec3d
225231
.. list-table::
226232
:header-rows: 1
227233
:widths: 30 20 50
234+
:class: plain-table
228235

229236
* - Field
230237
- Type
231238
- Description
232-
* - ``x``
233-
- ``float``
239+
* - x
240+
- float
234241
-
235-
* - ``y``
236-
- ``float``
242+
* - y
243+
- float
237244
-
238-
* - ``z``
239-
- ``float``
245+
* - z
246+
- float
240247
-
241248

242249

@@ -251,18 +258,19 @@ Vec3i
251258
.. list-table::
252259
:header-rows: 1
253260
:widths: 30 20 50
261+
:class: plain-table
254262

255263
* - Field
256264
- Type
257265
- Description
258-
* - ``i``
259-
- ``int``
266+
* - i
267+
- int
260268
-
261-
* - ``j``
262-
- ``int``
269+
* - j
270+
- int
263271
-
264-
* - ``k``
265-
- ``int``
272+
* - k
273+
- int
266274
-
267275

268276

@@ -284,33 +292,34 @@ CellCorners
284292
.. list-table::
285293
:header-rows: 1
286294
:widths: 30 20 50
295+
:class: plain-table
287296

288297
* - Field
289298
- Type
290299
- Description
291-
* - ``c0``
292-
- ``Vec3d``
300+
* - c0
301+
- Vec3d
293302
-
294-
* - ``c1``
295-
- ``Vec3d``
303+
* - c1
304+
- Vec3d
296305
-
297-
* - ``c2``
298-
- ``Vec3d``
306+
* - c2
307+
- Vec3d
299308
-
300-
* - ``c3``
301-
- ``Vec3d``
309+
* - c3
310+
- Vec3d
302311
-
303-
* - ``c4``
304-
- ``Vec3d``
312+
* - c4
313+
- Vec3d
305314
-
306-
* - ``c5``
307-
- ``Vec3d``
315+
* - c5
316+
- Vec3d
308317
-
309-
* - ``c6``
310-
- ``Vec3d``
318+
* - c6
319+
- Vec3d
311320
-
312-
* - ``c7``
313-
- ``Vec3d``
321+
* - c7
322+
- Vec3d
314323
-
315324

316325

docs/source/generate_protobuf_docs.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -451,7 +451,8 @@ def _format_fields_table(self, fields: List[Dict]) -> str:
451451
# Create table header
452452
content = ".. list-table::\n"
453453
content += " :header-rows: 1\n"
454-
content += " :widths: 30 20 50\n\n"
454+
content += " :widths: 30 20 50\n"
455+
content += " :class: plain-table\n\n"
455456
content += " * - Field\n"
456457
content += " - Type\n"
457458
content += " - Description\n"
@@ -465,8 +466,9 @@ def _format_fields_table(self, fields: List[Dict]) -> str:
465466
elif field['modifier'] == 'optional':
466467
python_type = f"{python_type} | None"
467468

468-
field_name = f"``{field['name']}``"
469-
type_name = f"``{python_type}``"
469+
# Use plain text without code formatting
470+
field_name = field['name']
471+
type_name = python_type
470472
description = field['description'] if field['description'] else ""
471473

472474
content += f" * - {field_name}\n"

0 commit comments

Comments
 (0)