Merge branch 'feature/materials-glazing' into develop

Makefile

@@ -4,7 +4,7 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = umitutorial
+SPHINXPROJ    = umidocs
 SOURCEDIR     = .
 BUILDDIR      = _build
 

conf.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
-# umi Docs build configuration file, created by
-# sphinx-quickstart on Tue Sep 19 12:21:40 2017.
+# umidocs documentation build configuration file, created by
+# sphinx-quickstart on Thu Oct  5 17:17:46 2017.
 #
 # This file is execfile()d with the current directory set to its
 # containing dir.
@@ -30,16 +30,15 @@
 # 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.githubpages',
-              'sphinx.ext.doctest',
-              'sphinx.ext.todo',
-              'sphinx.ext.imgmath',
-              'sphinx.ext.ifconfig']
-
-# As long as we are not generating with the epub tag it is safe to use MathJax.
-if 'epub' not in tags:
-    extensions.remove('sphinx.ext.imgmath')
-    extensions.append('sphinx.ext.mathjax')
+extensions = ['sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -48,31 +47,37 @@
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
+from recommonmark.parser import CommonMarkParser
+
+source_parsers = {
+    '.md': CommonMarkParser,
+}
+
 source_suffix = ['.rst', '.md']
 
 # The master toctree document.
 master_doc = 'index'
 
 # General information about the project.
-project = u'umi Docs'
+project = u'umidocs'
 copyright = u'2017, MIT Sustainable Design Lab'
-author = u'Samuel Letellier-Duchesne'
+author = u'MIT Sustainable Design Lab'
 
 # 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 = u'2.0'
+version = u'2.3'
 # The full version, including alpha/beta/rc tags.
-release = u'2.0'
+release = u'2.3'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = 'English'
+language = None
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -83,7 +88,7 @@
 pygments_style = 'sphinx'
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = False
+todo_include_todos = True
 
 
 # -- Options for HTML output ----------------------------------------------
@@ -92,7 +97,6 @@
 # a list of builtin themes.
 #
 html_theme = 'sphinx_rtd_theme'
-html_theme_path = ['_themes']
 
 # 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
@@ -109,7 +113,7 @@
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'umidocs'
+htmlhelp_basename = 'umidocsdoc'
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -136,8 +140,8 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'umidocs.tex', u'umi Docs',
-     u'Samuel Letellier-Duchesne', 'manual'),
+    (master_doc, 'umidocs.tex', u'umidocs Documentation',
+     u'MIT Sustainable Design Lab', 'manual'),
 ]
 
 
@@ -146,7 +150,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'umidocs', u'umi Docs',
+    (master_doc, 'umidocs', u'umidocs Documentation',
      [author], 1)
 ]
 
@@ -157,7 +161,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'umidocs', u'umi Docs',
+    (master_doc, 'umidocs', u'umidocs Documentation',
      author, 'umidocs', 'One line description of project.',
      'Miscellaneous'),
 ]
@@ -167,11 +171,11 @@
 # -- Options for Epub output ----------------------------------------------
 
 # Bibliographic Dublin Core info.
-epub_title = "umi Tutorial"
-epub_author = "Samuel Letellier-Duchesne"
-epub_publisher = "Sustainable Design Lab"
-epub_copyright = "copyright"
-epub_cover = ('_static/cover.png', '')
+epub_title = project
+epub_author = author
+epub_publisher = author
+epub_copyright = copyright
+
 # The unique identifier of the text. This can be a ISBN number
 # or the project homepage.
 #
@@ -182,17 +186,9 @@
 # epub_uid = ''
 
 # A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html','README.md']
-
-# Markdown
-from recommonmark.parser import CommonMarkParser
+epub_exclude_files = ['search.html']
 
-source_parsers = {
-    '.md': CommonMarkParser,
-}
 
-if 'epub' in tags:
-    plot_include_source = False
-    plot_html_show_formats = False
 
-plot_formats = ["png", "hires.png", "pdf", "svg"]
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}

docs/template-info/_template-detail.rst

@@ -8,6 +8,7 @@ This section will provide details on the template files
    :hidden:
 
    opaque
+   glazing
 
 .. sectionauthor::
    Samuel Letellier-Duchesne <samuel.letellier-duchesne@polymtl.ca>
