Fix readthedocs deployment (#52)

* Add .readthedocs.yaml
* Add badges for docs and build-CI

Author: dougiesquire

.readthedocs.yaml

@@ -0,0 +1,19 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+  jobs:
+    pre_build:
+      - doxygen
+
+sphinx:
+  configuration: doc/conf.py
+
+python:
+  install:
+    - requirements: doc/requirements.txt

README.md

@@ -1,6 +1,9 @@
 # mppnccombine-fast
 [![DOI](https://zenodo.org/badge/131938571.svg)](https://zenodo.org/badge/latestdoi/131938571)
 
+[![Build](https://github.com/ACCESS-NRI/mppnccombine-fast/actions/workflows/ci.yml/badge.svg)](https://github.com/ACCESS-NRI/mppnccombine-fast/actions/workflows/ci.yml)
+[![Docs](https://app.readthedocs.org/projects/mppnccombine-fast/badge/)](https://mppnccombine-fast.readthedocs.io/en/latest/)
+
 An accelerated version of the `mppnccombine` post-processing tool for MOM
 
 Uses HDF5's raw IO functions to speed up collating large datasets - a 0.1

doc/conf.py

@@ -69,7 +69,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -87,7 +87,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-# html_theme = 'alabaster'
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

doc/requirements.txt

@@ -1 +1,2 @@
 breathe
+sphinx_rtd_theme