Skip to content

A testing ground to explore various jupyter-book project structures

Notifications You must be signed in to change notification settings

mmcky/ebp-test-projectstructure

Repository files navigation

ebp-test-projectstructure

A testing ground to explore jupyter-book project structures for toc and the matching of html and latex outputs.

A more detailed discussion document is found here

Configurations

The top level config relates to the primary entry points for constructing the _toc.yml file.

Configuration Set Description
files Using the files based _toc.yml structure
parts_chapters Using the parts based _toc.yml structure
experimental Alternative Configuration approaches

Within each configuration approach is a reference jupyterbook test pattern along with some other common patterns that uers may expect to work.

Files

Configuration Set Description
jupyterbook Reference jupyterbook structure
bookpattern A common book pattern

Relevant docs

Parts and Chapters

Configuration Set Description
jupyterbook Reference jupyterbook structure
bookpattern A common book pattern

Relevant docs

Experimental

Configuration Set Description
sphinx Using sphinx toctree setup

Notes:

The sphinx setup currently will trigger warnings that content is missing from the _toc.yml

WARNING: Found a content page that is not in _toc.yml: chapter1.md.
WARNING: Found a content page that is not in _toc.yml: chapter2.md.

About

A testing ground to explore various jupyter-book project structures

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published