Move the README into doc/, add it to the Sphinx index, and tweak that.

diff --git a/README b/doc/README.rst
similarity index 92%
rename from README
rename to doc/README.rst
index 06dead08c101b546285fb0f1c8e97f2907220d4c..6fe9ba6ca2f5c6db0e82979deab2c764f6a8d66d 100644 (file)
--- a/README
+++ b/doc/README.rst
@@ -1,10 +1,12 @@
-== Overview ==
+Overview
+--------
 
 Dunshire is a CVXOPT-based library for solving linear (cone)
 games. The notion of a cone game was introduced by Gowda[1] and
 extended to asymmetric cones in my thesis[2].
 
-== Requirements ==
+Requirements
+------------
 
 The only requirement is the CVXOPT library, available for most Linux
 distributions. Dunshire is targeted at python-3.x, but python-2.x will

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 7ac6e2afb03c6034e3def7540d212c2f217ee608..62ac53045f9af61001520f56e891484f83bbda3d 100644 (file)
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -17,7 +17,7 @@ extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.coverage',
-    'sphinx.ext.ifconfig',
+    'sphinx.ext.pngmath',
     'sphinx.ext.viewcode',
 ]
 
@@ -71,10 +71,18 @@ html_theme = 'alabaster'
 
 # Remove the search box from the default list of sidebars.
 html_sidebars = {
-    '**': [
-        'about.html',
-        'navigation.html'
-    ]
+  '**': [
+    'about.html',
+    'navigation.html'
+  ]
+}
+
+# http://alabaster.readthedocs.io/en/latest/customization.html#theme-options
+html_theme_options = {
+  'github_button': False,
+  'github_user': False,
+  'github_repo': False,
+  'show_powered_by': False
 }
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
@@ -93,12 +101,6 @@ html_show_copyright = False
 # This is the file name suffix for HTML files (e.g. ".xhtml").
 #html_file_suffix = None
 
-# Language to be used for generating the HTML full-text search index.
-# Sphinx supports the following languages:
-#   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
-#   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
-#html_search_language = 'en'
-
 # The name of a javascript file (relative to the configuration directory) that
 # implements a search results scorer. If empty, the default will be used.
 #html_search_scorer = 'scorer.js'

diff --git a/doc/source/index.rst b/doc/source/index.rst
index 57c74d43b640f69302375a9f5f50912c3adc61d7..dcb28d567838c4949e962fd572948da4fba37812 100644 (file)
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,13 +1,16 @@
 Dunshire
-================================
+========
+
+.. include:: ../README.rst
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
-   dunshire
-   modules
+
+API Documentation
+-----------------
 
 .. autosummary::
    :toctree: _autosummary
@@ -17,9 +20,3 @@ Contents:
    dunshire.options
    dunshire.matrices
    dunshire.symmetric_linear_game
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`