Auto-compiled documentation with Doxygen and github actions

.github/workflows/gh-pages.yml

@@ -0,0 +1,28 @@
+name: github pages
+
+on:
+  push:
+    branches:
+      - doxygen-action  # Set a branch name to trigger deployment
+
+jobs:
+  deploy:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0    # Fetch all history for .GitInfo and .Lastmod
+
+      - name: Build
+        uses: mattnotmitt/doxygen-action@v1
+        with:
+          doxyfile-path: './doc/Doxyfile'
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # Default Doxyfile build documentation to html directory. 
+          # Change the directory if changes in Doxyfile
+          publish_dir: ./html

doc/.gitignore

@@ -0,0 +1,2 @@
+html/
+doxygen_*.tmp

doc/MONC.md

@@ -0,0 +1,10 @@
+Main Page {#mainpage}
+=========
+
+This will eventually be some introductory documentation to MONC.
+
+For now use the [entry point into MONC](@ref monc_driver) to explore the code
+structure of MONC, browse the modules or use search above.
+
+This documentation was compiled from `master` on the Leeds fork of MONC:
+https://github.com/Leeds-MONC/monc

doc/Makefile

@@ -0,0 +1,4 @@
+all:
+	doxygen Doxyfile
+	echo 'Open a browser to http://localhost:8000/html'
+	python -m SimpleHTTPServer

io/src/configurationparser.F90

@@ -120,6 +120,7 @@ module configuration_parser_mod
      character, dimension(:), allocatable :: text_configuration
   end type io_configuration_type
 
+  #ifndef DOXYGEN_SHOULD_SKIP_THIS
   abstract interface
      subroutine handle_recv_data_from_io_server(io_configuration, data_buffer, inter_io_index)
        import io_configuration_type
@@ -128,6 +129,7 @@ subroutine handle_recv_data_from_io_server(io_configuration, data_buffer, inter_
        integer, intent(in) :: inter_io_index
      end subroutine handle_recv_data_from_io_server
   end interface
+  #endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
   !< For reading the IO XML configuration, these are string length constants which can be increased if required
   integer, parameter :: FILE_STR_STRIDE=10000, FILE_LINE_LEN=2000

io/src/writers/writer_types.F90

@@ -16,6 +16,7 @@ module writer_types_mod
   private
 #endif
 
+  #ifndef DOXYGEN_SHOULD_SKIP_THIS
   abstract interface
      !> Time manipulation interface which is implemented by the instantaneous and time averaged manipulations
      type(data_values_type) function perform_time_manipulation(instant_values, output_frequency, field_name, timestep, time)
@@ -32,6 +33,7 @@ logical function is_field_ready_to_write(latest_time, output_frequency, write_ti
        integer, intent(in) :: latest_timestep, write_timestep
      end function is_field_ready_to_write     
   end interface
+  #endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
   !< Pending writes which will be dealt with sequentially
   type pending_write_type