Overriding `nbdev_build_docs` with our own
execute_nb
(nb
, mod
=None
, metadata
=None
, show_doc_only
=True
)
Execute nb
(or only the show_doc
cells) with metadata
Parameters: |
Type |
Default |
Details |
nb |
None Specified |
No Default |
mod |
<class 'NoneType'> |
None |
metadata |
<class 'NoneType'> |
None |
show_doc_only |
<class 'bool'> |
True |
convert_nb
(fname
, template_file
=None
, exporter
=None
, dest
=None
, execute
=True
)
Convert a notebook fname
to html file in dest_path
.
Parameters: |
Type |
Default |
Details |
fname |
None Specified |
No Default |
template_file |
<class 'NoneType'> |
None |
exporter |
<class 'NoneType'> |
None |
dest |
<class 'NoneType'> |
None |
execute |
<class 'bool'> |
True |
notebook2html
(fname
=None
, force_all
=False
, n_workers
=None
, template_file
=None
, exporter
=None
, dest
=None
, pause
=0
, execute
=True
)
Convert all notebooks matching fname
to html files
Parameters: |
Type |
Default |
Details |
fname |
<class 'NoneType'> |
None |
force_all |
<class 'bool'> |
False |
n_workers |
<class 'NoneType'> |
None |
template_file |
<class 'NoneType'> |
None |
exporter |
<class 'NoneType'> |
None |
dest |
<class 'NoneType'> |
None |
pause |
<class 'int'> |
0 |
execute |
<class 'bool'> |
True |
nbdev_build_docs
(fname
:"A notebook name or glob to convert"=None
, force_all
:"Rebuild even notebooks that haven't changed"=False
, mk_readme
:"Also convert the index notebook to README"=True
, n_workers
:"Number of workers to use"=None
, pause
:"Pause time (in secs) between notebooks to avoid race conditions"=0.5
)
Build the documentation by converting notebooks matching fname
to html
Parameters: |
Type |
Default |
Details |
fname |
str <A notebook name or glob to convert> |
None |
force_all |
bool_arg <Rebuild even notebooks that haven't changed> |
False |
mk_readme |
bool_arg <Also convert the index notebook to README> |
True |
n_workers |
int <Number of workers to use> |
None |
pause |
float <Pause time (in secs) between notebooks to avoid race conditions> |
0.5 |