updating docs

Author: millen1m

MANIFEST.in

@@ -1 +1,3 @@
 include LICENSE
+include README.rst
+include requirements.txt

docs/conf.py

@@ -19,7 +19,22 @@
 #
 import os
 import sys
-sys.path.insert(0, '/Users/maximmillen/git/packages/sfsimodels/')
+from datetime import date
+
+file_loc = os.path.split(__file__)[0]
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(file_loc), '.')))
+
+import sfsimodels
+# -- Project information -----------------------------------------------------
+
+project = sfsimodels.__about__.__project__
+author = sfsimodels.__about__.__author__
+copyright = u'Copyright 2016 - {0} {1}'.format(date.today().year, author)
+
+# The short X.Y version
+version = sfsimodels.__about__.__version__
+# The full version, including alpha/beta/rc tags
+release = version
 
 import mock
 
@@ -37,11 +52,13 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc',
+extensions = [
+    'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
+    'sphinx.ext.napoleon',
     'sphinx.ext.mathjax',
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode'
@@ -61,7 +78,6 @@
 
 # General information about the project.
 project = 'sfsimodels'
-copyright = '2018, Maxim Millen'
 author = 'Maxim Millen'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -71,7 +87,6 @@
 # The short X.Y version.
 version = '0.6.3'
 # The full version, including alpha/beta/rc tags.
-release = '0.6.3'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -88,7 +103,7 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
-# If true, `todo` and `todoList` produce output, else they produce nothing.
+# If true, `to do` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
 
 
@@ -97,7 +112,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'nature'  # Switch to an ECP 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

sfsimodels/__about__.py

@@ -1 +1,4 @@
-__version__ = "0.9.6"
+__project__ = "sfsimodels"
+__author__ = "Maxim Millen"
+__version__ = "0.9.7"
+__license__ = "MIT"

sfsimodels/__init__.py

@@ -20,4 +20,6 @@
 
 # from sfsimodels.build_model_descriptions import print_all_parameters
 from sfsimodels.models.foundations import PadFoundation, RaftFoundation  # deprecated objects
-from sfsimodels.models.buildings import FrameBuilding, WallBuilding, Structure, FrameBuilding2D  # deprecated objects
+from sfsimodels.models.buildings import FrameBuilding, WallBuilding, Structure, FrameBuilding2D  # deprecated objects
+
+from sfsimodels import __about__