[IPython-dev] Jupyter/IPython for beginner
Matthias Bussonnier
bussonniermatthias at gmail.com
Sun Jun 14 16:16:33 EDT 2015
> Awesome, this is typically the kind of things we want in the **official** docs.
>
> Absolutely, I started that page only because I couldn't find a similar resorce in the official docs.
Yes we are bad at docs, and also at documenting the docs :-)
>
> Brian and john are working on something like this here:
>
> https://github.com/jupyter/jupyter <https://github.com/jupyter/jupyter>
>
> http://jupyter.readthedocs.org/en/latest/ <http://jupyter.readthedocs.org/en/latest/>
>
> I think combining the effort would be nice.
>
> Great. As a step 0, I would add a link to the readthedocs website in the README. I wasn't aware of this repo BTW.
That’s because the repo is 2 weeks old, and we are still figuring things out.
> I guess we want to discuss a little where and what to add regarding this "beginner quick-start" guide.
Sure, the discussion can take place on the repo itself.
We can have a section beginners guide I guess.
> What are the plan for the docs? They will be all sphinx-based in single stand-alone repository? There will be another repo for the main website?
I’ll try to recap a bit, I might be not perfectly correct and there might be technical limitation that can make this a bit different.
So jupyter/jupyter should be high level docs, Like first page of the docs, and mainly something that redirect you toward each project respective docs.
It should also get some high level how to use/examples, maybe a beginner docs.
It should get a section “how to get help”, “how are the docs structured”
And have link to sub documentation.
For technical reason, many sub-doc are not in this repo. Qtconsole docs is in jupyter/qtconsole, IPython only docs in IPython/IPython repo,
R kernel doc in IRkernel/IRkernel.
It’s ok to put a short description on link to each of these in jupyter/jupyter.
The Main Jupyter website (jupyter.org <http://jupyter.org/>) is on github://jupyter/jupyter.github.io <github://jupyter/jupyter.github.io> [1].
The Main IPython website (ipython.org <http://ipython.org/>) is on github://ipython/ipython-website <github://ipython/ipython-website>
The docs a re mostly sphinx based, we plan on integrating notebooks. \
> Bottom line, tell me how to contribute and I will adapt that pages. Also a section "how to contribute to the docs" would be usefull ;).
I would go on Jupyter/Jupyter create an issue there. Brian (and Jon which should be close to LA) are the ones working on that,
and are most likely to be aware of the last changes, and how they plan to organise things. They are most likely not reading IPython-dev ML,
so haven’t pitched in.
—
M
[1]: this should definitively be a valid url.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/ipython-dev/attachments/20150614/8277f6e6/attachment.html>
More information about the IPython-dev
mailing list