Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[codespell]
skip = .git,*.pdf,*.svg,deprecated,*.xml,*.mediawiki,*.omn
ignore-words-list = covert,hed,recuse,disjointness
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ jobs:
runs-on: ${{ matrix.platform }}

steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v5
with:
submodules: true

Expand Down
6 changes: 4 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,15 +48,17 @@ jobs:
git config user.email [email protected]

- 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
Expand Down
1 change: 0 additions & 1 deletion build_docs.py

This file was deleted.

116 changes: 0 additions & 116 deletions docs/api/errors.md

This file was deleted.

86 changes: 86 additions & 0 deletions docs/api/errors.rst
Original file line number Diff line number Diff line change
@@ -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:
62 changes: 0 additions & 62 deletions docs/api/index.md

This file was deleted.

24 changes: 24 additions & 0 deletions docs/api/index.rst
Original file line number Diff line number Diff line change
@@ -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
Loading
Loading