Skip to content

Commit

Permalink
update API documentation
Browse files Browse the repository at this point in the history
schlegelp committed Jan 11, 2024
1 parent fc6ed8f commit b44719b
Showing 1 changed file with 18 additions and 14 deletions.
32 changes: 18 additions & 14 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
@@ -50,9 +50,9 @@ Connectivity:
.. autosummary::
:toctree: generated/

fafbseg.flywire.synapses.fetch_adjacency
fafbseg.flywire.synapses.fetch_connectivity
fafbseg.flywire.synapses.fetch_synapses
fafbseg.flywire.synapses.get_adjacency
fafbseg.flywire.synapses.get_connectivity
fafbseg.flywire.synapses.get_synapses
fafbseg.flywire.synapses.synapse_counts
fafbseg.flywire.synapses.predict_transmitter

@@ -61,42 +61,45 @@ L2-related functions:
.. autosummary::
:toctree: generated/

fafbseg.flywire.l2_info
fafbseg.flywire.l2_graph
fafbseg.flywire.l2_dotprops
fafbseg.flywire.l2_skeleton
fafbseg.flywire.get_l2_info
fafbseg.flywire.get_l2_graph
fafbseg.flywire.get_l2_dotprops
fafbseg.flywire.get_l2_skeleton

Misc:

.. autosummary::
:toctree: generated/

fafbseg.flywire.fetch_edit_history
fafbseg.flywire.fetch_leaderboard
fafbseg.flywire.get_edit_history
fafbseg.flywire.get_leaderboard
fafbseg.flywire.get_neuropil_volumes
fafbseg.flywire.get_lineage_graph
fafbseg.flywire.get_lr_position
fafbseg.flywire.get_voxels

.. _api_annotations:

For fetching annotations:

.. autosummary::
:toctree: generated/

fafbseg.flywire.search_community_annotations
fafbseg.flywire.search_annotations
fafbseg.flywire.search_community_annotations
fafbseg.flywire.get_hierarchical_annotations
fafbseg.flywire.NeuronCriteria

For interaction with the CAVE engine:

.. autosummary::
:toctree: generated/

fafbseg.flywire.get_materialization_versions
fafbseg.flywire.create_annotation_table
fafbseg.flywire.list_annotation_tables
fafbseg.flywire.get_annotation_table_info
fafbseg.flywire.get_annotations
fafbseg.flywire.create_cave_table
fafbseg.flywire.list_cave_tables
fafbseg.flywire.get_cave_table_info
fafbseg.flywire.get_cave_table
fafbseg.flywire.delete_annotations
fafbseg.flywire.upload_annotations

@@ -107,6 +110,7 @@ Utility functions:
:toctree: generated/

fafbseg.flywire.set_default_dataset
fafbseg.flywire.set_default_annotation_version
fafbseg.flywire.get_user_information


0 comments on commit b44719b

Please sign in to comment.