| Safe Haskell | None |
|---|---|
| Language | GHC2024 |
Drasil.Data.Formats.Jupyter
Synopsis
- data Cell
- data Notebook = Notebook NotebookMetadata [Cell]
- type Metadata = [(Text, JSON)]
- data NotebookMetadata = NotebookMetadata {}
- data KernelSpec = KernelSpec {}
- data LanguageInfo = LanguageInfo {}
- defaultPython39Metadata :: NotebookMetadata
- data CellSourceRenderStyle
- data NotebookRenderOptions = NotebookRenderOptions {}
- defaultNotebookRenderOptions :: NotebookRenderOptions
- notebookToJSON :: NotebookRenderOptions -> Notebook -> JSON
- renderNotebook :: NotebookRenderOptions -> JSONRenderOptions -> Notebook -> Doc ann
Documentation
A Markdown cell or an unexecuted code cell.
Constructors
| MarkdownCell | |
| CodeCell | |
A new notebook containing ordered cells and document metadata.
Constructors
| Notebook | |
Fields
| |
data NotebookMetadata Source #
Notebook kernel and language information.
Constructors
| NotebookMetadata | |
Fields | |
Instances
| Show NotebookMetadata Source # | |
Defined in Drasil.Data.Formats.Jupyter.Core Methods showsPrec :: Int -> NotebookMetadata -> ShowS # show :: NotebookMetadata -> String # showList :: [NotebookMetadata] -> ShowS # | |
| Eq NotebookMetadata Source # | |
Defined in Drasil.Data.Formats.Jupyter.Core Methods (==) :: NotebookMetadata -> NotebookMetadata -> Bool # (/=) :: NotebookMetadata -> NotebookMetadata -> Bool # | |
data KernelSpec Source #
The kernel used to execute a notebook.
Constructors
| KernelSpec | |
Fields
| |
Instances
| Show KernelSpec Source # | |
Defined in Drasil.Data.Formats.Jupyter.Core Methods showsPrec :: Int -> KernelSpec -> ShowS # show :: KernelSpec -> String # showList :: [KernelSpec] -> ShowS # | |
| Eq KernelSpec Source # | |
Defined in Drasil.Data.Formats.Jupyter.Core | |
data LanguageInfo Source #
Notebook language information.
Constructors
| LanguageInfo | |
Fields | |
Instances
| Show LanguageInfo Source # | |
Defined in Drasil.Data.Formats.Jupyter.Core Methods showsPrec :: Int -> LanguageInfo -> ShowS # show :: LanguageInfo -> String # showList :: [LanguageInfo] -> ShowS # | |
| Eq LanguageInfo Source # | |
Defined in Drasil.Data.Formats.Jupyter.Core | |
defaultPython39Metadata :: NotebookMetadata Source #
Python 3.9.1 metadata used by the current notebook generators.
data CellSourceRenderStyle Source #
JSON representation of cell source.
Constructors
| ListOfLines | One string per line, with a trailing LF. |
| SingleString | One string containing the whole cell. |
Instances
| Show CellSourceRenderStyle Source # | |
Defined in Drasil.Data.Formats.Jupyter.Render Methods showsPrec :: Int -> CellSourceRenderStyle -> ShowS # show :: CellSourceRenderStyle -> String # showList :: [CellSourceRenderStyle] -> ShowS # | |
| Eq CellSourceRenderStyle Source # | |
Defined in Drasil.Data.Formats.Jupyter.Render Methods (==) :: CellSourceRenderStyle -> CellSourceRenderStyle -> Bool # (/=) :: CellSourceRenderStyle -> CellSourceRenderStyle -> Bool # | |
data NotebookRenderOptions Source #
Notebook format options, separate from JSON layout options. Version numbers label the output; they do not convert the notebook structure.
Constructors
| NotebookRenderOptions | |
Fields | |
Instances
| Show NotebookRenderOptions Source # | |
Defined in Drasil.Data.Formats.Jupyter.Render Methods showsPrec :: Int -> NotebookRenderOptions -> ShowS # show :: NotebookRenderOptions -> String # showList :: [NotebookRenderOptions] -> ShowS # | |
| Eq NotebookRenderOptions Source # | |
Defined in Drasil.Data.Formats.Jupyter.Render Methods (==) :: NotebookRenderOptions -> NotebookRenderOptions -> Bool # (/=) :: NotebookRenderOptions -> NotebookRenderOptions -> Bool # | |
defaultNotebookRenderOptions :: NotebookRenderOptions Source #
Use notebook format 4.4 and a list of lines per cell by default.
notebookToJSON :: NotebookRenderOptions -> Notebook -> JSON Source #
Encode a new notebook using the selected version and source representation.
renderNotebook :: NotebookRenderOptions -> JSONRenderOptions -> Notebook -> Doc ann Source #
Render a notebook with the shared JSON renderer.