Skip to content
This repository has been archived by the owner on Nov 29, 2019. It is now read-only.

WIP: demo of how to use index.ipynb with current nbsite #62

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

ceball
Copy link
Member

@ceball ceball commented Jun 15, 2018

  1. Move toctree from doc/index.rst to a new file, doc/_index.rst
  2. Move doc/index.rst's content to examples/index.ipynb (and convert to markdown)
  3. Include index.ipynb and _index.rst in index.rst
  4. Commit doc/index.rst and doc/_index.rst and examples/index.ipynb.
  5. When you run nbsite_nbpagebuild.py ioam parambokeh ./examples ./doc with current nbsite, it will overwrite doc/index.rst. Restore it from git, then continue with the rest of the doc build.

@jbednar
Copy link
Member

jbednar commented Jun 15, 2018

Is the procedure the same when it's not at the root, e.g. tutorial/index.ipynb?

@ceball
Copy link
Member Author

ceball commented Jun 15, 2018

Yes, it's the same.

@jbednar
Copy link
Member

jbednar commented Jun 15, 2018

What's the reason for step 1, if you are including it in step 3? Why not just leave the toctree where it is, in index.rst? If it really needs to be in a separate file, presumably that file would be toctree.rst or _toctree.rst?

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

Successfully merging this pull request may close these issues.

2 participants