from fastai.gen_doc.nbdoc import *
Generates documentation for fastai classes, functions, types.
View documentation inside a Jupyter Notebook with show_doc or at docs.fast.ai
show_doc(show_doc, doc_string=False)
show_doc[source][test]
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_tests=True*)
No tests found for show_doc. To contribute a test please refer to this guide and this discussion.
Show the documentation of an elt (function, class or enum). doc_string decides 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][test]
get_source_link(file,line,display_text=*'[source]', ***kwargs**) →str
No tests found for get_source_link. To contribute a test please refer to this guide and this discussion.
Returns github link for given file
show_doc(show_video)
show_video[source][test]
show_video(url)
No tests found for show_video. To contribute a test please refer to this guide and this discussion.
Display video in url.
show_doc(show_video_from_youtube)
show_video_from_youtube[source][test]
show_video_from_youtube(code,start=*0*)
No tests found for show_video_from_youtube. To contribute a test please refer to this guide and this discussion.
Display video from Youtube with a code and a start time.
show_doc(get_exports)
get_exports[source][test]
get_exports(mod)
No tests found for get_exports. To contribute a test please refer to this guide and this discussion.
Get the exports of mod.
show_doc(get_fn_link)
get_fn_link[source][test]
get_fn_link(ft) →str
No tests found for get_fn_link. To contribute a test please refer to this guide and this discussion.
Return function link to notebook documentation of ft. Private functions link to source code
show_doc(get_ft_names)
get_ft_names[source][test]
get_ft_names(mod,include_inner=*False*) →List[str]
No tests found for get_ft_names. To contribute a test please refer to this guide and this discussion.
Return all the functions of module mod.
show_doc(is_enum)
is_enum[source][test]
is_enum()
No tests found for is_enum. To contribute a test please refer to this guide and this discussion.
Check if something is an enumerator.
show_doc(import_mod)
import_mod[source][test]
import_mod(mod_name:str,ignore_errors=*False*)
No tests found for import_mod. To contribute a test please refer to this guide and this discussion.
Return module from mod_name.
show_doc(link_docstring)
link_docstring[source][test]
link_docstring(modules,docstring:str,overwrite:bool=*False*) →str
No tests found for link_docstring. To contribute a test please refer to this guide and this discussion.
Search docstring for backticks and attempt to link those functions to respective documentation.
show_doc(jekyll_important)
jekyll_important[source][test]
jekyll_important(s)
No tests found for jekyll_important. To contribute a test please refer to this guide and this discussion.
show_doc(jekyll_warn)
jekyll_warn[source][test]
jekyll_warn(s)
No tests found for jekyll_warn. To contribute a test please refer to this guide and this discussion.
show_doc(jekyll_note)
jekyll_note[source][test]
jekyll_note(s)
No tests found for jekyll_note. To contribute a test please refer to this guide and this discussion.
show_doc(doc)
doc[source][test]
doc(elt)
No tests found for doc. To contribute a test please refer to this guide and this discussion.
Show show_doc info in preview window along with link to full docs.