Documentation notebook functions¶

In [1]:

from fastai.gen_doc.nbdoc import *

nbdoc contains the functions for documentation notebooks. The most important is show_doc:

Show the documentation of a function¶

In [2]:

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.

Convenience functions¶

In [3]:

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.

In [4]:

show_doc(show_video)

`show_video`[source]

show_video(url)

Display video in url.

In [5]:

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.

Functions for internal fastai library use¶

In [6]:

show_doc(get_exports)

`get_exports`[source]

get_exports(mod)

Get the exports of mod.

In [7]:

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

In [8]:

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.

In [9]:

show_doc(is_enum)

`is_enum`[source]

is_enum()

Check if something is an enumerator.

In [10]:

show_doc(import_mod)

`import_mod`[source]

import_mod(mod_name:str, ignore_errors=False)

Return module from mod_name.

In [11]:

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.

Undocumented Methods - Methods moved below this line will intentionally be hidden¶

New Methods - Please document or move to the undocumented section¶

In [12]:

show_doc(jekyll_important)

`jekyll_important`[source]

jekyll_important(s)

In [13]:

show_doc(jekyll_warn)

`jekyll_warn`[source]

jekyll_warn(s)

In [14]:

show_doc(jekyll_note)

`jekyll_note`[source]

jekyll_note(s)

In [15]:

show_doc(doc)

`doc`[source]

doc(elt)

Show show_doc info in preview window along with link to full docs.

Documentation notebook functions¶

Show the documentation of a function¶

show_doc[source]

Convenience functions¶

get_source_link[source]

show_video[source]

show_video_from_youtube[source]

Functions for internal fastai library use¶

get_exports[source]

get_fn_link[source]

get_ft_names[source]

is_enum[source]

import_mod[source]

link_docstring[source]