@@ -55,3 +56,52 @@ Opaque
 +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
 | :ref:`visible-absorptance`                                    |                                                                                            |
 +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+
+
+^^^^^^^
+Glazing
+^^^^^^^
+
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| Setting                                                       | Short Description                                                                          |
++===============================================================+============================================================================================+
+| :ref:`g_conductivity`                                         |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| :ref:`g_cost`                                                 |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| :ref:`g_density`                                              |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| :ref:`g_embodied-carbon`                                      |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| :ref:`g_embodied-energy`                                      |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| :ref:`g_substitution-rate-pattern`                            |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| :ref:`g_substitution-timestep`                                |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| :ref:`g_transportation-carbon`                                |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| :ref:`g_transportation-distance`                              |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| :ref:`g_transportation-energy`                                |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| :ref:`g_dirt-factor`                                          |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| :ref:`g_back-side-ir-emissivity`                              |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| :ref:`g_front-side-ir-emissivity`                             |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| :ref:`g_ir-transmittance`                                     |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| :ref:`g_back-side-solar-reflectance`                          |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| :ref:`g_front-side-solar-reflectance`                         |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| :ref:`g_solar-transmittance`                                  |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| :ref:`g_back-side-visible-reflectance`                        |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| :ref:`g_front-side-visible-reflectance`                       |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| :ref:`g_visible-transmittance`                                |                                                                                            |
++---------------------------------------------------------------+--------------------------------------------------------------------------------------------+

docs/template-info/glazing.rst

@@ -0,0 +1,103 @@
+============================
+Galzing material description
+============================
+
+.. _g_conductivity:
+
+Conductivity
+************
+
+.. _g_cost:
+
+Cost
+****
+
+.. _g_density:
+
+Density
+*******
+
+.. _g_embodied-carbon:
+
+Embodied Carbon
+***************
+
+.. _g_embodied-energy:
+
+Embodied Energy
+***************
+
+.. _g_substitution-rate-pattern:
+
+Substitution Rate Pattern
+*************************
+
+.. _g_substitution-timestep:
+
+Substitution Timestep
+*********************
+
+.. _g_transportation-carbon:
+
+Transportation Carbon
+*********************
+
+.. _g_transportation-distance:
+
+Transportation Distance
+***********************
+
+.. _g_transportation-energy:
+
+Transportation Energy
+*********************
+
+.. _g_dirt-factor:
+
+Dirt Factor
+***********
+
+.. _g_back-side-ir-emissivity:
+
+Back-side IR Emissivity
+***********************
+
+.. _g_front-side-ir-emissivity:
+
+Front-side IR Emissivity
+************************
+
+.. _g_ir-transmittance:
+
+IR Transmittance
+****************
+
+.. _g_back-side-solar-reflectance:
+
+Back-side Solar Reflectance
+***************************
+
+.. _g_front-side-solar-reflectance:
+
+Front-side Solar Reflectance
+****************************
+
+.. _g_solar-transmittance:
+
+Solar Transmittance
+*******************
+
+.. _g_back-side-visible-reflectance:
+
+Back-side Visible Reflectance
+*****************************
+
+.. _g_front-side-visible-reflectance:
+
+Front-side Visible Reflectance
+******************************
+
+.. _g_visible-transmittance:
+
+Visible Transmittance
+*********************

docs/template-info/opaque.rst

@@ -13,6 +13,7 @@ Conductivity
     \overset{\left[\frac{0}{0}\right]}{\underset{\mathrm{H}}{=}}
     \lim_{x\to 0}{\frac{e^x}{2}}={\frac{1}{2}}
 
+
 .. _cost:
 
 Cost

index.rst

@@ -17,3 +17,11 @@ A first public version of Umi was released during a public symposium on Sustaina
    :caption: Template Editor
 
    Template Details <docs/template-info/_template-detail.rst>
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

make.bat

@@ -9,7 +9,7 @@ if "%SPHINXBUILD%" == "" (
 )
 set SOURCEDIR=.
 set BUILDDIR=_build
-set SPHINXPROJ=umitutorial
+set SPHINXPROJ=umidocs
 
 if "%1" == "" goto help