Skip to content

Commit 5834261

Browse files
authored
Merge pull request #7149 from markrtuttle/publish-documentation
Publish documentation
2 parents 54bb53d + ee0a06d commit 5834261

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+13489
-55
lines changed

.github/workflows/publish.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Publish CBMC documentation
2+
on: [push, pull_request]
3+
4+
jobs:
5+
publish:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- name: Checkout repository
9+
uses: actions/checkout@v2
10+
11+
- name: Install doxygen
12+
run: sudo apt install doxygen graphviz pandoc
13+
14+
- name: Install python modules
15+
run: sudo python3 -m pip install gitpython pandocfilters
16+
17+
- name: Build documentation
18+
run: cd doc/doxygen-root && make && touch html/.nojekyll
19+
20+
- name: Publish documentation
21+
if: ${{ github.event_name == 'push' && startsWith('refs/heads/develop', github.ref) }}
22+
uses: JamesIves/[email protected]
23+
with:
24+
branch: gh-pages
25+
folder: doc/doxygen-root/html

doc/ADR/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ of the system and the surrounding infrastructure.
88

99
## Release & Packaging
1010

11-
* [Release Process](release_process.md)
12-
* [Homebrew tap](homebrew_tap.md)
11+
* \subpage release-process
12+
* \subpage homebrew-tap-instructions

doc/ADR/homebrew_tap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Homebrew tap instructions
1+
\page homebrew-tap-instructions Homebrew tap instructions
22

33
CBMC archives versions into a tap which you can use to quickly download and
44
build various historical versions.

doc/ADR/release_process.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Release Process
1+
\page release-process Release Process
22

33
**Date**: 2020-10-08
44
**Updated**: 2022-06-23
@@ -9,7 +9,7 @@
99

1010
The current process we follow through to make a new release is the following:
1111

12-
1. At the point in time we want to make the release, we make a change to
12+
1. At the point in time we want to make the release, we make a change to
1313
`src/config.inc`, and update the configuration variable `CBMC_VERSION`.
1414
This is important as it informs the various tools of the current version
1515
of CBMC.

doc/API/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# CPROVER APIs
2+
3+
* \subpage piped-process

doc/API/util/piped_process.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# `src/util/piped_process.{cpp, h}`
1+
\page piped-process `src/util/piped_process.{cpp, h}`
22

33
To utilise the `piped_process` API for interprocess communication with any binary:
44

doc/architectural/background-concepts.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
\ingroup module_hidden
2+
23
\page background-concepts Background Concepts
34

45
\author Martin Brain, Peter Schrammel, Johannes Kloos

doc/architectural/cbmc-architecture.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
\ingroup module_hidden
2+
23
\page cbmc-architecture CBMC Architecture
34

45
\author Martin Brain, Peter Schrammel

doc/architectural/code-walkthrough.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
\ingroup module_hidden
2+
23
\page code-walkthrough Code Walkthrough
34

45
\author Cesar Rodriguez, Owen Jones

doc/architectural/compilation-and-development.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
\ingroup module_hidden
2+
23
\page compilation-and-development Compilation and Development
34

45
\author Martin Brain, Peter Schrammel, Owen Jones

0 commit comments

Comments
 (0)