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

Creating a dafny doc tool #3849

Merged
merged 123 commits into from
May 31, 2023
Merged

Creating a dafny doc tool #3849

merged 123 commits into from
May 31, 2023

Conversation

davidcok
Copy link
Collaborator

@davidcok davidcok commented Apr 6, 2023

dafny doc <files-and-folders>

processes all the .dfy files on the commandline or in the folders (recursively) on the command line,
creating html 'dafny-doc' pages summarizing and describing the contents of the files, using the docstrings on the declarations.

Only operates if all files pass parsing and resolution (and all command-line options relevant to those phases apply here also)

--output:<folder> -- the folder in which the output will be placed (a flat collection of .html files). Default is './docs'. Folder is created if needed; contents are overwritten, but not deleted.

By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.

@davidcok davidcok marked this pull request as draft April 6, 2023 15:12
@davidcok davidcok added the run-deep-tests Tells CI to run all tests label Apr 6, 2023
@davidcok davidcok enabled auto-merge (squash) May 30, 2023 19:21
Copy link
Member

@MikaelMayer MikaelMayer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved !

@davidcok davidcok merged commit b90b422 into dafny-lang:master May 31, 2023
33 of 34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
run-deep-tests Tells CI to run all tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants