Merge branch 'main' into fix/not_enforce_longitudinal

.gitignore

@@ -136,4 +136,5 @@ data/*
 .DS_Store
 notebooks/testdata
 .vscode/settings.json
-notebooks/test1
+notebooks/test1
+docs/generated

cubids/__about__.py

@@ -1,6 +1,25 @@
 # emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: nil -*-
 # vi: set ft=python sts=4 ts=4 sw=4 et:
-"""Base module variables."""
+"""Base module variables for CuBIDS.
+
+This module defines the base variables for the CuBIDS package, including version,
+package name, copyright, credits, and URLs.
+
+Attributes
+----------
+__version__ : str
+    The version of the CuBIDS package.
+__packagename__ : str
+    The name of the CuBIDS package.
+__copyright__ : str
+    The copyright information for the CuBIDS package.
+__credits__ : str
+    The credits for the CuBIDS package.
+__url__ : str
+    The URL for the CuBIDS package repository.
+DOWNLOAD_URL : str
+    The URL to download the CuBIDS package.
+"""
 try:
     from cubids._version import __version__
 except ImportError:

cubids/__init__.py

@@ -1,4 +1,37 @@
-"""Top-level package for CuBIDS."""
+"""Top-level package for CuBIDS.
+
+This module initializes the CuBIDS package and imports its main submodules and attributes.
+
+Submodules
+----------
+cli : module
+    Command-line interface for CuBIDS.
+config : module
+    Configuration utilities for CuBIDS.
+constants : module
+    Constants used throughout the CuBIDS package.
+cubids : module
+    Core functionalities of the CuBIDS package.
+metadata_merge : module
+    Utilities for merging metadata in CuBIDS.
+utils : module
+    Utility functions for CuBIDS.
+validator : module
+    Validation utilities for CuBIDS.
+workflows : module
+    Workflows for CuBIDS operations.
+
+Attributes
+----------
+__version__ : str
+    The version of the CuBIDS package.
+__packagename__ : str
+    The name of the CuBIDS package.
+__copyright__ : str
+    The copyright information for the CuBIDS package.
+__credits__ : str
+    The credits for the CuBIDS package.
+"""
 
 from cubids import (
     cli,