Doc cosmetics.

Use more :automodule:: instead of specifying things separately, when it seems to make sense. This is simpler.
etetoolkit · Sep 20, 2023 · 3e7ef44 · 3e7ef44
1 parent 89b1e18
commit 3e7ef44
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 31 deletions.
diff --git a/doc/reference/reference_clustering.rst b/doc/reference/reference_clustering.rst
@@ -1,12 +1,8 @@
-Clustering module
-=================
+Clustering
+==========
 
-.. contents::
-
-
-ClusterTree
------------
-
-.. autoclass:: ete4.ClusterTree
+.. automodule:: ete4.clustering.clustertree
    :members:
+   :undoc-members:
+   :special-members: __init__
    :show-inheritance:
diff --git a/doc/reference/reference_ncbi.rst b/doc/reference/reference_ncbi.rst
@@ -1,17 +1,7 @@
-NCBITaxa module
-===============
+NCBITaxa
+========
 
-.. contents::
-
-NCBITaxa class
---------------
-
-.. autoclass:: ete4.NCBITaxa
+.. automodule:: ete4.ncbi_taxonomy.ncbiquery
    :members:
    :undoc-members:
-
-
-Functions
----------
-
-.. autofunction:: ete4.is_taxadb_up_to_date
+   :special-members: __init__
diff --git a/doc/reference/reference_seqgroup.rst b/doc/reference/reference_seqgroup.rst
@@ -1,7 +1,7 @@
-Seqgroup class
-==============
+SeqGroup
+========
 
-.. autoclass:: ete4.SeqGroup
+.. automodule:: ete4.coretype.seqgroup
    :members:
    :undoc-members:
    :special-members: __init__
diff --git a/doc/reference/reference_tree.rst b/doc/reference/reference_tree.rst
@@ -1,5 +1,5 @@
-Tree class
-==========
+Tree
+====
 
 .. autoclass:: ete4.Tree
    :members:

diff --git a/doc/reference/reference_treeview.rst b/doc/reference/reference_treeview.rst
@@ -1,5 +1,5 @@
-Treeview module
-===============
+Treeview
+========
 
 .. contents::
 

diff --git a/ete4/coretype/seqgroup.py b/ete4/coretype/seqgroup.py
@@ -1,5 +1,5 @@
 """
-The 'seqgroup' module provides methods and classes to operate with
+This module provides the SeqGroup class with methods to operate with
 Multiple Sequence Files, including Multiple Sequence Alignments.
 
 Currently, Fasta, Phylip sequencial and Phylip interleaved formats are