Skip to content

Commit 3fc5e9a

Browse files
committed
fix issue 450
1 parent fe4d536 commit 3fc5e9a

File tree

2 files changed

+15
-65
lines changed

2 files changed

+15
-65
lines changed

nbdev/export2html.py

+4-26
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22

33
__all__ = ['HTMLParseAttrs', 'remove_widget_state', 'upd_metadata', 'hide_cells', 'clean_exports', 'treat_backticks',
44
'add_jekyll_notes', 'copy_images', 'adapt_img_path', 'escape_latex', 'collapse_cells', 'remove_hidden',
5-
'find_default_level', 'nb_code_cell', 'add_show_docs', 'add_show_docs', 'remove_fake_headers',
6-
'remove_empty', 'get_metadata', 'ExecuteShowDocPreprocessor', 'execute_nb', 'cite2link', 'write_tmpl',
7-
'write_tmpls', 'nbdev_build_lib', 'nbdev_exporter', 'process_cells', 'process_cell', 'convert_nb',
8-
'notebook2html', 'convert_md', 'nbdev_detach', 'make_readme', 'nbdev_build_docs', 'nbdev_nb2md',
9-
'create_default_sidebar', 'make_sidebar']
5+
'find_default_level', 'nb_code_cell', 'add_show_docs', 'remove_fake_headers', 'remove_empty', 'get_metadata',
6+
'ExecuteShowDocPreprocessor', 'execute_nb', 'cite2link', 'write_tmpl', 'write_tmpls', 'nbdev_build_lib',
7+
'nbdev_exporter', 'process_cells', 'process_cell', 'convert_nb', 'notebook2html', 'convert_md',
8+
'nbdev_detach', 'make_readme', 'nbdev_build_docs', 'nbdev_nb2md', 'create_default_sidebar', 'make_sidebar']
109

1110
# Cell
1211
from .imports import *
@@ -255,27 +254,6 @@ def nb_code_cell(source):
255254
def _show_doc_cell(name, cls_lvl=None):
256255
return nb_code_cell(f"show_doc({name}{'' if cls_lvl is None else f', default_cls_level={cls_lvl}'})")
257256

258-
def add_show_docs(cells, cls_lvl=None):
259-
"Add `show_doc` for each exported function or class"
260-
documented = []
261-
for cell in cells:
262-
m = check_re(cell, _re_show_doc)
263-
if not m: continue
264-
documented.append(m.group(1))
265-
266-
def _documented(name): return name in documented
267-
268-
for cell in cells:
269-
res.append(cell)
270-
if check_re(cell, _re_export):
271-
for n in export_names(cell['source'], func_only=True):
272-
if not _documented(n): res.insert(len(res)-1, _show_doc_cell(n, cls_lvl=cls_lvl))
273-
return res
274-
275-
# Cell
276-
def _show_doc_cell(name, cls_lvl=None):
277-
return nb_code_cell(f"show_doc({name}{'' if cls_lvl is None else f', default_cls_level={cls_lvl}'})")
278-
279257
def add_show_docs(cells, cls_lvl=None):
280258
"Add `show_doc` for each exported function or class"
281259
documented = L(cells).map(check_re, pat=_re_show_doc).filter().map(Self.group(1))

nbs/03_export2html.ipynb

