Skip to content

Is there appetite for trying to revitalize the cookbook? #47

Open
@rossbar

Description

@rossbar

The scipy-cookbook has been a great resource in the past, but (as noted in the book itself) it is not really curated/had a high volume of attention paid to it. Is there any interest among maintainers to try to kick-start the cookbook and perhaps make it a more easy/visible place for users to contribute scipy tutorial content?

Specifically, I'd think of starting with updating the infrastructure - moving away from the custom build/cookbookrebuild.py workflow to a pure sphinx-based workflow using some of the excellent tools of the executablebooks project. I've had some experience working on similar projects for NumPy (numpy-tutorials) and NetworkX (nx-guides) and have found that the tools of the executablebooks project work very well and offer some great benefits like including (but not limited to):

  • The possibility for a fully sphinx-based workflow (doesn't require any custom building/rendering scripts - notebook execution and execution caching via sphinx extensions)
  • Support for jupyter notebooks out of the box (a major advantage here, since the content is already in notebooks)
  • Support for a markdown-based text format for Jupyter notebooks that makes diffing/reviewing notebooks much more straightforward

I realize that this is just the tip of the iceberg - the real challenge would be evaluating/updating the content of the cookbook - but I think modernizing the workflow might make subsequent steps/improvements easier.

I'd be happy to work on this, but I want to make sure that this is something that others/maintainers would be interested in!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions