openPMD / openPMD/openPMD-api

Examples: Literal Include

Open
#1,822 0 comments 0 reactions 1 assignee Claimed by @ax3l View on GitHub
documentation tests
Dominant language
C++
Stars
161
Forks
59
Avg merge
2d 22h
Merged PRs (30d)
7

Description

As a follow-up to #1805 / #1821, we could use a collapsed drop-down and literal include in Sphinx to show the examples verbatim with syntax highlighting in the docs (e.g., ["Script Details" here](https://impactx.readthedocs.io/en/latest/install/hpc/perlmutter.html#preparation)).

Even better would be a small README file per example, [similar to here](https://impactx.readthedocs.io/en/latest/usage/examples/fodo/README.html).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.