You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I'm imagining a fairly simple two step process - collection and output.
During the first step we simply take a list of RST docs to pull commands from - commands are just lines of RST in "code" blocks that start with "$" (extending the line if it ends with \).
During the second step we could generate bash scripts for testing and a Jupyter notebook displaying the output. If we placed the bash scripts in the repo - we could execute them from planemo-machine to test the documentation and if we placed the Jupyter notebook in repo we could use nbviewer and have awesome extra interactive docs for exploring Planemo.
To generate the bash script we would set the same header used now at the top of the file, list the preconditions for that doc, and then list the commands. We'd have to annotate commands that we expect to fail in the RST so we could appent || true or something to them.
To generate the notebook - I'm imaging using notedown with the same preconditions and commands - I'd just wrap each command with a Markdown codeblock and prepend ! to commands.
https://github.com/galaxyproject/planemo/pull/699/files added some ad-hoc tests generated from documentation manually but I think this process should be made automatic.
I'm imagining a fairly simple two step process - collection and output.
\
).|| true
or something to them.The text was updated successfully, but these errors were encountered: