search

executablebooks / sphinx-external-toc

A sphinx extension that allows the site-map to be defined in a single YAML file
https://sphinx-external-toc.readthedocs.io
MIT License
33 stars 18 forks source link

Should `jb-book` be defined in this package, or in Jupyter Book? #30

Closed choldgraf closed 3 years ago

choldgraf commented 3 years ago

This package defines an extension point where we can define new schemas for parsing TOC structures, and it comes with two non-defaults out of the box (jb-book and jb-article). E.g.:

https://github.com/executablebooks/sphinx-external-toc/blob/fdfac04fb54d0b6f295eec27aaf6399df7851a55/sphinx_external_toc/tools.py#L340

I am wondering if instead we should define a way for authors to create their own extensions, and then jupyter-book (the package) would be where jb-book and jb-article are defined. This might make this extension less "jupyter-book specific".

I don't think this is a blocker for an initial release, but curious if others think this is a reasonable idea.

chrisjsewell commented 3 years ago

Maybe, but yeh not until the package is solidified. Also one of the points of this is kinda to move jupyter-book away from really implementing any new code; such that it's just an aggregation of sphinx extensions that people can use directly if they wish. Having to install jupyter-book (and thus all its dependencies) to access these formats might not then be ideal

choldgraf commented 3 years ago

closing this since we can revisit it in the future in case the need arises