#!/usr/bin/env python
# coding: utf-8

# # Documentation notebook functions

# In[1]:


from fastai.gen_doc.nbdoc import *


# [`nbdoc`](/gen_doc.nbdoc.html#gen_doc.nbdoc) contains the functions for documentation notebooks. The most important is [`show_doc`](/gen_doc.nbdoc.html#show_doc):

# ## Show the documentation of a function

# In[2]:


show_doc(show_doc, doc_string=False)


# 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)


# In[4]:


show_doc(show_video)


# In[5]:


show_doc(show_video_from_youtube)


# ## Functions for internal fastai library use

# In[6]:


show_doc(get_exports)


# Get the exports of `mod`.

# In[7]:


show_doc(get_fn_link)


# In[8]:


show_doc(get_ft_names)


# In[9]:


show_doc(is_enum)


# Check if something is an enumerator.

# In[10]:


show_doc(import_mod)


# In[11]:


show_doc(link_docstring)


# ## 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)


# 

# In[13]:


show_doc(jekyll_warn)


# 

# In[14]:


show_doc(jekyll_note)


# 

# In[15]:


show_doc(doc)


#