[ANN] nbconflux: Publish notebooks as Atlassian Confluence pages

764 views
Skip to first unread message

Peter Parente

unread,
Feb 26, 2018, 11:34:21 AM2/26/18
to Project Jupyter
Hi all,

I wanted to make you aware of a utility we recently open sourced called nbconflux, a tool for publishing Jupyter Notebooks as Atlassian Confluence pages based on nbconvert.


nbconflux is useful when:

* You use Jupyter notebooks to author computational narratives
* Your organization uses Confluence to store institutional knowledge
* You want an easy way to publish your work in that knowledge base

It's compatible with Confluence Cloud and Confluence Server, and does the following:

* Converts most cell inputs and outputs to valid Confluence storage format
* Attaches image outputs (e.g., matplotlib PNGs) to a page, shows them inline, and maintains the page-image association in the version history
* Attaches the source notebook to a page, links to it from the page footer, and maintains the page-notebook association in the version history
* Supports sweep-select Confluence comments over most input and output content
* Excludes input, output, or entire cells based on notebook cell tags noinput, nooutput, or nocell
* Labels pages with nbconflux to identify content that originated as notebooks
* Inserts a table of contents macro at the top of the page based on notebook headings
* Applies the NBViewer stylesheet to pages to blend Confluence styling with Jupyter notebook styling (requires the CSS macro)
* Enables MathJax rendering (requires the HTML macro)
* Supports raw-cell passthrough of Confluence storage format markup (e.g., to include Confluence macros)

Cheers,
Pete

Brian Granger

unread,
Feb 26, 2018, 12:14:03 PM2/26/18
to Project Jupyter
Pete,

Thanks for sharing! I have never used Confluence, but this look like
it would be useful.

Cheers,

Brian
> --
> You received this message because you are subscribed to the Google Groups
> "Project Jupyter" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to jupyter+u...@googlegroups.com.
> To post to this group, send email to jup...@googlegroups.com.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/jupyter/f4ce0962-f95c-4d4a-8321-758874cf60ba%40googlegroups.com.
> For more options, visit https://groups.google.com/d/optout.



--
Brian E. Granger
Associate Professor of Physics and Data Science
Cal Poly State University, San Luis Obispo
@ellisonbg on Twitter and GitHub
bgra...@calpoly.edu and elli...@gmail.com
Reply all
Reply to author
Forward
0 new messages