klink API¶

klink Package¶

klink.__init__.convert_notebooks()[source]¶

Converts IPython Notebooks to proper .rst files and moves static content to the _static directory.

klink.__init__.get_html_theme_path()[source]¶

Returns list of HTML theme paths.

class klink.demo.TestClass(name, age)[source]¶

Bases: object

This is a test class. Used for demo purposes.

Lorem ipsum dolor sit amet, cu vero viris mollis his. Ex est iusto constituam. Id eam graeci iuvaret facilis, erant dicunt in quo, te iudico periculis interpretaris sed. Audire tibique te pro, equidem repudiare an vim. Nostrum placerat liberavisse ne eam. Zril corpora expetenda ex mea, at wisi vitae vocibus vix.

Note

Does not actually do anything. Just for demo.

Args:
name (str): Name arg age (int): Age arg
method1(arg1, arg2)[source]¶

Does stuff with args.

Demo method1 - this method does stuff. Interesting right?

Args:
arg1 (type): The first arg needed to do stuff. arg2 (type): The second arg needed to do stuff.
Returns:
str - stuff string
  • Overview
    • Options
    • IPython Notebook Integration
    • Raw NBConvert Cells
  • Installation Guide
  • Examples
  • API
    • klink Package
  • Github

Quick search

Enter search terms or a module, class or function name.

klink was created by Philippe Morissette. If you find a bug, please submit an issue on Github.