Merge pull request #2 from IanCa/develop

Add alternate api.rst
hed-standard · Jan 11, 2023 · 92ba027 · 92ba027
2 parents 53a8e99 + b40bbd4
commit 92ba027
Show file tree

Hide file tree

Showing 21 changed files with 116 additions and 971 deletions.
diff --git a/docs/source/_templates/custom-class-template.rst b/docs/source/_templates/custom-class-template.rst
@@ -0,0 +1,32 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+   {% block methods %}
+   .. automethod:: __init__
+
+   {% if methods %}
+   .. rubric:: {{ _('Methods') }}
+
+   .. autosummary::
+   {% for item in methods %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Attributes') }}
+
+   .. autosummary::
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
diff --git a/docs/source/_templates/custom-module-template.rst b/docs/source/_templates/custom-module-template.rst
@@ -0,0 +1,66 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+      :toctree:
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: {{ _('Functions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: {{ _('Classes') }}
+
+   .. autosummary::
+      :toctree:
+      :template: custom-class-template.rst
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: {{ _('Exceptions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{% block modules %}
+{% if modules %}
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :template: custom-module-template.rst
+   :recursive:
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}
diff --git a/docs/source/api2.rst b/docs/source/api2.rst
@@ -0,0 +1,17 @@
+HED API reference (Auto style)
+========================
+
+.. currentmodule:: hed
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module-template.rst
+   :recursive:
+
+    errors
+    models
+    schema
+    tools
+    validator
+
+
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -17,16 +17,6 @@
 
 
 sys.path.insert(0, os.path.abspath('../../'))
-# sys.path.insert(0, os.path.abspath('../../hed'))
-# sys.path.insert(0, os.path.abspath('../../hed/models'))
-# sys.path.insert(0, os.path.abspath('../../hed/schema'))
-sys.path.insert(0, os.path.abspath('../../hed/tools/'))
-# sys.path.insert(0, os.path.abspath('../../hed/tools/analysis'))
-# sys.path.insert(0, os.path.abspath('../../hed/tools/bids'))
-# sys.path.insert(0, os.path.abspath('../../hed/tools/remodeling'))
-# sys.path.insert(0, os.path.abspath('../../hed/tools/remodeling/cli'))
-# sys.path.insert(0, os.path.abspath('../../hed/tools/remodeling/operations'))
-# sys.path.insert(0, os.path.abspath('../../hed/validators'))
 
 # -- Project information -----------------------------------------------------
 project = 'HED Python'

diff --git a/docs/source/generated/hed.models.rst b/docs/source/generated/hed.models.rst
diff --git a/docs/source/generated/hed.rst b/docs/source/generated/hed.rst
diff --git a/docs/source/generated/hed.tools.analysis.file_dictionary.FileDictionary.rst b/docs/source/generated/hed.tools.analysis.file_dictionary.FileDictionary.rst