Merge pull request #1110 from VisLab/action_update

Updated the docs style to sphinx and fuso

Author: VisLab

.codespellrc

@@ -0,0 +1,3 @@
+[codespell]
+skip = .git,*.pdf,*.svg,deprecated,*.xml,*.mediawiki,*.omn
+ignore-words-list = covert,hed,recuse,disjointness

.github/workflows/ci.yaml

@@ -38,7 +38,7 @@ jobs:
     runs-on: ${{ matrix.platform }}
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           submodules: true
 

.github/workflows/docs.yml

@@ -48,15 +48,17 @@ jobs:
         git config user.email github-actions@github.com
 
     - name: Build documentation
-      run: mkdocs build --strict
+      run: |
+        cd docs
+        sphinx-build -b html . _build/html
 
     - name: Setup Pages
       uses: actions/configure-pages@v5
 
     - name: Upload artifact
       uses: actions/upload-pages-artifact@v3
       with:
-        path: ./site
+        path: ./docs/_build/html
 
   #------------------------------------------------
   # Deploy Job: Deploys the built site

build_docs.py

@@ -0,0 +1,86 @@
+Errors
+======
+
+Error handling and reporting classes for HED validation and processing.
+
+Error Types and Constants
+-------------------------
+
+HedExceptions
+~~~~~~~~~~~~~
+
+.. autoclass:: hed.errors.exceptions.HedExceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+HedFileError
+~~~~~~~~~~~~
+
+.. autoclass:: hed.errors.exceptions.HedFileError
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Error Reporting
+---------------
+
+ErrorHandler
+~~~~~~~~~~~~
+
+.. autoclass:: hed.errors.error_reporter.ErrorHandler
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Error Functions
+~~~~~~~~~~~~~~~
+
+.. autofunction:: hed.errors.error_reporter.get_printable_issue_string
+
+.. autofunction:: hed.errors.error_reporter.sort_issues
+
+.. autofunction:: hed.errors.error_reporter.replace_tag_references
+
+Error Types
+-----------
+
+ValidationErrors
+~~~~~~~~~~~~~~~~
+
+.. autoclass:: hed.errors.error_types.ValidationErrors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+SchemaErrors
+~~~~~~~~~~~~
+
+.. autoclass:: hed.errors.error_types.SchemaErrors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+SidecarErrors
+~~~~~~~~~~~~~
+
+.. autoclass:: hed.errors.error_types.SidecarErrors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ErrorContext
+~~~~~~~~~~~~
+
+.. autoclass:: hed.errors.error_types.ErrorContext
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ErrorSeverity
+~~~~~~~~~~~~~
+
+.. autoclass:: hed.errors.error_types.ErrorSeverity
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/errors.md

@@ -0,0 +1,24 @@
+API Reference
+=============
+
+This section contains the complete API reference for HED Python Tools.
+
+.. toctree::
+   :maxdepth: 2
+
+   models
+   schema
+   validator
+   tools
+   errors
+
+Core Modules Overview
+---------------------
+
+The HED Python Tools package is organized into several key modules:
+
+* **Models**: Core data structures for HED annotations and tags
+* **Schema**: HED schema management and validation
+* **Validator**: Validation tools for HED data
+* **Tools**: Utility functions and data processing tools
+* **Errors**: Error handling and reporting classes