from fastai.gen_doc.nbdoc import *
show_doc(show_doc, doc_string=False)
show_doc[source]
show_doc(elt,doc_string:bool=True,full_name:str=None,arg_comments:dict=None,title_level=None,alt_doc_string:str='',ignore_warn:bool=False,markdown=True)
Show the documentation of an elt (function, class or enum). doc_string decices if we show the doc string of the element or not, full_name will override the name shown, arg_comments is a dictionary that will then show list the arguments with comments. title_level is the level of the corresponding cell in the TOC, alt_doc_string is a text that can replace the doc_string. ignore_warn will ignore warnings if you pass arguments in arg_comments that don't appear to belong to this function and markdown decides if the return is a Markdown cell or plain text.
Plenty of examples of uses of this cell can been seen through the documentation, and you will want to hide input those cells for a clean final result.
show_doc(get_source_link)
get_source_link[source]
get_source_link(mod,lineno,display_text='[source]') →str
Returns link to lineno in source code of mod.
show_doc(show_video)
show_doc(show_video_from_youtube)
show_video_from_youtube[source]
show_video_from_youtube(code,start=0)
Display video from Youtube with a code and a start time.
show_doc(get_exports)
get_exports[source]
get_exports(mod)
Get the exports of mod.
show_doc(get_fn_link)
get_fn_link[source]
get_fn_link(ft) →str
Return function link to notebook documentation of ft. Private functions link to source code
show_doc(get_ft_names)
get_ft_names[source]
get_ft_names(mod,include_inner=False) →List[str]
Return all the functions of module mod.
show_doc(is_enum)
is_enum[source]
is_enum()
Check if something is an enumerator.
show_doc(import_mod)
show_doc(link_docstring)
link_docstring[source]
link_docstring(modules,docstring:str,overwrite:bool=False) →str
Search docstring for backticks and attempt to link those functions to respective documentation.
show_doc(jekyll_important)
jekyll_important[source]
jekyll_important(s)
show_doc(jekyll_warn)
jekyll_warn[source]
jekyll_warn(s)
show_doc(jekyll_note)
jekyll_note[source]
jekyll_note(s)
show_doc(doc)