Thanks to visit codestin.com
Credit goes to github.com

Skip to content
This repository was archived by the owner on Jul 15, 2025. It is now read-only.
This repository was archived by the owner on Jul 15, 2025. It is now read-only.

Examples in documentation #47

@bdice

Description

@bdice

The documentation would be vastly more useful with some example code snippets. @klarh I'd appreciate your thoughts on this:

  • Do you want to include examples as a git submodule, as we've done for freud and fresnel (to keep the repo size reasonable)?
  • Should examples be based on https://github.com/glotzerlab/plato-gallery (should that repo be expanded to include more simple figures)?
  • What backends should we showcase for examples? Interactive vs. ray-traced?
  • Should the notebooks be pre-rendered (requires a dev machine or Docker image that works with all/most backends) or rendered on ReadTheDocs (potentially time-intensive, hard to configure dependencies)?

Related: I was able to embed pythreejs widgets into freud's documentation: https://freud.readthedocs.io/en/stable/examples/examples/Visualization%20with%20plato.html

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions