Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Investigate using podoc in nbconvert #283

Open
willingc opened this issue Apr 6, 2016 · 9 comments
Open

Investigate using podoc in nbconvert #283

willingc opened this issue Apr 6, 2016 · 9 comments

Comments

@willingc
Copy link
Member

willingc commented Apr 6, 2016

As a follow on to the notebook to markdown discussion on nbsphinx repo, it would be good to try using podoc for conversion of notebooks as well. @rossant has done a bunch of work the past couple of weeks and the project is really taking shape.

cc/ @fperez @bnaul @takluyver @mgeier

@ellisonbg
Copy link
Contributor

I am excited to see where podoc goes - definitely has the potential to
really help in our conversion machinery.

On Tue, Apr 5, 2016 at 6:30 PM, Carol Willing [email protected]
wrote:

As a follow on to the notebook to markdown discussion on nbsphinx repo, it
would be good to try using podoc https://github.com/podoc/podoc for
conversion of notebooks as well. @rossant https://github.com/rossant
has done a bunch of work the past couple of weeks and the project is really
taking shape.

cc/ @fperez https://github.com/fperez @bnaul https://github.com/bnaul
@takluyver https://github.com/takluyver @mgeier
https://github.com/mgeier


You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub
#283

Brian E. Granger
Associate Professor of Physics and Data Science
Cal Poly State University, San Luis Obispo
@ellisonbg on Twitter and GitHub
[email protected] and [email protected]

@rossant
Copy link

rossant commented Apr 6, 2016

I would be glad if podoc could help in nbconvert. Also I would really like to see podoc as the basis of a "Jupyter-aware RMarkdown for Python". I think the community would really benefit from something like this.

As @willingc said, podoc is taking shape. It can already convert notebook <-> markdown <-> pandoc, enabling conversions with all formats supported by pandoc. podoc now works in real time in the Jupyter Notebook, as a custom ContentsManager. I'm currently trying the library on increasingly complex notebooks and Markdown documents in order to fix various edge cases. In a few weeks hopefully, podoc should be stable enough to be used in production.

In any case I would love to collaborate with the Jupyter team on the long run, and I'm really open to discussion on all aspects of the library. I will open soon a few specific issues that I would like to discuss.

@ellisonbg
Copy link
Contributor

Right now the design of the Notebook-HTML conversion is decent - in that
case, jinja based templates make a good amount of sense. - I know lots of
folks who are customizing HTML output by writing custom jinja templates.
But for other output formats, such as rst, pdf, latex, etc. the
architecture of nbconvert isn't ideal.

On Wed, Apr 6, 2016 at 3:15 AM, Cyrille Rossant [email protected]
wrote:

I would be glad if podoc could help in nbconvert. Also I would really like
to see podoc as the basis of a "Jupyter-aware RMarkdown for Python". I
think the community would really benefit from something like this.

As @willingc https://github.com/willingc said, podoc is taking shape.
It can already convert notebook <-> markdown <-> pandoc, enabling
conversions with all formats supported by pandoc. podoc now works in real
time in the Jupyter Notebook, as a custom ContentsManager. I'm currently
trying the library on increasingly complex notebooks and Markdown documents
in order to fix various edge cases. In a few weeks hopefully, podoc should
be stable enough to be used in production.

In any case I would love to collaborate with the Jupyter team on the long
run, and I'm really open to discussion on all aspects of the library. I
will open soon a few specific issues that I would like to discuss.


You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#283 (comment)

Brian E. Granger
Associate Professor of Physics and Data Science
Cal Poly State University, San Luis Obispo
@ellisonbg on Twitter and GitHub
[email protected] and [email protected]

@mpacer
Copy link
Member

mpacer commented Sep 13, 2016

Any update on this?

@willingc
Copy link
Member Author

@michaelpacer I believe that @rossant put some of his development on pause for a bit. His books are still some of my favorites so when dev restarts we will want to stay in the loop by following the repo. ☀️

@willingc
Copy link
Member Author

And @rossant, if you haven't yet worked with @michaelpacer, he's working with us on Jupyter at Berkeley as a post-doc. Super helpful and interested in converting docs.

@rossant
Copy link

rossant commented Sep 13, 2016

I've been swamped with personal matters lately but I'll come back to this in the coming weeks

@minrk minrk added this to the 6.0 milestone Sep 13, 2016
@mgeier
Copy link
Contributor

mgeier commented Sep 15, 2016

If I'm not mistaken, podoc uses CommonMark-py, which would be a nice step towards using CommonMark in the Jupyter world, see jupyter/notebook#1371.

But what about the CommonMark extensions that Jupyter is using, namely tables (see readthedocs/commonmark.py#28) and math (see readthedocs/commonmark.py#49)?

@mgeier
Copy link
Contributor

mgeier commented Sep 15, 2016

OK, I saw that @rossant has included a pre-processing step to "decorate" math. So what about tables?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants