-
Notifications
You must be signed in to change notification settings - Fork 69
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
Initial SAW Manual Reorganization #2224
Merged
Merged
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
bb7842c
Manual: Reorder top-level sections.
ChrisEPhifer cdffd66
Manual: Demote 'direct-extraction' to subsection of 'loading-code'.
ChrisEPhifer edf4740
Rename introduction.md -> overview.md.
ChrisEPhifer af3e999
saw-user-manual/overview: Add recommended new sections to outline.
ChrisEPhifer 4396e95
saw-user-manual/structure-of-sawscript: Add new section to outline.
ChrisEPhifer 998cbc9
saw-user-manual/structure-of-sawscript: Move first simple example.
ChrisEPhifer 6fa6b68
saw-user-manual/invoking-saw: Move content to appendix.
ChrisEPhifer e94f556
saw-user-manual/specification-based-verification: Revisit example.
ChrisEPhifer 5d8c532
saw-user-manual/appendices: Make separate directory for appendices.
ChrisEPhifer 8350a3a
appendices/glossary: Add an (empty) glossary to the appendices.
ChrisEPhifer d3e8558
saw-user-manual/appendices: Properly format REPL reference.
ChrisEPhifer 251e486
saw-user-manual/cryptol-and-its-role-in-saw: Fix broken link.
ChrisEPhifer 8e0c99b
saw-user-manual/appendices: Add stubs for additional appendices.
ChrisEPhifer c40828e
saw-user-manual: Place proofs about terms after term transformation.
ChrisEPhifer b539c46
saw-user-manual: Clean up some 'glue' text.
ChrisEPhifer 6e37a47
doc: Update PDFs.
ChrisEPhifer d460fce
Merge branch 'master' into 2156-saw-user-manual-reorg
ChrisEPhifer b4feed5
saw-user-manual/specification-based-verification: Missing reference.
ChrisEPhifer 2611825
manual/cryptol-and-its-role-in-saw: Note about Cryptol manual link.
ChrisEPhifer e83e61e
appendices: Replace REPL glossary entries with explicit references.
ChrisEPhifer 3b0b6e2
manual/transforming-term-values: Update section transition language.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Appendices | ||
|
|
||
| :::{toctree} | ||
| :maxdepth: 1 | ||
|
|
||
| repl-reference | ||
| ::: |
4 changes: 2 additions & 2 deletions
4
...aw-user-manual/appendix-repl-reference.md → ...-user-manual/appendices/repl-reference.md
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
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
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.
Is there a way to get appendices to come out as A. Glossary B. Command Reference C. REPL Reference, etc. instead of being sections 17.1-17.4 of a chapter 17?
(like what \appendix does in latex)
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.
I chewed on this one for a while, since Sphinx does have a
latex_appendicessetting.Unfortunately, without some gnarly convolution, I couldn't get this to behave the way I wanted -- while it would have the desired effect of labeling the appendices as you suggest (with page breaks between), the material ends up duplicated (since, to appear in the HTML render, those documents need to be somewhere in the document tree;
latex_appendicesnaturally only changes the LaTeX output).At least for now, I say we leave this alone - it seems
latex_appendiceswas designed to include external documents in LaTeX renderings, rather than documents that are already part of the system.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.
Annoying. Oh well.