search

SimonBiggs / scriptedforms

Quickly create live-update GUIs for Python packages using Markdown and simple HTML elements.
Apache License 2.0
508 stars 34 forks source link

Have a base set of live documentation #148

Open SimonBiggs opened 6 years ago

SimonBiggs commented 6 years ago

Work on creating live docs. These live docs will be able to be started by running scriptedforms without any parameters, also available by navigating to /scriptedforms/docs. Make the "docs" button in the top left of the form take you to the docs page on the server.

SimonBiggs commented 6 years ago

Live docs will have two columns as well as a table of contents menu bar. Column on the left will have editable scripted forms which are inside what look like notebook cells.

Column on the right will have the resulting scripted form. Each example will boot up its own kernel.

Have the docs always be accessible at /scriptedforms/docs. Opening up the docs for the first time will progressively start kernels -- work out how to optimise this for best user experience.

SimonBiggs commented 6 years ago

Have the live docs have a link to "Your forms" which is a glob of the forms in and below the current working directory.