meta

meta copied to clipboard

We should consider creating a cookie-cutter template package for a minimal book building project setup, using the ExecutableBookProject infrastructure. It might replicate some of the functionality of sphinx-quickstart a bit, but I think it's a better approach.

See here, for a good example of what one of these repositories looks like: https://github.com/audreyr/cookiecutter-pypackage

I am flip-floppy on this. On the one hand, I agree that cookiecutter can be really useful for quickly generating these kinds of things. On the other hand, I hope that the final build system will be simple enough that we don't need a template generation step.

E.g. in https://github.com/ExecutableBookProject/cli the only structure that person's repository needs is:

• A folder w/ ipynb/markdown files for content
• A _toc.yml file with links relative to that content (this could be generated for users)
• A _config.yml file with YAML configuration values (this could be generated too)

The last two items could use a cookiecutter, but I wonder if it'd be easier to just have a little function that writes those files directly, given that it's just 2 YAML files

I think a custom quickstart in the cli is a nice tool to have -- but I don't see a rush on this. In our experience of having one in jupinx the config kept changing so we had to update it regularly.

We do have the following sphinx example repos available for the time being:

1. myst-parser.example-project
2. myst-nb.example-project