Generate HTML versions of specs - Githubissues

kbase / kb_sdk

Build and test new apps for the KBase platform

http://kbase.github.io/kb_sdk_docs

MIT License

27 stars 32 forks source link

Generate HTML versions of specs #162

Closed MrCreosote closed 8 years ago

MrCreosote commented 8 years ago

Adds an option to the kb-sdk compile command to generate html versions of the KIDL specs with:

styling via a CSS file; a default file similar to the typeviewer is provided
links from typenames to type definitions
links from deprecated types and functions to their replacements, if provided
links to imported modules
clearly marked deprecated types and functions
type and function indexes

Some example specs: http://dev03.berkeley.kbase.us/temp_html/UserAndJobState.html http://dev03.berkeley.kbase.us/temp_html/Workspace.html http://dev03.berkeley.kbase.us/temp_html/KBaseFile.html

Future work:

There's some weirdness in how whitespace is handled in comments. I think this is coming from the spec parser rather than the HTML generator.
Add some sort of warning system (probably via a logger) to warn the user about invalid deprecation links.