This notebook contains material from nbpages by Jeffrey Kantor (jeff at nd.edu). The text is released under the CC-BY-NC-ND-4.0 license. The code is released under the MIT license.

< 1.0 Style Guide | Contents | Tag Index | 1.2 Notebook Style >

1.1 Notebook naming and ancillary/generated files¶

Motebooks in a repository reside in a single top-level directory named notebooks.

The filenames begin with a prefix indicating their position in book-like organization. The prefix patterns is nn.mm- where

A prefix starting with two digits denotes a chapter number. Chapter 00 is used for front matter.
A prefix starting with an alphabetic character denotes an appendix.
Following a separating '.', a second pair of digits indicates a section number within a chapter or appendix. Section 00 is reserved for the start of a new chapter.
A hyphen separates the prefix from the rest of the filename. The standard .ipynb Jupyter notebook suffix is required.

Any local data or figures used or created by the notebooks should be included within subdirectories located within the notebooks directory.

my-repository-title/
|
|-- notebooks/
|   |-- 00.00-Style-Guide.ipynb
|   |-- 01.00-Getting-Started.ipynb
|   |-- 01.01-First-Section-Title.ipynb
|   |-- 02.00-Second-Chapter-Title.ipynb
|   |-- A.00-First-Appendix.ipynb
|   |-- B.00-Another-Appendix.ipynb
|
|-- templates/
|   |-- nbpages.tpl
|   |-- index.md.tpl
|   |-- notebook_header.tpl
|
|-- nbpages.cfg
|
|-- docs/

< 1.0 Style Guide | Contents | Tag Index | 1.2 Notebook Style >