-
Notifications
You must be signed in to change notification settings - Fork 561
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
Initial docs updates #31
Conversation
|
||
pyfile = !jupyter nbconvert --to python 'Index.ipynb' --stdout | ||
for l in pyfile[20:40]: | ||
print l |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Things like this will really want the output in the converted result as well as the code, I guess. Might need a custom template!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
:-P Yes, definitely. Probably whatever build system we have for the notebook docs will need to run the notebooks first, so that the output gets included when converting to rst.
I think this looks like a good start. We can steal the machinery to document config options from e.g. jupyter_console, where I've just set it up, but that can be in a later PR. |
Ok, updated this to make the documentation be more up-to-date with the current version of nbconvert. I think it can still use more fleshing out and organizing a bit, but that can come later. I'll work next on getting the API docs working and building this on RTD. |
Awesome, merging. |
programatically to generate blog post. Have a look a `Pythonic | ||
Preambulations <http://jakevdp.github.io/>`__ for Jake's blog post. | ||
|
||
@damianavila wrote the Nicholas Plugin to `write blog post as |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nikola
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whoops, sorry Damien! I'll fix it in the next PR...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No problem... I just see it and I did not want to forget about the typo...
Thanks! |
This is just an initial PR to start updating the documentation. This:
jupyter nbconvert --to rst
)index.rst
into a few separate files and then makesindex.rst
mostly just be a TOCThings that are not addressed here:
I figured I would make an initial PR to make sure I am heading in the right direction with this, and then address the second two things in separate PRs.
One question I had about this -- there is the
ipython/nbconvert-examples
repository. Do we want to move the examples in there to the nbconvert docs in this repository?