Docs: document NeuronConnector

navis-org · Jun 13, 2023 · 081da2d · 081da2d
1 parent 139f842
commit 081da2d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -481,6 +481,11 @@ Connectivity
 ++++++++++++
 Collection of functions to work with graphs and adjacency matrices.
 
+.. autosummary::
+    :toctree: generated/
+
+    navis.NeuronConnector
+
 Graphs
 ------
 Functions to convert neurons and networkx to iGraph or networkX graphs.

diff --git a/docs/source/whats_new.rst b/docs/source/whats_new.rst
@@ -18,6 +18,8 @@ repository.
    * - dev
      - ongoing
      - - dropped support for Python 3.7
+       - :class:`navis.NeuronConnector` class for creating connectivity graphs
+         from groups neurons with consistent connector IDs.
    * - 1.4.0
      - 21/12/22
      - - BREAKING: ``navis.flow_centrality`` was renamed to :func:`navis.synapse_flow_centrality`