From 364e3e050de32a3ee3d5db0d1ae491af9a6421c4 Mon Sep 17 00:00:00 2001 From: Neclow Date: Mon, 26 Jan 2026 14:55:52 +0000 Subject: [PATCH] docs: add missing functions to API reference Add 10 functions that were missing from api.rst: Base: - from_edges, to_edges - from_pairs, to_pairs Statistics: - stats.robinson_foulds Utils: - utils.vector.get_node_depth - utils.vector.get_node_depths - utils.vector.queue_shuffle - utils.vector.reroot - utils.vector.reroot_at_random Also alphabetized entries within each section. --- docs/api.rst | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 60ea07b..29b2bf5 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -10,10 +10,14 @@ Base :nosignatures: :toctree: generated/ - from_newick - to_newick from_ancestry + from_edges + from_newick + from_pairs to_ancestry + to_edges + to_newick + to_pairs IO ---------------- @@ -36,10 +40,11 @@ Statistics :toctree: generated/ stats.cophenetic_distances - stats.pairwise_distances stats.cov - stats.precision stats.incidence + stats.pairwise_distances + stats.precision + stats.robinson_foulds Utils ---------------- @@ -56,7 +61,12 @@ Utils utils.newick.find_num_leaves utils.newick.remove_branch_lengths utils.newick.remove_parent_labels - utils.vector.check_vector utils.vector.add_leaf + utils.vector.check_vector utils.vector.get_common_ancestor + utils.vector.get_node_depth + utils.vector.get_node_depths + utils.vector.queue_shuffle utils.vector.remove_leaf + utils.vector.reroot + utils.vector.reroot_at_random