Skip to content

Commit 6f50e76

Browse files
committed
Updated the docs index
1 parent b7ddceb commit 6f50e76

9 files changed

Lines changed: 19 additions & 36 deletions

File tree

docs/_templates/base.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@
2929
};
3030
</script>
3131
<script src="https://osa-demo.pages.dev/osa-chat-widget.js"
32-
crossorigin="anonymous"
33-
defer
34-
onload="window.OSAChatWidget && window.OSAChatWidget.setConfig(window.osaChatConfig)"></script>
32+
crossorigin="anonymous"
33+
defer
34+
onload="window.OSAChatWidget && window.OSAChatWidget.setConfig(window.osaChatConfig)">
35+
</script>
3536
{%- endblock scripts %}
3637

docs/api/errors.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Python HEDTools error handling
1+
Error handling
22
==============================
33

44
Error handling and reporting classes for HED validation and processing.

docs/api/index.rst

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@ Python HEDTools API
22
===================
33

44
This section contains the complete API reference for Python HEDTools.
5+
The Python HEDTools package is organized into several key modules:
6+
7+
* **Models**: Core data structures for HED annotations and tags
8+
* **Schema**: HED schema management and validation
9+
* **Validator**: Validation tools for HED data
10+
* **Tools**: Utility functions and data processing tools
11+
* **Errors**: Error handling and reporting classes
12+
513

614
.. toctree::
715
:maxdepth: 2
@@ -12,13 +20,3 @@ This section contains the complete API reference for Python HEDTools.
1220
tools
1321
errors
1422

15-
Core modules overview
16-
---------------------
17-
18-
The Python HEDTools package is organized into several key modules:
19-
20-
* **Models**: Core data structures for HED annotations and tags
21-
* **Schema**: HED schema management and validation
22-
* **Validator**: Validation tools for HED data
23-
* **Tools**: Utility functions and data processing tools
24-
* **Errors**: Error handling and reporting classes

docs/api/models.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Python HEDTools models
1+
Models
22
=============================
33

44
Core data models for working with HED data structures.

docs/api/schema.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Python HEDTools schema
1+
Schema
22
======================
33

44
HED schema management and validation tools.

docs/api/tools.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Python HEDTools tools
1+
Tools
22
=============================
33

44
Utility functions and data processing tools for HED operations.

docs/api/validator.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Python HEDTools validator
1+
Validator
22
=========================
33

44
Validation tools for HED data structures and annotations.

docs/index.rst

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,34 +15,18 @@ HED is integrated into major neuroimaging standards:
1515
* `NWB <https://www.nwb.org/>`_ (Neurodata Without Borders)
1616

1717
and this package enables you to validate, analyze, and manipulate HED annotations in various formats.
18-
19-
Python HEDTools features
20-
------------------------
18+
Package features include:
2119

2220
* **Validation**: Verify HED annotations against official schemas
2321
* **Analysis**: Search, filter, and summarize HED-annotated data
2422
* **BIDS integration**: Full support for BIDS dataset validation and processing
2523
* **NWB support**: Read and write HED annotations in NWB files using `ndx-hed <https://www.hedtags.org/ndx-hed>`_
2624
* **Multiple formats**: Work with JSON sidecars, TSV files, Excel spreadsheets
2725

28-
User guide
29-
----------
30-
3126
.. toctree::
3227
:maxdepth: 2
3328

3429
Guide <user_guide>
35-
36-
Python HEDTools API
37-
-------------------
38-
39-
.. toctree::
40-
:maxdepth: 2
41-
4230
API <api/index>
4331

44-
45-
Python HEDtools index
46-
----------------------
47-
4832
* :ref:`genindex`

spec_tests/hed-examples

Submodule hed-examples updated 131 files

0 commit comments

Comments
 (0)