I just discovered a bug (from a user's perspective) that is technically a feature in rST :-P
I just noticed that the top-level markdown header of each cell in the notebook is being treated as an H1 header for the whole document, even if the header text is technically ##.
e.g. see how Sphinx thinks there are multiple page titles for the single notebook document that is here: https://sphinx-jupyter-notebook.readthedocs.io/en/latest/
I think this is because of Sphinx deciding on page titles etc based on the order in which headers happen, so if we parse a cell with only a single ## header, Sphinx will treat that as a document-level header.
e.g., note how the Sphinx document output is the same whether the two headers have different numbers of # symbols.
So from a docutils perspective, we need to make sure that cells that are sub-sections are nested properly. Even though notebooks have a single top-level hierarchy, docutils doesn't.
@chrisjsewell does that sound correct to you? Any ideas on the right way to do this?
I just discovered a bug (from a user's perspective) that is technically a feature in rST :-P
I just noticed that the top-level markdown header of each cell in the notebook is being treated as an H1 header for the whole document, even if the header text is technically
##.e.g. see how Sphinx thinks there are multiple page titles for the single notebook document that is here: https://sphinx-jupyter-notebook.readthedocs.io/en/latest/
I think this is because of Sphinx deciding on page titles etc based on the order in which headers happen, so if we parse a cell with only a single
##header, Sphinx will treat that as a document-level header.e.g., note how the Sphinx document output is the same whether the two headers have different numbers of
#symbols.So from a docutils perspective, we need to make sure that cells that are sub-sections are nested properly. Even though notebooks have a single top-level hierarchy, docutils doesn't.
@chrisjsewell does that sound correct to you? Any ideas on the right way to do this?