Run fstardoc (with some modifications) over standard library#14
Open
mgritter wants to merge 3 commits into
Open
Run fstardoc (with some modifications) over standard library#14mgritter wants to merge 3 commits into
mgritter wants to merge 3 commits into
Conversation
Author
|
I broke the CSS for syntax highlighting... will fix. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR refreshes the standard library documentation using fstardoc.
Instead of using pandoc (and writing a syntax highlighting grammar in the format it understands) my revised script uses the GitHub service to render markdown -> html, so we get the syntax highlighting that GitHub performs.
The script used to generate this is a work in progress at
https://github.com/mgritter/FStar/blob/mgritter/script_html_conversion/.scripts/fstardoc/generate-ulib.py
Additions:
openormodule X = Yorinclude, the document translates those dependencies into a bulleted list with hyperlinks.FStarnotfstarDiffs to fstardoc can be seen here: FStarLang/FStar@master...mgritter:mgritter/script_html_conversion