make_docs cronjob

docs/cron

@@ -1 +1 @@
-0 0 * * * ~/software/python/miniconda3/envs/lair-dev/bin/python ~/.lair-docs/docs/make_docs.py --version dev latest
+0 0 * * * ~/.lair-docs/docs/make_docs.sh >> ~/.lair-docs/docs/cron.log 2>&1

docs/make_docs.sh

@@ -0,0 +1,10 @@
+#!/bin/bash -l
+
+# Load git
+module load git
+
+# Load lair dev environment
+conda activate lair-dev
+
+# Run the make_docs.py script
+python ~/.lair-docs/docs/make_docs.py

docs/source/uataq/quickstart.rst

@@ -28,6 +28,7 @@ The configuration file is a JSON file which specifies UATAQ site characteristics
 including name, location, status, research groups collecting data, and installed instruments.
 
 The :class:`~lair.uataq._laboratory.Laboratory` object contains the following attributes:
+
  - sites : A list of site identifiers.
  - instruments : A list of instrument names.
 
@@ -51,6 +52,7 @@ The :class:`~instruments.InstrumentEnsemble` is a container object that hold dif
     For convenience, :meth:`uataq.laboratory.get_site` is aliased as :meth:`uataq.get_site`
 
 The :class:`~sites.Site` object contains the following information as attributes:
+
  - SID : The site identifier.
  - config : A dictionary containing configuration information for the site from the config file.
  - instruments : An instance of the InstrumentEnsemble class representing the instruments at the site.

env-dev.yml

@@ -15,7 +15,9 @@ dependencies:
   - matplotlib
   - metpy
   - molmass
+  - myst-parser
   - numpy
+  - numpydoc
   - pandas
   - pint-xarray
   - pyproj
@@ -26,6 +28,7 @@ dependencies:
   - shapely
   - siphon
   - sphinx
+  - sphinx-design
   - synopticpy
   - typing-extensions
   - xarray

lair/uataq/instruments.py

@@ -279,7 +279,7 @@ class InstrumentEnsemble:
     """
     Container for an ensemble of instruments at a site.
 
-    Attributes:
+    Attributes
     ----------
     SID : str
         Site ID of the ensemble.