-
Notifications
You must be signed in to change notification settings - Fork 63
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
The SAW Documentation Revolution (Part 1) #2202
Open
ChrisEPhifer
wants to merge
71
commits into
master
Choose a base branch
from
2197-deploying-saws-written-materials
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+9,875
−10,083
Open
Changes from 1 commit
Commits
Show all changes
71 commits
Select commit
Hold shift + click to select a range
51c669e
doc/internal: Move internal docs to an appropriate directory.
ChrisEPhifer dc42594
manual/code: Remove unused files.
ChrisEPhifer 6b94ef9
manual: Correct erroneous internal links.
ChrisEPhifer a2af838
manual: Use a level-1 heading (slightly) more appropriately.
ChrisEPhifer 85e4f55
Update fenced code block language specifiers.
ChrisEPhifer ea27d89
rust-tutorial: Subtract 1 from all headings after the first.
ChrisEPhifer e050f28
Normalize the title of the first chapter of each part.
ChrisEPhifer 0df6156
tutorial: Remove PDF (+ generation) and split up tutorial.md.
ChrisEPhifer f5e4945
tutorial: Consistently use standard Markdown headings.
ChrisEPhifer 748ed1d
tutorial: Use consistent code block style.
ChrisEPhifer 49a85d9
tutorial: Repair broken code references.
ChrisEPhifer a362222
Move figures directory from tutorial to doc root.
ChrisEPhifer f9396ec
Rename tutorial -> llvm-java-tutorial.
ChrisEPhifer e98eea5
llvm-java-tutorial: Update code block style to use colon fences.
ChrisEPhifer 9a72549
rust-tutorial: Remove PDF generation and split up rust-tutorial.md.
ChrisEPhifer 6fd1d87
rust-tutorial: Correct minor errors in Markdown.
ChrisEPhifer ba8c180
rust-tutorial: Normalize code blocks.
ChrisEPhifer 81a6250
manual: Remove PDF (+ generation) and split up manual.md.
ChrisEPhifer d4d6411
manual: Correct minor errors in Markdown.
ChrisEPhifer a416bc9
manual: Further normalize Markdown.
ChrisEPhifer dba1454
Rename manual -> saw-user-manual.
ChrisEPhifer 92e1d9b
Rename llvm-java-tutorial -> llvm-java-verification-with-saw.
ChrisEPhifer c4444d1
Rename rust-tutorial -> rust-verification-with-saw.
ChrisEPhifer c3eed8f
Rename internal -> development.
ChrisEPhifer e815bc9
Use explicit targets and internal references.
ChrisEPhifer 66aaa4b
development: Split up extcore.md.
ChrisEPhifer cf1560f
limitations: Remove redundant table of contents.
ChrisEPhifer 226b5ca
releasing: Fix link to `CHANGES.md`.
ChrisEPhifer 8739b29
Preemptively add a useful reference label to the SAW user manual.
ChrisEPhifer c318c83
releasing: Clean whitespace, remove outdated saw.galois.com link.
ChrisEPhifer a235e05
Add indices for all SAW documentation.
ChrisEPhifer f808628
saw-lexer: Add a simple pygments lexer for SAWScript.
ChrisEPhifer 71a2d4a
Prepare doc/ for Sphinx.
ChrisEPhifer b7e0232
Add a Script that creates a Python virtual environment for SAW docs.
ChrisEPhifer 954ab67
Add helper script to build HTML/PDF documents with Sphinx.
ChrisEPhifer a15e5b7
Commit PDF renderings of the tutorials and manual.
ChrisEPhifer 4266590
Add a doc/ README.
ChrisEPhifer 76be262
Attempt to fix file-bundling in CI.
ChrisEPhifer e22e84b
Merge branch 'master' into 2197-deploying-saws-written-materials
ChrisEPhifer c484801
Fix integration tests that reference documentation code.
ChrisEPhifer 43770b7
doc/bibliography: Restore the bib file from the LLVM/Java tutorial.
ChrisEPhifer 4b34431
rust-verification-with-saw: Replace missing '`' in Cryptol type var.
ChrisEPhifer b1aa596
Corrections to spelling errors.
ChrisEPhifer 8e0179e
doc/README: Add clarifying reference to description of `make_docs`.
ChrisEPhifer 4971718
doc/README: Remove note about removing `saw-lexer`.
ChrisEPhifer 0eb36f3
doc/README: Add clarifying reference about PDF titles.
ChrisEPhifer 392ae5e
saw-lexer: Cleanup imports.
ChrisEPhifer 98386e9
saw-lexer: Remove special 'Name.Builtin' handling.
ChrisEPhifer 094cdc3
Remove CHANGES mirror from developer docs and restore link text.
ChrisEPhifer b455635
doc/development: Consolidate extcore documentation into extcore.md.
ChrisEPhifer 53a5dda
Hide SAW developer documentation.
ChrisEPhifer af6132d
Rename doc/development -> doc/developer.
ChrisEPhifer d3a27d1
doc/setup_env: Use requirements.txt in the script's directory.
ChrisEPhifer d0ac195
Create a scripts directory.
ChrisEPhifer ba3f555
Remove make_docs.sh.
ChrisEPhifer cf63994
doc/Makefile: Remove / replace Sphinx's default comments.
ChrisEPhifer e4d1853
Add scripts/package_code.sh.
ChrisEPhifer b5f8ef1
Makefile: Re-implement the behaviors of the old make_docs.sh.
ChrisEPhifer 54c9c53
Generate PDFs in a (hopefully-reproducible) way.
ChrisEPhifer ff63fbe
doc/README: Update to reflect recent changes.
ChrisEPhifer d902766
Merge branch 'master' into 2197-deploying-saws-written-materials
ChrisEPhifer 0ea2d4e
Makefile: Use make's $(shell) function.
ChrisEPhifer fcb3ce5
sphinx-download-dir: Sphinx role to download directories.
ChrisEPhifer 7c614fa
scripts/requirements: Add sphinx-download-dir.
ChrisEPhifer bb99e83
.gitignore: Going forward, ignore all tar.gz archives in doc/.
ChrisEPhifer 0b9f94f
Use sphinx-download-dir in the documentation.
ChrisEPhifer 61af74a
Remove scripts/package_code.sh (and Makefile uses of the same).
ChrisEPhifer 34b9624
Update README to reflect sphinx-download-dir changes.
ChrisEPhifer f8c17f9
Add CHANGES.
ChrisEPhifer 2739adf
Merge branch 'master' into 2197-deploying-saws-written-materials
ChrisEPhifer 2f3970b
Merge branch 'master' into 2197-deploying-saws-written-materials
ChrisEPhifer File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not to kibitz further or anything 😸 but
abc
andz3
should probably get dropped too.(or add the other solvers, but the full list is pretty large... there's eight each with four variant calls, plus or minus, plus a few addenda)
I think what we should do in the long run is either have saw dump out info from the primitives table, or generate both this and the primitives table from an external definition file. But right now the primitives table doesn't have enough info to make this worthwhile.
(Also what I should probably do at some point is run pygments manually on a bunch of existing proof code and fiddle with the coloring until it looks nice. FUTURE...)