1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
|
Sphinx-Data-Viewer
==================
A simple data viewer for data of type json or python object, which shows the data in an interactive
list-view on HTML pages.
.. data-viewer::
:expand:
{
"Peter Meister": {
"firstname": "Peter",
"surname": "Meister",
"is_female": false,
"city": "Munich",
"age": 26,
"height_m": 1.86,
"nicknames": ["Peti", "Pet", "Bomber"]
},
"Sandra Wilson": {
"firstname": "Sandra",
"surname": "Wilson",
"is_female": true,
"city": "London",
"age": 32,
"height_m": 1.67,
"nicknames": ["Sandy", "Wilma"]
}
}
.. dropdown:: Show source code for above example
.. code-block:: rst
.. data-viewer::
:expand:
{
"Peter Meister": {
"firstname": "Peter",
"surname": "Meister",
"is_female": false,
"city": "Munich",
"age": 26,
"height_m": 1.86,
"nicknames": ["Peti", "Pet", "Bomber"]
},
"Sandra Wilson": {
"firstname": "Sandra",
"surname": "Wilson",
"is_female": true,
"city": "London",
"age": 32,
"height_m": 1.67,
"nicknames": ["Sandy", "Wilma"]
}
}
Supports data from ``data-viewer`` content, files or variables from a ``conf.py`` configuration.
Installation
------------
Use ``pip`` to install ``Sphinx-Data-Viewer``
.. code-block:: python
pip install sphinx-data-viewer
Then add it to the extensions of your ``conf.py`` file
.. code-block:: python
extensions = [
"sphinx_data_viewer",
]
Options
-------
title
~~~~~
Sets a title in front of the data representation.
Default: None
.. tab-set::
.. tab-item:: Code
.. code-block:: rst
.. data-viewer::
:title: My first data viewer example
["apple", "orange", "banana"]
.. tab-item:: Result
.. data-viewer::
:title: My first data viewer example
["apple", "orange", "banana"]
expand
~~~~~~
Use ``expand`` to show the complete data.
``expand`` does not need any value, as it is a flag and its usage is enough to set it to True.
Default: False (not set)
.. tab-set::
.. tab-item:: Code
.. code-block:: rst
.. data-viewer::
:expand:
{
"Peter Meister": {
"firstname": "Peter",
"surname": "Meister",
"city": "Munich",
"age": 26,
"height_m": 1.86,
"nicknames": ["Peti", "Pet", "Bomber"]
},
"Sandra Wilson": {
"firstname": "Sandra",
"surname": "Wilson",
"city": "London",
"age": 32,
"height_m": 1.67,
"nicknames": ["Sandy", "Wilma"]
}
}
.. tab-item:: Result
.. data-viewer::
:expand:
{
"Peter Meister": {
"firstname": "Peter",
"surname": "Meister",
"city": "Munich",
"age": 26,
"height_m": 1.86,
"nicknames": ["Peti", "Pet", "Bomber"]
},
"Sandra Wilson": {
"firstname": "Sandra",
"surname": "Wilson",
"city": "London",
"age": 32,
"height_m": 1.67,
"nicknames": ["Sandy", "Wilma"]
}
}
file
~~~~
Use ``file`` to load data from a file.
``file`` takes an absolute or relative path.
If it is relative, an absolut path gets calculated based on current document path.
Default: None
.. tab-set::
.. tab-item:: Code
.. code-block:: rst
.. data-viewer::
:file: test.json
.. tab-item:: Data
.. literalinclude:: test.json
:language: json
.. tab-item:: Result
.. data-viewer::
:file: test.json
data
~~~~
``data`` defines a key, which is taken to look up for data in the configuration variable ``data_viewer_data``.
Default: None
.. tab-set::
.. tab-item:: Code
.. code-block:: rst
.. data-viewer::
:data: my_data
.. tab-item:: Config
.. code-block:: rst
# Inside conf.py
data_viewer_data = {
"my_data": {
"name": "Mario",
"job": "plumber",
"magic_tubes": [2, 7, 23, 43.5]
}
}
.. tab-item:: Result
.. data-viewer::
:data: my_data
Errors
------
The data must be always valid json-data, if it is coming from the content of ``data-viewer`` or if it gets read from
a file.
If ``data`` option is used to read data from the ``data_viewer_data`` option of your ``conf.py``, this referenced object
gets loaded via ``json.dumps()``, so that the object must be serializable.
Parsing exception can happen during Sphinx-Build and in the used JavaScript code when the browser loads the page.
If the JavaScript code detects problems, some error text gets printed on the webpage.
.. tab-set::
.. tab-item:: Result
Problem: Missing ``,`` after ``"Peter"``
.. data-viewer::
{
"name": "Peter"
"user": "peterbomber"
}
.. tab-item:: Code
.. code-block:: rst
Problem: Missing `,` after `"Peter"`
.. data-viewer::
{
"name": "Peter"
"user": "peterbomber"
}
Works well with...
------------------
Here are some ideas and examples, how ``data-viewer`` could be used together with other Sphinx extensions.
Sphinx-Needs
~~~~~~~~~~~~
Use `Sphinx-Needs <https://sphinxcontrib-needs.readthedocs.io>`_ to define process elements like requirements and
specifications. And ``Sphinx-Data-Viewer`` to explain data structures more easily.
.. tab-set::
.. tab-item:: Result
.. spec:: /api/user return value
:id: SPEC_001
:tags: endpoint, user
:status: open
For our API endpoint ``/api/user`` the default data structure of the return value of a successful GET
request shall look like:
.. data-viewer::
:expand:
{
"username": "peterbomber",
"email": "peterbomber@my_company.net",
"active": true
}
.. tab-item:: Code
.. code-block:: rst
.. spec:: /api/user return value
:id: SPEC_001
:tags: endpoint, user
:status: open
For our API endpoint ``/api/user`` the default data structure of the return value of a successful GET
request shall look like:
.. data-viewer::
:expand:
{
"username": "peterbomber",
"email": "peterbomber@my_company.net",
"active": true
}
Sphinx-Design
~~~~~~~~~~~~~
`Sphinx-Design <https://sphinx-design.readthedocs.io>`_ can be used to bring cards, tabs and dropdowns into your
documentation. It can help you to show source code or the data-viewer on user requests only.
All the dropdowns and tabs on this side got realised by ``Sphinx-Design``.
Take a look into `the current page source <_sources/index.rst.txt>`_ for a bunch of examples.
.. tab-set::
.. tab-item:: Result
.. grid:: 2
.. grid-item-card::
Data-Viewer 1
^^^^^^^^^^^^^
.. data-viewer::
:expand:
{
"name": "Peter",
"pets": ["dog", "cat"]
}
.. grid-item-card::
Data-Viewer 2
^^^^^^^^^^^^^
.. data-viewer::
:expand:
{
"name": "Sandra",
"pets": ["squirrel"]
}
.. tab-item:: Code
.. code-block:: rst
.. grid:: 2
.. grid-item-card::
Data-Viewer 1
^^^^^^^^^^^^^
.. data-viewer::
:expand:
{
"name": "Peter",
"pets": ["dog", "cat"]
}
.. grid-item-card::
Data-Viewer 2
^^^^^^^^^^^^^
.. data-viewer::
:expand:
{
"name": "Sandra",
"pets": ["squirrel"]
}
License
-------
This software project is released under the MIT license.
See `LICENSE file <https://github.com/useblocks/sphinx-data-viewer/blob/main/LICENSE>`_ for more details.
API
---
.. automodule:: sphinx_data_viewer.api
:members:
Kudos
-----
The javascript code is based on the wonderful work of https://github.com/pgrabovets/json-view.
Changelog
---------
0.1.4
~~~~~
:released: 25.1.2024
* Bugfix: Fix for builders, which do not support registration of CSS/JS files (e.g. sphinxcontrib-spelling)
0.1.3
~~~~~
:released: 25.1.2024
* Improvement: Updated project documentation to use the useblocks theme.
* Bugfix: Avoids multiple registrations of the same CSS/JS file.
0.1.2
~~~~~
:released: 07.12.2021
* Bugfix: Fixed wrong handling of windows path.
(`#2 <https://github.com/useblocks/sphinx-data-viewer/issues/2>`_)
0.1.1
~~~~~
:released: 30.11.2021
* Improvement: Provides API
* Improvement: Restructured code
0.1.0
~~~~~
:released: 26.11.2021
* Improvement: Provides ``data-viewer`` directive
* Improvement: Options added: file, title, data, expand
.. toctree::
:hidden:
|
