Improve sphinx documentation structure

Put classes in separate files and use autosummary to generate them.
TkinterEP · Oct 18, 2018 · 05b33e1 · 05b33e1 · j4321 · Oct 18, 2018
1 parent 3116205
commit 05b33e1
Show file tree

Hide file tree

Showing 44 changed files with 460 additions and 177 deletions.
diff --git a/docs/source/.doctrees/environment.pickle b/docs/source/.doctrees/environment.pickle
diff --git a/docs/source/.doctrees/index.doctree b/docs/source/.doctrees/index.doctree
diff --git a/docs/source/_templates/autosummary/base.rst b/docs/source/_templates/autosummary/base.rst
@@ -0,0 +1,5 @@
+{{ name | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. auto{{ objtype }}:: {{ objname }}
diff --git a/docs/source/_templates/autosummary/class.rst b/docs/source/_templates/autosummary/class.rst
@@ -0,0 +1,9 @@
+{{ name | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :show-inheritance:
+   :members:
+
+   .. automethod:: __init__
diff --git a/docs/source/_templates/autosummary/module.rst b/docs/source/_templates/autosummary/module.rst
@@ -0,0 +1,40 @@
+{{ name | escape | underline}}
+
+.. automodule:: {{ fullname }}
+   :show-inheritance:
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree: functions
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree: classes
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: Exceptions
+
+   .. autosummary::
+      :toctree: exceptions
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
diff --git a/docs/source/autocomplete.rst b/docs/source/autocomplete.rst
diff --git a/docs/source/color.rst b/docs/source/color.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -14,7 +14,7 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('../..'))
 
 
 # -- Project information -----------------------------------------------------
@@ -40,9 +40,8 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
-    'sphinx.ext.doctest',
-    'sphinx.ext.coverage',
     'sphinx.ext.viewcode',
+    'sphinx.ext.autosummary',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -154,7 +153,7 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
     (master_doc, 'ttkwidgets', 'ttkwidgets Documentation',
-     author, 'ttkwidgets', 'One line description of project.',
+     author, 'ttkwidgets', "A collection of widgets for Tkinter's ttk extensions by various authors.",
      'Miscellaneous'),
 ]
 
@@ -178,3 +177,4 @@
 
 
 # -- Extension configuration -------------------------------------------------
+autosummary_generate = True
diff --git a/docs/source/documentation.rst b/docs/source/documentation.rst
@@ -1,71 +1,30 @@
 Documentation
 =============
-.. currentmodule:: ttkwidgets
 
-Submodules
-~~~~~~~~~~
 .. toctree::
+    :hidden:
+    :glob:
     :maxdepth: 1
-
-    autocomplete
-    color
-    font
-    frames
+    :Caption: Packages
 
-Widgets
-~~~~~~~
+    ttkwidgets/*
 
-AutoHideScrollbar
------------------
-.. autoclass:: AutoHideScrollbar
-    :members:
-
-Calendar
---------
-.. autoclass:: Calendar
-    :members:
-
-CheckboxTreeview
-----------------
-.. autoclass:: CheckboxTreeview
-    :members:
-
-DebugWindow  
------------
-.. autoclass:: DebugWindow
-    :members:
-
-ItemsCanvas
------------
-.. autoclass:: ItemsCanvas
-    :members:
+Package structure
 
-LinkLabel
----------
-.. autoclass:: LinkLabel
-    :members:
+::
 
-ScaleEntry
-----------
-.. autoclass:: ScaleEntry
-    :members:
+    ttkwidgets
+    ├── autocomplete
+    ├── color
+    ├── font
+    └── frames
 
-ScrolledListbox
----------------
-.. autoclass:: ScrolledListbox
-    :members:
-
-Table
------    
-.. autoclass:: Table
-    :members:
-
-TickScale
----------
-.. autoclass:: TickScale
-    :members:
-
-TimeLine
---------    
-.. autoclass:: TimeLine
-    :members:
+=================== =======================
+Package             Content
+=================== =======================
+:ref:`ttkwidgets`   Miscellanous widgets.
+:ref:`autocomplete` Autocompletion widgets.
+:ref:`color`        Color choosing widgets.
+:ref:`font`         Font choosing widgets.
+:ref:`frames`       Frame based widgets.
+=================== =======================      
diff --git a/docs/source/font.rst b/docs/source/font.rst
diff --git a/docs/source/frames.rst b/docs/source/frames.rst
diff --git a/docs/source/genindex.rst b/docs/source/genindex.rst
@@ -0,0 +1,2 @@
+Index
+=====
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -12,22 +12,25 @@ A collection of widgets for Tkinter's ttk extensions by various authors
 
 
 .. toctree::
-   :maxdepth: 5
+   :maxdepth: 2
    :caption: Contents:
 
    installation
    documentation
    authors
+   genindex
+
 
 License
 -------
 
-ttkwidgets: A collection of widgets for Tkinter's ttk extensions by various authors 
-Copyright (C) RedFantom 2017
-Copyright (C) The Python Team
-Copyright (C) Mitja Martini 2008
-Copyright (C) Russell Adams 2011
-Copyright (C) Juliette Monsel 2017
+ttkwidgets: A collection of widgets for Tkinter's ttk extensions by various authors.
+
+* Copyright (C) RedFantom 2017
+* Copyright (C) The Python Team
+* Copyright (C) Mitja Martini 2008
+* Copyright (C) Russell Adams 2011
+* Copyright (C) Juliette Monsel 2017
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -40,14 +43,8 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
+along with this program.  If not, see http://www.gnu.org/licenses/.
 
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`search`
 
 .. |Travis| image:: https://travis-ci.org/RedFantom/ttkwidgets.svg?branch=master
     :alt: Travis CI Build Status

diff --git a/docs/source/ttkwidgets/ttkwidgets.autocomplete.rst b/docs/source/ttkwidgets/ttkwidgets.autocomplete.rst
@@ -0,0 +1,13 @@
+.. _autocomplete:
+
+ttkwidgets.autocomplete
+=======================
+
+.. currentmodule:: ttkwidgets.autocomplete
+
+.. autosummary::
+    :nosignatures:
+    :toctree: ttkwidgets.autocomplete
+
+    AutocompleteCombobox
+    AutocompleteEntry
diff --git a/...idgets/ttkwidgets.autocomplete/ttkwidgets.autocomplete.AutocompleteCombobox.rst b/...idgets/ttkwidgets.autocomplete/ttkwidgets.autocomplete.AutocompleteCombobox.rst
@@ -0,0 +1,10 @@
+AutocompleteCombobox
+====================
+
+.. currentmodule:: ttkwidgets.autocomplete
+
+.. autoclass:: AutocompleteCombobox
+   :show-inheritance:
+   :members:
+
+   .. automethod:: __init__
diff --git a/...tkwidgets/ttkwidgets.autocomplete/ttkwidgets.autocomplete.AutocompleteEntry.rst b/...tkwidgets/ttkwidgets.autocomplete/ttkwidgets.autocomplete.AutocompleteEntry.rst
@@ -0,0 +1,10 @@
+AutocompleteEntry
+=================
+
+.. currentmodule:: ttkwidgets.autocomplete
+
+.. autoclass:: AutocompleteEntry
+   :show-inheritance:
+   :members:
+
+   .. automethod:: __init__
diff --git a/docs/source/ttkwidgets/ttkwidgets.color.rst b/docs/source/ttkwidgets/ttkwidgets.color.rst
@@ -0,0 +1,21 @@
+.. _color:
+
+ttkwidgets.color
+================
+
+.. currentmodule:: ttkwidgets.color
+
+.. rubric:: Functions
+
+.. autofunction:: askcolor
+
+.. rubric:: Classes
+
+.. autosummary::
+    :nosignatures:
+    :toctree: ttkwidgets.color
+
+    AlphaBar
+    ColorPicker
+    ColorSquare
+    GradientBar