Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for rendering Cryptol specs to HTML and possibly other formats #1718

Open
yav opened this issue Jul 31, 2024 · 0 comments
Open
Labels
feature request Asking for new or improved functionality

Comments

@yav
Copy link
Member

yav commented Jul 31, 2024

It might be nice to have a tool, similar to rustdoc, javadoc, haddock, or doxygen, for generating HTML (and possibly other formats) from Cryptol specifications. The basics of this should be fairly straightforward with all the infrastructure we have.
Some features we might want to support:

  • API view: show public functions with their types and documentation
  • Source view: view the definition of a function
  • Syntax highlighting: this can be useful for both the API and source view
  • Hyperlinked source: navigate between symbols by clicking on them
  • Indexing and searching
@yav yav added the feature request Asking for new or improved functionality label Jul 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request Asking for new or improved functionality
Projects
None yet
Development

No branches or pull requests

1 participant