jupyter-book VS cookiecutter

Sphinx supports ReStructuredText and Markdown.

MyST-Markdown supports MathJaX and Sphinx roles and directives. https://myst-parser.readthedocs.io/en/latest/

jupyter-book supports ReStructuredText, Jupyter Notebooks, and MyST-Markdown documents:

You can build Sphinx and Jupyter-Book projects with the ReadTheDocs container, which already has LaTeX installed: https://github.com/executablebooks/jupyter-book/issues/991

myst-templates/plain_latex_book:

your task is very very broad

you mention you don't want to deal with AWS, if it's because of ad-hoc installation concerns and nothing else you can just run your notebooks in ready-made solutions like Google Colab, or Jupyter-book in Github ( https://github.com/executablebooks/jupyter-book ))

that would cover a lot of use cases right away without next to no learning curve

If you don't want to deal with AWS or similar, in that case:

- if it's a static notebook then you can obviously render it and serve the web content (might seem obvious but needs to be considered)

- if it's dynamic but has light hardware requirements, you can try jupyterlite which runs in the browser and should do a pyodine (webassembly CPython kernel) can do: https://jupyterlite.readthedocs.io/en/latest/try/lab/

- otherwise, you can try exposing a dockerised jupyter env ( as in https://github.com/MKAbuMattar/dockerized-jupyter-notebook/b... ) or even better a nixified one ( https://github.com/tweag/jupyenv )

there might be other approaches I'm missing, but I think that's pretty much it that doesn't entail some proprietary solution or an ad-hoc installation as you've been doing

Note: If you want to present a cleaner version of the notebook without assertions, you can use Jupyter book to render it into a site and use the remove-cell tag to omit assertions from the output.

See this thread for example.

And maybe take a look at executablebooks/jupyter-book.

Our team has transferred from Sphinx for documentation to JupyterBook. There have been some growing pains with it but I prefer the look of the output and being able to play with the examples on Colab or Binder at the click of a button is a great feature.

Sometimes I use this to abstract boilerplate https://github.com/cookiecutter/cookiecutter

It can use a repo as a template.

It supports some interactive questions to choose options but mostly it is jinja templates.

Having libraries would be another option.

Install the cookiecutter package using the following command:

Consider taking a look at cookiecutter to generate projects from templates. There is also cookiecutter-django. As for your environment variables you should have an example .env file containing all the environment variables required by your project (without setting them) that can be safely pushed into your repository for you and other developers to copy into the actual .env file that'll be used by your project (add this file to .gitignore)

The Python Cookiecutter library revolutionizes project development by offering streamlined approach to creating template projects and improving developer experience.

We use cookie cutter templates (the Python project, https://github.com/cookiecutter/cookiecutter ), we prompt for the module & version etc

Why not use cookiecutter or a similar tool designed for making these sorts of project templates?

Is it common? I don't know. Is it useful? Absolutely. There is a tool called cookiecutter that allows you to define your own setup. For example, my cookiecutter setup for a python library is here. You can see what it's like by first installing the cookiecutter cli and then running

Also cookiecutter.

Visual Cookiecutter enhances the functionality of cookiecutter by offering unique features such as required fields, conditional input parameters, optional descriptions, and the ability to fix mistakes easily. This package seamlessly integrates with cookiecutter so that all existing templates work out-of-the-box.