Documentation updates and starting to update CI some (kotekan#1109)

This PR is meant to accomplish a few goals, especially developing CI/infrastructure. Specific changes include:
1) A new 22.04 build has been introduced which includes nvidia tools (@dstndstn), julia (@eschnett), and more. Kotekan appears to build and run on python 3.10 / ubuntu 22.04, although some tests are failing (see below).
2) Documentation builds correctly on 22.04 with doxygen 1.9.7+, and has been updated so it builds on readthedocs.
3) The 18.04 Docker image was no longer building; this has been corrected and it now builds again.
4) The github actions workflows should be able to run locally, especially using act.

The PR is incomplete in that the following issues now exist:
1) Boost tests are not found by pytest on the 22.04 build. This should be investigated.
2) chime-experiment/comet (a dependency for some tests) relies on deprecated functionality, so does not work on 22.04. Some tests are skipped on 22.04 as a result.
3) Some package versions have been fixed for compatibility (esp. blaze) or due to bugs (esp. doxygen). Others have been fixed, but may be ok to relax.

.gitignore

@@ -11,3 +11,9 @@
 /.vscode/
 /nbproject/
 /cmake-build*/
+build-docs/*
+build-check-format/*
+build-1804/*
+build-2204/*
+docs/sphinx/html/*
+.ccache/*

README.md

@@ -1,15 +1,18 @@
-![](https://github.com/kotekan/kotekan/workflows/include-what-you-use/badge.svg?branch=develop)
 
 # Documentation
 
-Compiled docs are currently available at http://lwlab.dunlap.utoronto.ca/kotekan.
-One day we'll move them to readthedocs...
+Compiled docs are available at https://kotekan.readthedocs.io/en/latest/.
+
+[![Documentation Status](https://readthedocs.org/projects/kotekan/badge/?version=latest)](https://kotekan.readthedocs.io/en/latest/?badge=latest)
+
 
 # Build Instructions
 
+[![kotekan-ci-tests](https://github.com/kotekan/kotekan/actions/workflows/main.yml/badge.svg)](https://github.com/kotekan/kotekan/actions/workflows/main.yml)
+
 Detailed instructions at http://lwlab.dunlap.utoronto.ca/kotekan/compiling/general.html.
 
-The project is build using cmake, so you will need to install cmake
+This project is built using cmake, so you will need to install cmake
 before starting a build.
 
 To build just the base framework:

build/.gitignore

@@ -1,3 +1,3 @@
-*
-
-!.gitignore
+*
+
+!.gitignore

docs/.readthedocs.yaml

@@ -0,0 +1,22 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+conda:
+  environment: docs/rtd-environment.yml
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "miniconda3-4.7"
+  jobs:
+     pre_create_environment:
+       - conda update --yes --quiet --name=base --channel=defaults conda
+
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/sphinx/conf.py

docs/rtd-environment.yml

@@ -0,0 +1,15 @@
+name: readthedocs
+
+channels:
+  - conda-forge
+  - default
+
+dependencies:
+  - python=3.11
+  - pip
+  - cmake
+  - doxygen
+  - sphinx=5.0.2
+  - sphinx_rtd_theme=1.2.2
+  - breathe=4.35.0
+  - sphinxcontrib-plantuml=0.25

docs/sphinx/CMakeLists.txt

@@ -33,14 +33,13 @@ else()
     set(PLANTUML_DIR ${PLANTUML_PATH})
 endif()
 
-configure_file("${CMAKE_CURRENT_SOURCE_DIR}/conf.py.in" "${BINARY_BUILD_DIR}/conf.py" @ONLY)
+configure_file("${CMAKE_CURRENT_SOURCE_DIR}/conf.py" "${BINARY_BUILD_DIR}/conf.py" @ONLY)
 
 file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/_static")
 
 add_custom_target(
     sphinx ALL
     ${SPHINX_EXECUTABLE}
-    -W
     -q
     -b
     html