Change theme to sphinx_rtd_theme

This theme is the standard read the docs theme. I also added framework for an about section including and introduction and faq
mailsac · Apr 6, 2018 · 082a4d6 · 082a4d6
1 parent 060a319
commit 082a4d6
Show file tree

Hide file tree

Showing 10 changed files with 36 additions and 107 deletions.
diff --git a/.gitignore b/.gitignore
@@ -67,3 +67,7 @@ typings/
 
 #sphinx
 _build/
+
+#ignore vim swp files
+*.swp
+*.swo
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
diff --git a/about/faq.rst b/about/faq.rst
@@ -0,0 +1,2 @@
+FAQ
+===
diff --git a/about/index.rst b/about/index.rst
@@ -0,0 +1,11 @@
+About
+=====
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-about
+
+   introduction
+   faq
+
+.. history
diff --git a/about/introduction.rst b/about/introduction.rst
@@ -0,0 +1,4 @@
+.. _about_intro: 
+
+Introduction
+============
diff --git a/conf.py b/conf.py
@@ -74,7 +74,8 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+#html_theme = 'alabaster'
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -152,4 +153,4 @@
     (master_doc, 'mailsac-examples', u'mailsac-examples Documentation',
      author, 'mailsac-examples', 'One line description of project.',
      'Miscellaneous'),
-]
+]
diff --git a/help.rst b/help.rst
diff --git a/index.rst b/index.rst
@@ -3,31 +3,22 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to mailsac-examples's documentation!
+Mailsac Docs
 ============================================
 
-Another simple header
-=====================
+Welcome to the official documentation for Mailsac, the email service built for
+developers. If you are new to this documentation we recommend taking a look at 
+the :ref:`introduction page <about_intro>` to get an overview of what the
+documentation has to offer.
 
-Here is text explaining some very complicated stuff.
+The table of contents is the sidebar and will let you easily access the
+documentation for your topic of interest. You can also use the search function
+in the top left corner.
 
-    print 'hello'
-    >> hello
-
-Guide
-^^^^^
 
 .. toctree::
-   :maxdepth: 2
-
-   license
-   help
-
-
-
-Indices and tables
-==================
+   :maxdepth: 1
+   :caption: General
+   :name: sec-general
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   about/index
diff --git a/license.rst b/license.rst