Started with autodoc

Robpol86 · Jun 12, 2016 · 8f2593a · 8f2593a
1 parent 8e9d005
commit 8f2593a
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 22 deletions.
diff --git a/docs/asciitable.rst b/docs/asciitable.rst
@@ -0,0 +1,8 @@
+.. _asciitable:
+
+==========
+AsciiTable
+==========
+
+.. autoclass:: terminaltables.AsciiTable
+    :members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -13,11 +13,11 @@
 author = check_output([SETUP, '--author']).strip().decode('ascii')
 copyright = '{}, {}'.format(time.strftime('%Y'), author)
 master_doc = 'index'
-nitpicky = True
 project = check_output([SETUP, '--name']).strip().decode('ascii')
 pygments_style = 'friendly'
 release = version = check_output([SETUP, '--version']).strip().decode('ascii')
 templates_path = ['_templates']
+extensions = list()
 
 
 # Options for HTML output.
@@ -36,6 +36,10 @@
 html_title = project
 
 
-# Extensions.
-extensions = ['sphinx.ext.extlinks']
+# extlinks.
+extensions.append('sphinx.ext.extlinks')
 extlinks = {'github': ('https://github.com/robpol86/{0}/blob/v{1}/%s'.format(project, version), '')}
+
+
+# autodoc
+extensions.append('sphinx.ext.autodoc')
diff --git a/docs/index.rst b/docs/index.rst
@@ -53,11 +53,16 @@ Contents
 
 .. toctree::
     :maxdepth: 2
+    :caption: General
 
     install
     quickstart
-    settings
-    tables
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Table Styles
+
+    asciitable
 
 .. _colorclass: https://github.com/Robpol86/colorclass
 .. _colorama: https://github.com/tartley/colorama

diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -85,7 +85,8 @@ Maybe you want lines in between all rows:
     | Row three column one | Row three column two |
     +----------------------+----------------------+
 
-There are many more settings available. You can find out more by reading the :ref:`settings` section.
+There are many more settings available. Each table style pretty much shares the same settings but there are a few minor
+exceptions. Refer to each table style's documentation on the sidebar.
 
 Other Table Styles
 ==================
@@ -105,4 +106,4 @@ API.
     │ Row three column one │ Row three column two │
     └──────────────────────┴──────────────────────┘
 
-You can find documentation for all table styles over at the :ref:`tables` section.
+You can find documentation for all table styles on the sidebar.
diff --git a/docs/settings.rst b/docs/settings.rst
diff --git a/docs/tables.rst b/docs/tables.rst
diff --git a/terminaltables/ascii_table.py b/terminaltables/ascii_table.py
@@ -6,7 +6,7 @@
 
 
 class AsciiTable(BaseTable):
-    """Draw a table using regular ASCII characters, such as `+`, `|`, and `-`.
+    """Draw a table using regular ASCII characters, such as ``+``, ``|``, and ``-``.
 
     :ivar iter table_data: List (empty or list of lists of strings) representing the table.
     :ivar str title: Optional title to show within the top border of the table.