Getting Started
Installation
jupycdocs can be downloaded from PyPi.
pip install jupydocs
Quick Start
from jupydocs.numpydocstring import NumpyDocString
def silly_function(name):
"""
Parameters
----------
name : str
The name of a person
Returns
-------
str
Let the person know they are silly!
"""
return(f'Hey {name}, you are silly!')
NumpyDocString(silly_function).render_md()
silly_function
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| name | str | The name of a person |
Returns
| TYPE | DESCRIPTION |
|---|---|
| str | Let the person know they are silly! |
print(NumpyDocString(silly_function).render_md(return_str=True))
## silly_function
### Parameters
| NAME | TYPE | DESCRIPTION |
|:-------|:-------|:---------------------|
| name | str | The name of a person |
### Returns
| TYPE | DESCRIPTION |
|:-------|:------------------------------------|
| str | Let the person know they are silly! |