-
Notifications
You must be signed in to change notification settings - Fork 273
Publish documentation #7149
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
Merged
NlightNFotis
merged 14 commits into
diffblue:develop
from
markrtuttle:publish-documentation
Sep 26, 2022
Merged
Publish documentation #7149
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
9e6e35f
Correct doxygen \page commands in architectural documentation
dd1b0e0
Make cprover-manual format nicely with doxygen
d41591b
Make three README files format with doxygen/pandoc
b11af9b
Make satabs user manual a first-class page
6e49550
Add markdown preprocessing scripts for use before doxygen formatting
142bfac
Add doxyfiles for miscellaneous sets of markdown files
ecfd0de
Add top-level documtation pages
ec26ef5
Add cbmc documentation publication workflow
b498483
Remove a blank line from the top of a markdown file
5969edd
Remove "nondet volatile" and "function pointer" pages from user guide
947d3f3
Update doc/doxygen-root/doxyfile to version 1.8.17
7e9f21e
Correct and elaborate the documentation-build documentation
f44d11e
Fix typo in developer guide
ee0a06d
Convert doc/ADR and doc/API to doxygen page/subpage syntax
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 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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,34 @@ | ||
# The CPROVER Manual | ||
|
||
## 1. [Introduction](introduction/) | ||
1. [Introduction](introduction/) | ||
|
||
## 2. [Installation](installation/) | ||
2. [Installation](installation/) | ||
|
||
## 3. CBMC – Bounded Model Checking | ||
3. CBMC – Bounded Model Checking | ||
|
||
[A Short Tutorial](cbmc/tutorial/), | ||
[Loop Unwinding](cbmc/unwinding/), | ||
[Assertion Checking](cbmc/assertions/) | ||
* [A Short Tutorial](cbmc/tutorial/) | ||
* [Loop Unwinding](cbmc/unwinding/) | ||
* [Assertion Checking](cbmc/assertions/) | ||
|
||
## 4. [Compositional Reasoning using Code Contracts](contracts/) | ||
4. [Compositional Reasoning using Code Contracts](contracts/) | ||
|
||
## 5. [Goto-Analyzer – Abstract Interpretation](goto-analyzer/) | ||
5. [Goto-Analyzer – Abstract Interpretation](goto-analyzer/) | ||
|
||
## 6. [Test Suite Generation](test-suite/) | ||
6. [Test Suite Generation](test-suite/) | ||
|
||
## 7. [Program Properties](properties/) | ||
7. [Program Properties](properties/) | ||
|
||
## 8. Modeling | ||
8. Modeling | ||
|
||
[Nondeterminism](modeling/nondeterminism/), | ||
[Assumptions](modeling/assumptions/), | ||
[Pointers](modeling/pointers/), | ||
[Floating Point](modeling/floating-point/) | ||
[Generating Environments](goto-harness/) | ||
* [Nondeterminism](modeling/nondeterminism/) | ||
* [Assumptions](modeling/assumptions/) | ||
* [Pointers](modeling/pointers/) | ||
* [Floating Point](modeling/floating-point/) | ||
* [Generating Environments](goto-harness/) | ||
|
||
## 9. Build Systems | ||
9. Build Systems | ||
|
||
[Integration into Build Systems with goto-cc](goto-cc/), | ||
[Integration with Visual Studio builds](visual-studio/) | ||
* [Integration into Build Systems with goto-cc](goto-cc/) | ||
* [Integration with Visual Studio builds](visual-studio/) | ||
|
||
## 10. [The CPROVER API Reference](api/) | ||
10. [The CPROVER API Reference](api/) |
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
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.
@kroening Will this render ok on cprover.org?
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.
FWIW, I did mention this to @kroening (replacing the sequence of headers with a list) and he did not object.