Merge pull request #448 from GavinHuttley/master

DOC tidy
cogent3 · Dec 9, 2019 · 0ecffb0 · 0ecffb0
2 parents 3e27c1e + e0ddc4c
commit 0ecffb0
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 19 deletions.
diff --git a/doc/api/alignment/alignment.rst b/doc/api/alignment/alignment.rst
@@ -1,10 +1,8 @@
 :mod:`alignment`
-===============================
+================
 
 .. currentmodule:: cogent3.core.alignment
 
-Class overview
---------------
 .. autosummary::
     :toctree: classes
     :template: class.rst

diff --git a/doc/api/index.rst b/doc/api/index.rst
@@ -1,14 +1,15 @@
-###########
+###
 API
-###########
+###
 
-
-**Contents**
+********************************
+Objects for the major data types
+********************************
 
 .. toctree::
     :maxdepth: 1
-    
+
     alignment/alignment
     sequence/sequence
+    table/table
     tree/tree
-    table/table
diff --git a/doc/api/sequence/sequence.rst b/doc/api/sequence/sequence.rst
@@ -1,13 +1,11 @@
 :mod:`sequence`
-===============================
+===============
 
 .. currentmodule:: cogent3.core.sequence
 
-Class overview
---------------
 .. autosummary::
     :toctree: classes
     :template: class.rst
-    
+
     DnaSequence
     RnaSequence
diff --git a/doc/api/table/table.rst b/doc/api/table/table.rst
@@ -1,10 +1,8 @@
 :mod:`table`
-===============================
+============
 
 .. currentmodule:: cogent3.util.table
 
-Class overview
---------------
 .. autosummary::
     :toctree: classes
     :template: class.rst

diff --git a/doc/api/tree/tree.rst b/doc/api/tree/tree.rst
@@ -1,10 +1,8 @@
 :mod:`tree`
-===============================
+===========
 
 .. currentmodule:: cogent3.core.tree
 
-Class overview
---------------
 .. autosummary::
     :toctree: classes
     :template: class.rst