+11-39
Original file line numberDiff line numberDiff line change
@@ -935,34 +935,6 @@
935935
" return {'cell_type': 'code', 'execution_count': None, 'metadata': {}, 'outputs': [], 'source': source}"
936936
]
937937
},
938-
{
939-
"cell_type": "code",
940-
"execution_count": null,
941-
"metadata": {},
942-
"outputs": [],
943-
"source": [
944-
"#export\n",
945-
"def _show_doc_cell(name, cls_lvl=None):\n",
946-
" return nb_code_cell(f\"show_doc({name}{'' if cls_lvl is None else f', default_cls_level={cls_lvl}'})\")\n",
947-
"\n",
948-
"def add_show_docs(cells, cls_lvl=None):\n",
949-
" \"Add `show_doc` for each exported function or class\"\n",
950-
" documented = []\n",
951-
" for cell in cells:\n",
952-
" m = check_re(cell, _re_show_doc)\n",
953-
" if not m: continue\n",
954-
" documented.append(m.group(1))\n",
955-
"\n",
956-
" def _documented(name): return name in documented\n",
957-
"\n",
958-
" for cell in cells:\n",
959-
" res.append(cell)\n",
960-
" if check_re(cell, _re_export):\n",
961-
" for n in export_names(cell['source'], func_only=True):\n",
962-
" if not _documented(n): res.insert(len(res)-1, _show_doc_cell(n, cls_lvl=cls_lvl))\n",
963-
" return res"
964-
]
965-
},
966938
{
967939
"cell_type": "code",
968940
"execution_count": null,
@@ -1778,7 +1750,7 @@
17781750
"name": "stdout",
17791751
"output_type": "stream",
17801752
"text": [
1781-
"/var/folders/3y/vb18nv5d5mv5jy4_qtf92j9c0000gn/T/tmpea7py40r\n"
1753+
"/var/folders/3y/vb18nv5d5mv5jy4_qtf92j9c0000gn/T/tmposaq1isq\n"
17821754
]
17831755
}
17841756
],
@@ -1839,20 +1811,20 @@
18391811
"name": "stdout",
18401812
"output_type": "stream",
18411813
"text": [
1842-
"converting: /Users/hamelsmu/github/nbdev/nbs/99_search.ipynb\n",
1814+
"converting: /Users/hamelsmu/github/nbdev/nbs/nbdev_comments.ipynb\n",
1815+
"converting: /Users/hamelsmu/github/nbdev/nbs/00_export.ipynb\n",
18431816
"converting: /Users/hamelsmu/github/nbdev/nbs/03_export2html.ipynb\n",
1844-
"converting: /Users/hamelsmu/github/nbdev/nbs/example.ipynb\n",
18451817
"converting: /Users/hamelsmu/github/nbdev/nbs/04_test.ipynb\n",
1846-
"converting: /Users/hamelsmu/github/nbdev/nbs/00_export.ipynb\n",
1847-
"converting: /Users/hamelsmu/github/nbdev/nbs/07_clean.ipynb\n",
1848-
"converting: /Users/hamelsmu/github/nbdev/nbs/tutorial.ipynb\n",
1849-
"converting: /Users/hamelsmu/github/nbdev/nbs/index.ipynb\n",
1850-
"converting: /Users/hamelsmu/github/nbdev/nbs/01_sync.ipynb\n",
1851-
"converting: /Users/hamelsmu/github/nbdev/nbs/06_cli.ipynb\n",
18521818
"converting: /Users/hamelsmu/github/nbdev/nbs/05_merge.ipynb\n",
1819+
"converting: /Users/hamelsmu/github/nbdev/nbs/02_showdoc.ipynb\n",
1820+
"converting: /Users/hamelsmu/github/nbdev/nbs/index.ipynb\n",
1821+
"converting: /Users/hamelsmu/github/nbdev/nbs/example.ipynb\n",
1822+
"converting: /Users/hamelsmu/github/nbdev/nbs/99_search.ipynb\n",
1823+
"converting: /Users/hamelsmu/github/nbdev/nbs/07_clean.ipynb\n",
18531824
"converting: /Users/hamelsmu/github/nbdev/nbs/tutorial_colab.ipynb\n",
1854-
"converting: /Users/hamelsmu/github/nbdev/nbs/nbdev_comments.ipynbconverting: /Users/hamelsmu/github/nbdev/nbs/02_showdoc.ipynb\n",
1855-
"\n"
1825+
"converting: /Users/hamelsmu/github/nbdev/nbs/01_sync.ipynbconverting: /Users/hamelsmu/github/nbdev/nbs/06_cli.ipynb\n",
1826+
"\n",
1827+
"converting: /Users/hamelsmu/github/nbdev/nbs/tutorial.ipynb\n"
18561828
]
18571829
}
18581830
],

0 commit comments

Comments
 (0)