Merge pull request #14 from MITSustainableDesignLab/develop

New template detail section
MITSustainableDesignLab · Oct 5, 2017 · fab6b62 · fab6b62
2 parents 11a2e8f + 6d0e784
commit fab6b62
Show file tree

Hide file tree

Showing 3 changed files with 105 additions and 66 deletions.
diff --git a/docs/template-detail.rst → docs/template-info/_template-detail.rst b/docs/template-detail.rst → docs/template-info/_template-detail.rst
@@ -3,6 +3,11 @@ Template documentation
 ======================
 This section will provide details on the template files
 
+.. toctree::
+   :glob:
+
+   *
+
 ---------
 Materials
 ---------
@@ -14,84 +19,35 @@ Opaque
 +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
 | Setting                                                       | Short Description                                                                          |
 +===============================================================+============================================================================================+
-| `Conductivity`_                                               |                                                                                            |
+| :ref:`conductivity`                                           |                                                                                            |
 +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
-| `Cost`_                                                       |                                                                                            |
+| :ref:`cost`                                                   |                                                                                            |
 +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
-| `Density`_                                                    |                                                                                            |
+| :ref:`density`                                                |                                                                                            |
 +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
-| `Embodied Carbon`_                                            |                                                                                            |
+| :ref:`embodied-carbon`                                        |                                                                                            |
 +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
-| `Embodied Energy`_                                            |                                                                                            |
+| :ref:`embodied-energy`                                        |                                                                                            |
 +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
-| `Substitution Rate Pattern`_                                  |                                                                                            |
+| :ref:`substitution-rate-pattern`                              |                                                                                            |
 +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
-| `Substitution Timestep`_                                      |                                                                                            |
+| :ref:`substitution-timestep`                                  |                                                                                            |
 +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
-| `Transportation Carbon`_                                      |                                                                                            |
+| :ref:`transportation-carbon`                                  |                                                                                            |
 +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
-| `Transportation Distance`_                                    |                                                                                            |
+| :ref:`transportation-distance`                                |                                                                                            |
 +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
-| `Transportation Energy`_                                      |                                                                                            |
+| :ref:`transportation-energy`                                  |                                                                                            |
 +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
-| `Moisture Diffusion Resistance`_                              |                                                                                            |
+| :ref:`moisture-diffusion-resistance`                          |                                                                                            |
 +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
-| `Roughness`_                                                  |                                                                                            |
+| :ref:`roughness`                                              |                                                                                            |
 +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
-| `Solar Absorptance`_                                          |                                                                                            |
+| :ref:`solar-absorptance`                                      |                                                                                            |
 +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
-| `Specific Heat`_                                              |                                                                                            |
+| :ref:`specific-heat`                                          |                                                                                            |
 +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
-| `Thermal Emittance`_                                          |                                                                                            |
+| :ref:`thermal-emittance`                                      |                                                                                            |
 +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
-| `Visible Absorptance`_                                        |                                                                                            |
+| :ref:`visible-absorptance`                                    |                                                                                            |
 +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+
-
-------------
-Conductivity
-------------
-----
-Cost
-----
--------
-Density
--------
----------------
-Embodied Carbon
----------------
----------------
-Embodied Energy
----------------
--------------------------
-Substitution Rate Pattern
--------------------------
----------------------
-Substitution Timestep
----------------------
----------------------
-Transportation Carbon
----------------------
------------------------
-Transportation Distance
------------------------
----------------------
-Transportation Energy
----------------------
------------------------------
-Moisture Diffusion Resistance
------------------------------
----------
-Roughness
----------
------------------
-Solar Absorptance
------------------
--------------
-Specific Heat
--------------
------------------
-Thermal Emittance
------------------
--------------------
-Visible Absorptance
--------------------
diff --git a/docs/template-info/opaque.rst b/docs/template-info/opaque.rst
@@ -0,0 +1,83 @@
+===========================
+Opaque material description
+===========================
+
+.. _conductivity:
+
+Conductivity
+************
+
+.. _cost:
+
+Cost
+****
+
+.. _density:
+
+Density
+*******
+
+.. _embodied-carbon:
+
+Embodied Carbon
+***************
+
+.. _embodied-energy:
+
+Embodied Energy
+***************
+
+.. _substitution-rate-pattern:
+
+Substitution Rate Pattern
+*************************
+
+.. _substitution-timestep:
+
+Substitution Timestep
+*********************
+
+.. _transportation-carbon:
+
+Transportation Carbon
+*********************
+
+.. _transportation-distance:
+
+Transportation Distance
+***********************
+
+.. _transportation-energy:
+
+Transportation Energy
+*********************
+
+.. _moisture-diffusion-resistance:
+
+Moisture Diffusion Resistance
+*****************************
+
+.. _roughness:
+
+Roughness
+*********
+
+.. _solar-absorptance:
+
+Solar Absorptance
+*****************
+
+.. _specific-heat:
+
+Specific Heat
+*************
+
+.. _thermal-emittance:
+
+Thermal Emittance
+*****************
+
+.. _visible-absorptance:
+
+Visible Absorptance
+*******************
diff --git a/index.rst b/index.rst
@@ -12,4 +12,4 @@ A first public version of Umi was released during a public symposium on Sustaina
    Getting Started <docs/first.md>
    docs/examples/_examples
    Building Templates <docs/archetypes.md>
-   Template Details <docs/template-detail.rst>
+   Template Details <docs/template-info/_template-detail.rst>