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

Initial docs updates #31

Merged
merged 7 commits into from
Jun 10, 2015
Merged

Initial docs updates #31

merged 7 commits into from
Jun 10, 2015

Conversation

jhamrick
Copy link
Member

@jhamrick jhamrick commented Jun 9, 2015

This is just an initial PR to start updating the documentation. This:

  1. Renames "ipython" to "jupyter"
  2. Moves the example notebooks into the docs folder and converts them to rst (though this is not currently automated in anyway -- I just ran jupyter nbconvert --to rst)
  3. Splits apart index.rst into a few separate files and then makes index.rst mostly just be a TOC

Things that are not addressed here:

  1. Fleshing out the documentation or making it up-to-date
  2. API docs

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?


pyfile = !jupyter nbconvert --to python 'Index.ipynb' --stdout
for l in pyfile[20:40]:
print l
Copy link
Member

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!

Copy link
Member Author

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.

@takluyver
Copy link
Member

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.

@takluyver takluyver mentioned this pull request Jun 9, 2015
Closed
5 tasks
@jhamrick
Copy link
Member Author

jhamrick commented Jun 9, 2015

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.

@takluyver
Copy link
Member

Awesome, merging.

takluyver added a commit that referenced this pull request Jun 10, 2015
@takluyver takluyver merged commit ceafd2e into jupyter:master Jun 10, 2015
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nikola

Copy link
Member Author

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...

Copy link
Member

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...

@jhamrick
Copy link
Member Author

Thanks!

@takluyver takluyver modified the milestone: 4.0 Jul 30, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants