Weekend's Work

See tag v0.5.0 for details!

docs/source/conf.py

@@ -10,30 +10,31 @@
 import sphinx_bootstrap_theme
 from recommonmark.parser import CommonMarkParser
 
-sys.path.insert(0, os.path.abspath('.'))
-sys.path.insert(0, os.path.abspath('..'))
-sys.path.insert(0, os.path.abspath('../../thermoDataGrabber/'))
-sys.path.insert(0, os.path.abspath('/../thermoDataGrabber/'))
-sys.path.insert(0, os.path.abspath('./thermoDataGrabber/'))
-sys.path.insert(0, os.path.abspath('../../thermoDataGrabber/thermoDataGrabber/'))
-sys.path.insert(0, os.path.abspath('../../notebooks/'))
-sys.path.insert(0, os.path.abspath('../../'))
-sys.path.insert(0, os.path.abspath('../../plots/'))
+sys.path.insert(0, os.path.abspath("."))
+sys.path.insert(0, os.path.abspath(".."))
+sys.path.insert(0, os.path.abspath("../../thermoDataGrabber/"))
+sys.path.insert(0, os.path.abspath("/../thermoDataGrabber/"))
+sys.path.insert(0, os.path.abspath("./thermoDataGrabber/"))
+sys.path.insert(0,
+                os.path.abspath("../../thermoDataGrabber/thermoDataGrabber/"))
+sys.path.insert(0, os.path.abspath("../../notebooks/"))
+sys.path.insert(0, os.path.abspath("../../"))
+sys.path.insert(0, os.path.abspath("../../plots/"))
 
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
 #
-# needs_sphinx = '1.0'
+# needs_sphinx = "1.0"
 
 # Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# extensions coming with Sphinx (named "sphinx.ext.*") or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo',
-    'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode',
-    'sphinx.ext.githubpages', 'sphinx.ext.napoleon',
-    'sphinx_autodoc_typehints', 'sphinx.ext.githubpages'
+    "sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.todo",
+    "sphinx.ext.mathjax", "sphinx.ext.ifconfig", "sphinx.ext.viewcode",
+    "sphinx.ext.githubpages", "sphinx.ext.napoleon",
+    "sphinx_autodoc_typehints", "sphinx.ext.githubpages"
 ]
 
 napoleon_google_docstring = True
@@ -48,34 +49,34 @@
 napoleon_use_param = True
 napoleon_use_rtype = True
 
