nbdev’s doc builder creates doc sections
- out of every function or class
- from every call to show_doc
However, when I work in or edit the notebook, only the show_doc entries have a markdown field and are therefore appearing in Jupyterlab’s TOC. It would be really helpful if all the other def/class cells appear as well to quickly maneuver across the notebook.
Does anybody have a solution for this?
Add a Markdown cell and write the following code.
This will show:
- Jupyter Notebook : #hide, header2
- Jupyter lab toc : header2
- nbdev generated document : nothing
So you can use “jupyter lab toc header” to fly around your notebook without displaying anything in the document.
While this solution works, it’s quite inelegantly looking with all those “hide” entries in the notebook:
Is there really no other way I’m missing?
Yes you can do this by following headings with a single dash for example
My Heading -
Will put My Heading on the TOC but it will be hidden when the docs render
Thanks! NOW I see it in the docs under “Removing fake headers”. I just didn’t know what was meant with fake headers, so I glanced over it too fast, maybe if there’d be an example of a doc cell with a fake header, someone also not knowing what to look for could find it better? I can put in a PR…