forked from spatialaudio/nbsphinx
-
Notifications
You must be signed in to change notification settings - Fork 0
/
nbsphinx.py
1281 lines (1050 loc) · 41.6 KB
/
nbsphinx.py
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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright (c) 2015-2016 Matthias Geier
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
"""Jupyter Notebook Tools for Sphinx.
http://nbsphinx.rtfd.org/
"""
__version__ = '0.2.12'
import copy
import json
import os
import re
import subprocess
try:
from urllib.parse import unquote # Python 3.x
except ImportError:
from urllib2 import unquote # Python 2.x
import docutils
from docutils.parsers import rst
import jinja2
import nbconvert
import nbformat
import sphinx
import sphinx.errors
import traitlets
_ipynbversion = 4
# See nbconvert/exporters/html.py:
DISPLAY_DATA_PRIORITY_HTML = (
'application/javascript',
'application/vnd.jupyter.widget-view+json',
'application/vnd.jupyter.widget-state+json',
'text/html',
'text/markdown',
'image/svg+xml',
'text/latex',
'image/png',
'image/jpeg',
'text/plain',
)
# See nbconvert/exporters/latex.py:
DISPLAY_DATA_PRIORITY_LATEX = (
'text/latex',
'application/pdf',
'image/png',
'image/jpeg',
'image/svg+xml',
'text/markdown',
'text/plain',
)
RST_TEMPLATE = """
{% extends 'rst.tpl' %}
{% macro insert_empty_lines(text) %}
{%- set before, after = text | get_empty_lines %}
{%- if before %}
:empty-lines-before: {{ before }}
{%- endif %}
{%- if after %}
:empty-lines-after: {{ after }}
{%- endif %}
{%- endmacro %}
{% block any_cell %}
{%- if cell.metadata.nbsphinx != 'hidden' %}
{{ super() }}
{% endif %}
{%- endblock any_cell %}
{% block input -%}
.. nbinput:: {% if cell.metadata.magics_language -%}
{{ cell.metadata.magics_language }}
{%- elif nb.metadata.language_info -%}
{{ nb.metadata.language_info.pygments_lexer or nb.metadata.language_info.name }}
{%- else -%}
{{ resources.codecell_lexer }}
{%- endif -%}
{{ insert_empty_lines(cell.source) }}
{%- if cell.execution_count %}
:execution-count: {{ cell.execution_count }}
{%- endif %}
{%- if not cell.outputs %}
:no-output:
{%- endif %}
{%- if cell.source.strip() %}
{{ cell.source.strip('\n') | indent }}
{%- endif %}
{% endblock input %}
{% macro insert_nboutput(datatype, output, cell) -%}
.. nboutput::
{%- if datatype == 'text/plain' %}{# nothing #}
{%- else %} rst
{%- endif %}
{%- if output.output_type == 'execute_result' and cell.execution_count %}
:execution-count: {{ cell.execution_count }}
{%- endif %}
{%- if output != cell.outputs[-1] %}
:more-to-come:
{%- endif %}
{%- if output.name == 'stderr' %}
:class: stderr
{%- endif %}
{%- if datatype == 'text/plain' -%}
{{ insert_empty_lines(output.data[datatype]) }}
{{ output.data[datatype].strip(\n) | indent }}
{%- elif datatype in ['image/svg+xml', 'image/png', 'image/jpeg', 'application/pdf'] %}
.. image:: {{ output.metadata.filenames[datatype] | posix_path }}
{%- elif datatype in ['text/markdown'] %}
{{ output.data['text/markdown'] | markdown2rst | indent }}
{%- elif datatype in ['text/latex'] %}
.. math::
{{ output.data['text/latex'] | strip_dollars | indent | indent }}
{%- elif datatype == 'text/html' %}
.. raw:: html
{{ output.data['text/html'] | indent | indent }}
{%- elif datatype == 'application/javascript' %}
{% set div_id = uuid4() %}
.. raw:: html
<div id="{{ div_id }}"></div>
<script type="text/javascript">
var element = document.getElementById('{{ div_id }}');
{{ output.data['application/javascript'] | indent | indent }}
</script>
{%- elif datatype.startswith('application') and datatype.endswith('+json') %}
.. raw:: html
<script type="{{ datatype }}">{{ output.data[datatype] | json_dumps }}</script>
{%- elif datatype == 'ansi' %}
.. rst-class:: highlight
.. raw:: html
<pre>
{{ output.data[datatype] | ansi2html | indent | indent }}
</pre>
.. raw:: latex
% This comment is needed to force a line break for adjacent ANSI cells
\\begin{OriginalVerbatim}[commandchars=\\\\\\{\\}]
{{ output.data[datatype] | ansi2latex | indent | indent }}
\\end{OriginalVerbatim}
{% else %}
.. nbwarning:: Data type cannot be displayed: {{ datatype }}
{%- endif %}
{% endmacro %}
{% block nboutput -%}
{%- set html_datatype, latex_datatype = output | get_output_type %}
{%- if html_datatype == latex_datatype %}
{{ insert_nboutput(html_datatype, output, cell) }}
{%- else %}
.. only:: html
{{ insert_nboutput(html_datatype, output, cell) | indent }}
.. only:: latex
{{ insert_nboutput(latex_datatype, output, cell) | indent }}
{%- endif %}
{% endblock nboutput %}
{% block execute_result %}{{ self.nboutput() }}{% endblock execute_result %}
{% block display_data %}{{ self.nboutput() }}{% endblock display_data %}
{% block stream %}{{ self.nboutput() }}{% endblock stream %}
{% block error %}{{ self.nboutput() }}{% endblock error %}
{% block markdowncell %}
{%- if 'nbsphinx-toctree' in cell.metadata %}
{{ cell | extract_toctree }}
{%- else %}
{{ super() }}
{% endif %}
{% endblock markdowncell %}
{% block rawcell %}
{%- set raw_mimetype = cell.metadata.get('raw_mimetype', '').lower() %}
{%- if raw_mimetype == '' %}
.. raw:: html
{{ cell.source | indent }}
.. raw:: latex
{{ cell.source | indent }}
{%- elif raw_mimetype == 'text/html' %}
.. raw:: html
{{ cell.source | indent }}
{%- elif raw_mimetype == 'text/latex' %}
.. raw:: latex
{{ cell.source | indent }}
{%- elif raw_mimetype == 'text/markdown' %}
{{ cell.source | markdown2rst }}
{%- elif raw_mimetype == 'text/restructuredtext' %}
{{ cell.source }}
{% endif %}
{% endblock rawcell %}
{% block footer %}
{% if 'application/vnd.jupyter.widget-state+json' in nb.metadata.widgets %}
.. raw:: html
<script type="application/vnd.jupyter.widget-state+json">
{{ nb.metadata.widgets['application/vnd.jupyter.widget-state+json'] | json_dumps }}
</script>
{% endif %}
{{ super() }}
{% endblock footer %}
"""
LATEX_PREAMBLE = r"""
% Jupyter Notebook prompt colors
\definecolor{nbsphinxin}{HTML}{303F9F}
\definecolor{nbsphinxout}{HTML}{D84315}
% ANSI colors for output streams and traceback highlighting
\definecolor{ansi-black}{HTML}{3E424D}
\definecolor{ansi-black-intense}{HTML}{282C36}
\definecolor{ansi-red}{HTML}{E75C58}
\definecolor{ansi-red-intense}{HTML}{B22B31}
\definecolor{ansi-green}{HTML}{00A250}
\definecolor{ansi-green-intense}{HTML}{007427}
\definecolor{ansi-yellow}{HTML}{DDB62B}
\definecolor{ansi-yellow-intense}{HTML}{B27D12}
\definecolor{ansi-blue}{HTML}{208FFB}
\definecolor{ansi-blue-intense}{HTML}{0065CA}
\definecolor{ansi-magenta}{HTML}{D160C4}
\definecolor{ansi-magenta-intense}{HTML}{A03196}
\definecolor{ansi-cyan}{HTML}{60C6C8}
\definecolor{ansi-cyan-intense}{HTML}{258F8F}
\definecolor{ansi-white}{HTML}{C5C1B4}
\definecolor{ansi-white-intense}{HTML}{A1A6B2}
"""
CSS_STRING = """
/* CSS for nbsphinx extension */
/* remove conflicting styling from Sphinx themes */
div.nbinput,
div.nbinput div.prompt,
div.nbinput div.input_area,
div.nbinput div[class*=highlight],
div.nbinput div[class*=highlight] pre,
div.nboutput,
div.nbinput div.prompt,
div.nbinput div.output_area,
div.nboutput div[class*=highlight],
div.nboutput div[class*=highlight] pre {
background: none;
border: none;
padding: 0 0;
margin: 0;
box-shadow: none;
}
/* avoid gaps between output lines */
div.nboutput div[class*=highlight] pre {
line-height: normal;
}
/* input/output containers */
div.nbinput,
div.nboutput {
display: -webkit-flex;
display: flex;
align-items: flex-start;
margin: 0;
width: 100%%;
}
@media (max-width: %(nbsphinx_responsive_width)s) {
div.nbinput,
div.nboutput {
flex-direction: column;
}
}
/* input container */
div.nbinput {
padding-top: 5px;
}
/* last container */
div.nblast {
padding-bottom: 5px;
}
/* input prompt */
div.nbinput div.prompt pre {
color: #303F9F;
}
/* output prompt */
div.nboutput div.prompt pre {
color: #D84315;
}
/* all prompts */
div.nbinput div.prompt,
div.nboutput div.prompt {
min-width: %(nbsphinx_prompt_width)s;
padding-top: 0.4em;
padding-right: 0.4em;
text-align: right;
flex: 0;
}
@media (max-width: %(nbsphinx_responsive_width)s) {
div.nbinput div.prompt,
div.nboutput div.prompt {
text-align: left;
padding: 0.4em;
}
div.nboutput div.prompt.empty {
padding: 0;
}
}
/* input/output area */
div.nbinput div.input_area,
div.nboutput div.output_area {
padding: 0.4em;
-webkit-flex: 1;
flex: 1;
overflow: auto;
}
@media (max-width: %(nbsphinx_responsive_width)s) {
div.nbinput div.input_area,
div.nboutput div.output_area {
width: 100%%;
}
}
/* input area */
div.nbinput div.input_area {
border: 1px solid #cfcfcf;
border-radius: 2px;
background: #f7f7f7;
}
/* override MathJax center alignment in output cells */
div.nboutput div[class*=MathJax] {
text-align: left !important;
}
/* override sphinx.ext.pngmath center alignment in output cells */
div.nboutput div.math p {
text-align: left;
}
/* standard error */
div.nboutput div.output_area.stderr {
background: #fdd;
}
/* ANSI colors */
.ansi-black-fg { color: #3E424D; }
.ansi-black-bg { background-color: #3E424D; }
.ansi-black-intense-fg { color: #282C36; }
.ansi-black-intense-bg { background-color: #282C36; }
.ansi-red-fg { color: #E75C58; }
.ansi-red-bg { background-color: #E75C58; }
.ansi-red-intense-fg { color: #B22B31; }
.ansi-red-intense-bg { background-color: #B22B31; }
.ansi-green-fg { color: #00A250; }
.ansi-green-bg { background-color: #00A250; }
.ansi-green-intense-fg { color: #007427; }
.ansi-green-intense-bg { background-color: #007427; }
.ansi-yellow-fg { color: #DDB62B; }
.ansi-yellow-bg { background-color: #DDB62B; }
.ansi-yellow-intense-fg { color: #B27D12; }
.ansi-yellow-intense-bg { background-color: #B27D12; }
.ansi-blue-fg { color: #208FFB; }
.ansi-blue-bg { background-color: #208FFB; }
.ansi-blue-intense-fg { color: #0065CA; }
.ansi-blue-intense-bg { background-color: #0065CA; }
.ansi-magenta-fg { color: #D160C4; }
.ansi-magenta-bg { background-color: #D160C4; }
.ansi-magenta-intense-fg { color: #A03196; }
.ansi-magenta-intense-bg { background-color: #A03196; }
.ansi-cyan-fg { color: #60C6C8; }
.ansi-cyan-bg { background-color: #60C6C8; }
.ansi-cyan-intense-fg { color: #258F8F; }
.ansi-cyan-intense-bg { background-color: #258F8F; }
.ansi-white-fg { color: #C5C1B4; }
.ansi-white-bg { background-color: #C5C1B4; }
.ansi-white-intense-fg { color: #A1A6B2; }
.ansi-white-intense-bg { background-color: #A1A6B2; }
.ansi-bold { font-weight: bold; }
"""
CSS_STRING_READTHEDOCS = """
/* CSS overrides for sphinx_rtd_theme */
/* 24px margin */
.nbinput.nblast,
.nboutput.nblast {
margin-bottom: 19px; /* padding has already 5px */
}
/* ... except between code cells! */
.nblast + .nbinput {
margin-top: -19px;
}
/* nice headers on first paragraph of info/warning boxes */
.admonition .first {
margin: -12px;
padding: 6px 12px;
margin-bottom: 12px;
color: #fff;
line-height: 1;
display: block;
}
.admonition.warning .first {
background: #f0b37e;
}
.admonition.note .first {
background: #6ab0de;
}
.admonition > p:before {
margin-right: 4px; /* make room for the exclamation icon */
}
"""
class Exporter(nbconvert.RSTExporter):
"""Convert Jupyter notebooks to reStructuredText.
Uses nbconvert to convert Jupyter notebooks to a reStructuredText
string with custom reST directives for input and output cells.
Notebooks without output cells are automatically executed before
conversion.
"""
def __init__(self, execute='auto', execute_arguments=[],
allow_errors=False, timeout=30, codecell_lexer='none'):
"""Initialize the Exporter."""
self._execute = execute
self._execute_arguments = execute_arguments
self._allow_errors = allow_errors
self._timeout = timeout
self._codecell_lexer = codecell_lexer
loader = jinja2.DictLoader({'nbsphinx-rst.tpl': RST_TEMPLATE})
super(Exporter, self).__init__(
template_file='nbsphinx-rst', extra_loaders=[loader],
config= traitlets.config.Config(
{'HighlightMagicsPreprocessor': {'enabled': True}}),
filters={
'markdown2rst': markdown2rst,
'get_empty_lines': _get_empty_lines,
'extract_toctree': _extract_toctree,
'get_output_type': _get_output_type,
'json_dumps': json.dumps,
})
def from_notebook_node(self, nb, resources=None, **kw):
nb = copy.deepcopy(nb)
if resources is None:
resources = {}
else:
resources = copy.deepcopy(resources)
# Set default codecell lexer
resources['codecell_lexer'] = self._codecell_lexer
nbsphinx_metadata = nb.metadata.get('nbsphinx', {})
execute = nbsphinx_metadata.get('execute', self._execute)
if execute not in ('always', 'never', 'auto'):
raise ValueError('invalid execute option: {!r}'.format(execute))
auto_execute = (
# At least one code cell actually containing source code:
any(c.source for c in nb.cells if c.cell_type == 'code') and
# No outputs, not even a prompt number:
not any(c.get('outputs') or c.get('execution_count')
for c in nb.cells if c.cell_type == 'code')
)
if execute == 'always' or (execute == 'auto' and auto_execute):
allow_errors = nbsphinx_metadata.get(
'allow_errors', self._allow_errors)
timeout = nbsphinx_metadata.get('timeout', self._timeout)
pp = nbconvert.preprocessors.ExecutePreprocessor(
extra_arguments=self._execute_arguments,
allow_errors=allow_errors, timeout=timeout)
nb, resources = pp.preprocess(nb, resources)
# Call into RSTExporter
rststr, resources = super(Exporter, self).from_notebook_node(
nb, resources, **kw)
orphan = nbsphinx_metadata.get('orphan', False)
if orphan is True:
rststr = ':orphan:\n\n' + rststr
elif orphan is not False:
raise ValueError('invalid orphan option: {!r}'.format(orphan))
return rststr, resources
class NotebookParser(rst.Parser):
"""Sphinx source parser for Jupyter notebooks.
Uses nbsphinx.Exporter to convert notebook content to a
reStructuredText string, which is then parsed by Sphinx's built-in
reST parser.
"""
def get_transforms(self):
"""List of transforms for documents parsed by this parser."""
return rst.Parser.get_transforms(self) + [
ProcessLocalLinks, CreateSectionLabels, ReplaceAlertDivs]
def parse(self, inputstring, document):
"""Parse `inputstring`, write results to `document`."""
nb = nbformat.reads(inputstring, as_version=_ipynbversion)
env = document.settings.env
srcdir = os.path.dirname(env.doc2path(env.docname))
auxdir = os.path.join(env.doctreedir, 'nbsphinx')
sphinx.util.ensuredir(auxdir)
resources = {}
# Working directory for ExecutePreprocessor
resources['metadata'] = {'path': srcdir}
# Sphinx doesn't accept absolute paths in images etc.
resources['output_files_dir'] = os.path.relpath(auxdir, srcdir)
resources['unique_key'] = re.sub('[/ ]', '_', env.docname)
exporter = Exporter(
execute=env.config.nbsphinx_execute,
execute_arguments=env.config.nbsphinx_execute_arguments,
allow_errors=env.config.nbsphinx_allow_errors,
timeout=env.config.nbsphinx_timeout,
codecell_lexer=env.config.nbsphinx_codecell_lexer,
)
try:
rststring, resources = exporter.from_notebook_node(nb, resources)
except nbconvert.preprocessors.execute.CellExecutionError as e:
lines = str(e).split('\n')
lines[0] = 'CellExecutionError in {}:'.format(
env.doc2path(env.docname, base=None))
lines.append("You can ignore this error by setting the following "
"in conf.py:\n\n nbsphinx_allow_errors = True\n")
raise NotebookError('\n'.join(lines))
except Exception as e:
raise NotebookError(type(e).__name__ + ' in ' +
env.doc2path(env.docname, base=None) + ':\n' +
str(e))
# Create additional output files (figures etc.),
# see nbconvert.writers.FilesWriter.write()
for filename, data in resources.get('outputs', {}).items():
dest = os.path.normpath(os.path.join(srcdir, filename))
with open(dest, 'wb') as f:
f.write(data)
rst.Parser.parse(self, rststring, document)
class NotebookError(sphinx.errors.SphinxError):
"""Error during notebook parsing."""
category = 'Notebook error'
class CodeNode(docutils.nodes.Element):
"""A custom node that contains a literal_block node."""
@classmethod
def create(cls, text, language='none', **kwargs):
"""Create a new CodeNode containing a literal_block node.
Apparently, this cannot be done in CodeNode.__init__(), see:
https://groups.google.com/forum/#!topic/sphinx-dev/0chv7BsYuW0
"""
node = docutils.nodes.literal_block(text, text, language=language,
**kwargs)
return cls(text, node)
class AdmonitionNode(docutils.nodes.Element):
"""A custom node for info and warning boxes."""
# See http://docutils.sourceforge.net/docs/howto/rst-directives.html
class NbInput(rst.Directive):
"""A notebook input cell with prompt and code area."""
required_arguments = 0
optional_arguments = 1 # lexer name
final_argument_whitespace = False
option_spec = {
'execution-count': rst.directives.positive_int,
'empty-lines-before': rst.directives.nonnegative_int,
'empty-lines-after': rst.directives.nonnegative_int,
'no-output': rst.directives.flag,
}
has_content = True
def run(self):
"""This is called by the reST parser."""
execution_count = self.options.get('execution-count')
classes = ['nbinput']
if 'no-output' in self.options:
classes.append('nblast')
container = docutils.nodes.container(classes=classes)
# Input prompt
text = 'In [{}]:'.format(execution_count if execution_count else ' ')
container += CodeNode.create(text, classes=['prompt'])
latex_prompt = text + ' '
# Input code area
text = '\n'.join(self.content.data)
node = CodeNode.create(
text, language=self.arguments[0] if self.arguments else 'none',
classes=['input_area'])
_set_empty_lines(node, self.options)
node.attributes['latex_prompt'] = latex_prompt
container += node
self.state.document['nbsphinx_include_css'] = True
return [container]
class NbOutput(rst.Directive):
"""A notebook output cell with optional prompt."""
required_arguments = 0
optional_arguments = 1 # 'rst' or nothing (which means literal text)
final_argument_whitespace = False
option_spec = {
'execution-count': rst.directives.positive_int,
'more-to-come': rst.directives.flag,
'empty-lines-before': rst.directives.nonnegative_int,
'empty-lines-after': rst.directives.nonnegative_int,
'class': rst.directives.unchanged,
}
has_content = True
def run(self):
"""This is called by the reST parser."""
outputtype = self.arguments[0] if self.arguments else ''
execution_count = self.options.get('execution-count')
classes = ['nboutput']
if 'more-to-come' not in self.options:
classes.append('nblast')
container = docutils.nodes.container(classes=classes)
# Optional output prompt
if execution_count:
text = 'Out[{}]:'.format(execution_count)
container += CodeNode.create(text, classes=['prompt'])
latex_prompt = text + ' '
else:
# Empty container for HTML:
container += rst.nodes.container(classes=['prompt', 'empty'])
latex_prompt = ''
# Output area
if outputtype == 'rst':
classes = [self.options.get('class', ''), 'output_area']
output_area = docutils.nodes.container(classes=classes)
self.state.nested_parse(self.content, self.content_offset,
output_area)
container += output_area
else:
text = '\n'.join(self.content.data)
node = CodeNode.create(text, classes=['output_area'])
_set_empty_lines(node, self.options)
node.attributes['latex_prompt'] = latex_prompt
container += node
self.state.document['nbsphinx_include_css'] = True
return [container]
class _NbAdmonition(rst.Directive):
"""Base class for NbInfo and NbWarning."""
required_arguments = 0
optional_arguments = 0
option_spec = {}
has_content = True
def run(self):
"""This is called by the reST parser."""
node = AdmonitionNode(classes=['admonition', self._class])
self.state.nested_parse(self.content, self.content_offset, node)
return [node]
class NbInfo(_NbAdmonition):
"""An information box."""
_class = 'note'
class NbWarning(_NbAdmonition):
"""A warning box."""
_class = 'warning'
def markdown2rst(text):
"""Convert a Markdown string to reST via pandoc.
This is very similar to nbconvert.filters.markdown.markdown2rst(),
except that it uses a pandoc filter to convert raw LaTeX blocks to
"math" directives (instead of "raw:: latex" directives).
"""
def rawlatex2math_hook(obj):
if obj.get('t') == 'RawBlock' and obj['c'][0] == 'latex':
obj['t'] = 'Para'
obj['c'] = [{
't': 'Math',
'c': [
{'t': 'DisplayMath', 'c': []},
obj['c'][1],
]
}]
return obj
def rawlatex2math(text):
json_data = json.loads(text, object_hook=rawlatex2math_hook)
return json.dumps(json_data)
rststring = pandoc(text, 'markdown', 'rst', filter_func=rawlatex2math)
return re.sub(r'^(\s*)\.\. math::$',
r'\1.. math::\1 :nowrap:',
rststring,
flags=re.MULTILINE)
def pandoc(source, fmt, to, filter_func=None):
"""Convert a string in format `from` to format `to` via pandoc.
This is based on nbconvert.utils.pandoc.pandoc() and extended to
allow passing a filter function.
"""
def encode(text):
return text if isinstance(text, bytes) else text.encode('utf-8')
def decode(data):
return data.decode('utf-8') if isinstance(data, bytes) else data
cmd1 = ['pandoc', '--from', fmt, '--to', 'json']
cmd2 = ['pandoc', '--from', 'json', '--to', to]
nbconvert.utils.pandoc.check_pandoc_version()
p = subprocess.Popen(cmd1, stdin=subprocess.PIPE, stdout=subprocess.PIPE)
json_data, _ = p.communicate(encode(source))
if filter_func:
json_data = encode(filter_func(decode(json_data)))
p = subprocess.Popen(cmd2, stdin=subprocess.PIPE, stdout=subprocess.PIPE)
out, _ = p.communicate(json_data)
return decode(out).rstrip('\n')
def _extract_toctree(cell):
"""Extract links from Markdown cell and create toctree."""
lines = ['.. toctree::']
options = cell.metadata['nbsphinx-toctree']
try:
for option, value in options.items():
if value is True:
lines.append(':{}:'.format(option))
elif value is False:
pass
else:
lines.append(':{}: {}'.format(option, value))
except AttributeError:
raise ValueError(
'invalid nbsphinx-toctree option: {!r}'.format(options))
text = nbconvert.filters.markdown2rst(cell.source)
settings = docutils.frontend.OptionParser(
components=(rst.Parser,)).get_default_values()
toctree_node = docutils.utils.new_document('extract_toctree', settings)
parser = rst.Parser()
parser.parse(text, toctree_node)
if 'caption' not in options:
for sec in toctree_node.traverse(docutils.nodes.section):
assert sec.children
assert isinstance(sec.children[0], docutils.nodes.title)
title = sec.children[0].astext()
lines.append(':caption: ' + title)
break
lines.append('') # empty line
for ref in toctree_node.traverse(docutils.nodes.reference):
lines.append(ref.astext().replace('\n', '') +
' <' + unquote(ref.get('refuri')) + '>')
return '\n '.join(lines)
def _get_empty_lines(text):
"""Get number of empty lines before and after code."""
before = len(text) - len(text.lstrip('\n'))
after = len(text) - len(text.strip('\n')) - before
return before, after
def _get_output_type(output):
"""Choose appropriate output data types for HTML and LaTeX."""
if output.output_type == 'stream':
html_datatype = latex_datatype = 'ansi'
text = output.text
output.data = {'ansi': text[:-1] if text.endswith('\n') else text}
elif output.output_type == 'error':
html_datatype = latex_datatype = 'ansi'
output.data = {'ansi': '\n'.join(output.traceback)}
else:
for datatype in DISPLAY_DATA_PRIORITY_HTML:
if datatype in output.data:
html_datatype = datatype
break
else:
html_datatype = ', '.join(output.data.keys())
for datatype in DISPLAY_DATA_PRIORITY_LATEX:
if datatype in output.data:
latex_datatype = datatype
break
else:
latex_datatype = ', '.join(output.data.keys())
return html_datatype, latex_datatype
def _set_empty_lines(node, options):
"""Set "empty lines" attributes on a CodeNode.
See http://stackoverflow.com/q/34050044/500098.
"""
for attr in 'empty-lines-before', 'empty-lines-after':
value = options.get(attr, 0)
if value:
node.attributes[attr] = value
class ProcessLocalLinks(docutils.transforms.Transform):
"""Process links to local files.
Marks local files to be copied to the HTML output directory and
turns links to local notebooks into ``:doc:``/``:ref:`` links.
Links to subsections are possible with ``...#Subsection-Title``.
These links use the labels created by CreateSectionLabels.
Links to subsections use ``:ref:``, links to whole notebooks use
``:doc:``. Latter can be useful if you have an ``index.rst`` but
also want a distinct ``index.ipynb`` for use with Jupyter.
In this case you can use such a link in a notebook::
[Back to main page](index.ipynb)
In Jupyter, this will create a "normal" link to ``index.ipynb``, but
in the files generated by Sphinx, this will become a link to the
main page created from ``index.rst``.
"""
default_priority = 400 # Should probably be adjusted?
def apply(self):
env = self.document.settings.env
for node in self.document.traverse(docutils.nodes.reference):
uri = node.get('refuri', '')
if not uri:
continue # No URI (e.g. named reference)
elif '://' in uri:
continue # Not a local link
elif uri.startswith('#') or uri.startswith('mailto:'):
continue # Nothing to be done
unquoted_uri = unquote(uri)
for suffix in env.config.source_suffix:
if unquoted_uri.lower().endswith(suffix.lower()):
target = unquoted_uri[:-len(suffix)]
break
else:
target = ''
if target:
target_ext = ''
reftype = 'doc'
refdomain = None
elif '.ipynb#' in uri.lower():
idx = uri.lower().find('.ipynb#')
target = unquote(uri[:idx])
target_ext = uri[idx:]
reftype = 'ref'
refdomain = 'std'
else:
file = os.path.normpath(
os.path.join(os.path.dirname(env.docname), unquoted_uri))
if not os.path.isfile(os.path.join(env.srcdir, file)):
env.app.warn('file not found: {!r}'.format(file),
env.doc2path(env.docname))
continue # Link is ignored
elif file.startswith('..'):
env.app.warn(
'link outside of source directory: {!r}'.format(file),
env.doc2path(env.docname))
continue # Link is ignored
if not hasattr(env, 'nbsphinx_files'):
env.nbsphinx_files = {}
env.nbsphinx_files.setdefault(env.docname, []).append(file)
continue # We're done here
target_docname = os.path.normpath(
os.path.join(os.path.dirname(env.docname), target))
if target_docname in env.found_docs:
if target_ext:
target = target_docname + target_ext
target = target.lower()
linktext = node.astext()
xref = sphinx.addnodes.pending_xref(
reftype=reftype, reftarget=target, refdomain=refdomain,
refwarn=True, refexplicit=True, refdoc=env.docname)
xref += docutils.nodes.Text(linktext, linktext)
node.replace_self(xref)
class CreateSectionLabels(docutils.transforms.Transform):
"""Make labels for each notebook and each section thereof.
These labels are referenced in ProcessLocalLinks.
Note: Sphinx lower-cases the HTML section IDs, Jupyter doesn't.
"""
default_priority = 250 # Before references.PropagateTargets (260)
def apply(self):
env = self.document.settings.env
i_still_have_to_create_the_notebook_label = True
for section in self.document.traverse(docutils.nodes.section):
assert section.children
assert isinstance(section.children[0], docutils.nodes.title)
title = section.children[0].astext()
link_id = title.replace(' ', '-')
section['ids'] = [link_id]