-autodoc_mock_imports = ['pyrsistent', 'arrow']
+autodoc_mock_imports = ["pyrsistent", "arrow"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-source_suffix = ['.rst', '.md']
-source_parsers = {'.md': CommonMarkParser}
-# source_suffix = '.rst'
+source_suffix = [".rst", ".md"]
+source_parsers = {".md": CommonMarkParser}
+# source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'Thermo-Bridge Data Generator'
-copyright = '2016-2017, Nick Meyer, Aaron Wangberg'
-author = 'Nick Meyer, Aaron Wangberg'
+project = "Thermo-Bridge Data Generator"
+copyright = "2016-2017, Nick Meyer, Aaron Wangberg"
+author = "Nick Meyer, Aaron Wangberg"
 
-# The version info for the project you're documenting, acts as replacement for
+# The version info for the project you"re documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.4'
+version = "0.5"
 # The full version, including alpha/beta/rc tags.
-release = '0.4.2'
+release = "0.5.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -90,7 +91,7 @@
 exclude_patterns = ["ipynb_checkpoinst"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
@@ -101,7 +102,7 @@
 # a list of builtin themes.
 #
 
-html_theme = 'bootstrap'
+html_theme = "bootstrap"
 html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
 
 # Theme options are theme-specific and customize the look and feel of a theme
@@ -110,10 +111,10 @@
 #
 html_theme_options = {
     # Navigation bar title. (Default: ``project`` value)
-    'navbar_title': "Thermodynamics: Physics Bridge",
+    "navbar_title": "Thermodynamics: Physics Bridge",
 
     # Tab name for entire site. (Default: "Site")
-    'navbar_site_name': "Navigation",
+    "navbar_site_name": "Navigation",
 
     # A list of tuples containing pages or urls to link to.
     # Valid tuples should be in the following forms:
@@ -122,20 +123,20 @@
     #    (name, "http://example.com", True) # arbitrary absolute url
     # Note the "1" or "True" value above as the third argument to indicate
     # an arbitrary url.
-    'navbar_links': [],
+    "navbar_links": [],
 
     # Render the next and previous page links in navbar. (Default: true)
-    'navbar_sidebarrel': False,
+    "navbar_sidebarrel": False,
 
     # Render the current pages TOC in the navbar. (Default: true)
-    'navbar_pagenav': True,
+    "navbar_pagenav": True,
 
     # Tab name for the current pages TOC. (Default: "Page")
-    'navbar_pagenav_name': "On This Page",
+    "navbar_pagenav_name": "On This Page",
 
     # Global TOC depth for "site" navbar tab. (Default: 1)
     # Switching to -1 shows all levels.
-    'globaltoc_depth': 1,
+    "globaltoc_depth": 1,
 
     # Include hidden TOCs in Site navbar?
     #
@@ -144,83 +145,91 @@
     # will break.
     #
     # Values: "true" (default) or "false"
-    'globaltoc_includehidden': "true",
+    "globaltoc_includehidden": "true",
 
     # HTML navbar class (Default: "navbar") to attach to <div> element.
     # For black navbar, do "navbar navbar-inverse"
-    'navbar_class': "navbar-inverse",
+    "navbar_class": "navbar-inverse",
 
     # Fix navigation bar to top of page?
     # Values: "true" (default) or "false"
-    'navbar_fixed_top': "false",
+    "navbar_fixed_top": "false",
 
     # Location of link to source.
     # Options are "nav" (default), "footer" or anything else to exclude.
-    'source_link_position': "footer",
+    "source_link_position": "footer",
 
     # Bootswatch (http://bootswatch.com/) theme.
     #
     # Options are nothing (default) or the name of a valid theme
     # such as "amelia" or "cosmo".
-    'bootswatch_theme': "paper",
+    "bootswatch_theme": "paper",
 
     # Choose Bootstrap version.
     # Values: "3" (default) or "2" (in quotes)
-    'bootstrap_version': "3",
+    "bootstrap_version": "3",
 }
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Thermo-BridgeDataGeneratordoc'
+htmlhelp_basename = "Thermo-BridgeDataGeneratordoc"
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
+    # The paper size ("letterpaper" or "a4paper").
     #
-    # 'papersize': 'letterpaper',
+    # "papersize": "letterpaper",
 
-    # The font size ('10pt', '11pt' or '12pt').
+    # The font size ("10pt", "11pt" or "12pt").
     #
-    # 'pointsize': '12pt',
+    # "pointsize": "12pt",
 
     # Additional stuff for the LaTeX preamble.
     #
-    # 'preamble': '',
+    # "preamble": "",
 
     # Latex figure (float) alignment
     #
-    # 'figure_align': 'htbp',
+    # "figure_align": "htbp",
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
-latex_documents = [(master_doc, 'Thermo-BridgeDataGenerator.tex',
-                    'Thermo-Bridge Data Generator Documentation',
-                    'Nick Meyer, Aaron Wangberg', 'manual'), ]
+latex_documents = [(master_doc, "Thermo-BridgeDataGenerator.tex",
+                    "Thermo-Bridge Data Generator Documentation",
+                    "Nick Meyer, Aaron Wangberg", "manual"), ]
 
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, 'thermo-bridgedatagenerator',
-              'Thermo-Bridge Data Generator Documentation', [author], 1)]
+man_pages = [(master_doc, "thermo-bridgedatagenerator",
+              "Thermo-Bridge Data Generator Documentation", [author], 1)]
 
 # -- Options for Texinfo output -------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
-texinfo_documents = [(master_doc, 'Thermo-BridgeDataGenerator',
-                      'Thermo-Bridge Data Generator Documentation', author,
-                      'Thermo-BridgeDataGenerator',
-                      'One line description of project.', 'Miscellaneous'), ]
+texinfo_documents = [(master_doc, "Thermo-BridgeDataGenerator",
+                      "Thermo-Bridge Data Generator Documentation", author,
+                      "Thermo-BridgeDataGenerator",
+                      "One line description of project.", "Miscellaneous"), ]
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3.6/", None),
+    "pandas": ("http://pandas.pydata.org/pandas-docs/stable/", None),
+    "CoolProp": ("http://www.coolprop.org/", None),
+    "numpy": ("https://docs.scipy.org/doc/numpy/", None),
+    "matplotlib": ("http://matplotlib.org/", None),
+    "pyrsistent": ("http://pyrsistent.readthedocs.io/en/latest/", None),
+    "arrow": ("http://arrow.readthedocs.io/en/latest/", None)
+}

docs/source/whitepaper.md

@@ -15,7 +15,7 @@ To do this, we have made the following assumptions:
 
 *   We will be modeling a fluid supported by [coolProp][]
 *   We will be using x and y variables supported by [coolProp][]
-*   The user is using [Python 3][Python], preferably Python 3.6.
+*   The user is using [Python 3.6+.][Python]
 
 ## Why Python?