Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
rewrite ipynb docs
Signed-off-by: Chris Warrick <kwpolska@gmail.com>
  • Loading branch information
Kwpolska committed Feb 2, 2015
1 parent bc93f18 commit 77014ce
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 44 deletions.
40 changes: 40 additions & 0 deletions nikola/plugins/compile/ipynb/README.rst
@@ -0,0 +1,40 @@
1. You should install the ``ipython`` theme using this command


.. code-block:: console
$ nikola install_theme ipython
(or ``ipython-xkcd``, if you want xkcd styling)

More info here about themes:
http://getnikola.com/handbook.html#getting-more-themes

If you want to use your own theme, copy the ``ipython.min.css`` and
``nikola_ipython.css`` files from ``ipython`` to your theme (and include them
in ``bundles`` if necessary)

2. Then, just add to ``conf.py``:


.. code-block:: python
POSTS = (
("posts/*.ipynb", "posts", "post.tmpl", True),
)
PAGES = (
("stories/*.ipynb", "stories", "story.tmpl", False),
)
and set ``THEME`` to ``'ipython'`` or ``'ipython-xkcd'``, depending on your
choice.

To create a new post or page, use:

.. code-block:: console
$ nikola new_post -f ipynb
$ nikola new_page -f ipynb
**NOTE**: the ``-1`` and ``-2`` options are ignored; two-file posts are always
created for ipynb posts.
44 changes: 0 additions & 44 deletions nikola/plugins/compile/ipynb/README.txt

This file was deleted.

0 comments on commit 77014ce

Please sign in to comment.