Merge pull request #7149 from markrtuttle/publish-documentation

Publish documentation

Author: NlightNFotis

.github/workflows/publish.yaml

@@ -0,0 +1,25 @@
+name: Publish CBMC documentation
+on: [push, pull_request]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install doxygen
+        run: sudo apt install doxygen graphviz pandoc
+
+      - name: Install python modules
+        run: sudo python3 -m pip install gitpython pandocfilters
+
+      - name: Build documentation
+        run: cd doc/doxygen-root && make && touch html/.nojekyll
+
+      - name: Publish documentation
+        if: ${{ github.event_name == 'push' && startsWith('refs/heads/develop', github.ref) }}
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages
+          folder: doc/doxygen-root/html

doc/ADR/README.md

@@ -8,5 +8,5 @@ of the system and the surrounding infrastructure.
 
 ## Release & Packaging
 
-* [Release Process](release_process.md)
-* [Homebrew tap](homebrew_tap.md)
+* \subpage release-process
+* \subpage homebrew-tap-instructions

doc/ADR/homebrew_tap.md

@@ -1,4 +1,4 @@
-# Homebrew tap instructions
+\page homebrew-tap-instructions Homebrew tap instructions
 
 CBMC archives versions into a tap which you can use to quickly download and
 build various historical versions.

doc/ADR/release_process.md

@@ -1,4 +1,4 @@
-# Release Process
+\page release-process Release Process
 
 **Date**: 2020-10-08
 **Updated**: 2022-06-23
@@ -9,7 +9,7 @@
 
 The current process we follow through to make a new release is the following:
 
-1. At the point in time we want to make the release, we make a change to 
+1. At the point in time we want to make the release, we make a change to
    `src/config.inc`, and update the configuration variable `CBMC_VERSION`.
    This is important as it informs the various tools of the current version
    of CBMC.

doc/API/README.md

@@ -0,0 +1,3 @@
+# CPROVER APIs
+
+* \subpage piped-process

doc/API/util/piped_process.md

@@ -1,4 +1,4 @@
-# `src/util/piped_process.{cpp, h}`
+\page piped-process `src/util/piped_process.{cpp, h}`
 
 To utilise the `piped_process` API for interprocess communication with any binary:
 

doc/architectural/background-concepts.md

@@ -1,4 +1,5 @@
 \ingroup module_hidden 
+
 \page background-concepts Background Concepts
 
 \author Martin Brain, Peter Schrammel, Johannes Kloos

doc/architectural/cbmc-architecture.md

@@ -1,4 +1,5 @@
 \ingroup module_hidden
+
 \page cbmc-architecture CBMC Architecture
 
 \author Martin Brain, Peter Schrammel

doc/architectural/code-walkthrough.md

@@ -1,4 +1,5 @@
 \ingroup module_hidden 
+
 \page code-walkthrough Code Walkthrough
 
 \author Cesar Rodriguez, Owen Jones

doc/architectural/compilation-and-development.md

@@ -1,4 +1,5 @@
 \ingroup module_hidden 
+
 \page compilation-and-development Compilation and Development
 
 \author Martin Brain, Peter Schrammel, Owen Jones