Heading and toctree reorganization

MITSustainableDesignLab · Nov 15, 2017 · 0c38ae8 · 0c38ae8
1 parent d6e8c4e
commit 0c38ae8
Show file tree

Hide file tree

Showing 9 changed files with 82 additions and 52 deletions.
diff --git a/docs/template-info/Constructions/_constructions.rst b/docs/template-info/Constructions/_constructions.rst
@@ -0,0 +1,11 @@
+
+Constructions documentation
+===========================
+
+This section provide details on the template files
+
+.. toctree::
+   :hidden:
+   :glob:
+
+   constructions.rst
diff --git a/docs/template-info/Constructions/constructions.rst b/docs/template-info/Constructions/constructions.rst
@@ -1,10 +1,9 @@
 
--------------------------------
 Opaque Construction Description
 -------------------------------
 
 Opaque assembly
-===============
+```````````````
 
 .. todo::
    This section should explain how a Construction element is created from multiple material layers
@@ -14,7 +13,7 @@ Opaque assembly
 
 
 Window assembly
-===============
+```````````````
 
 .. todo::
    This section should explain how a Window element is created from multiple material layers
@@ -24,7 +23,7 @@ Window assembly
 
 
 Structure assembly
-==================
+``````````````````
 
 .. todo::
    This section should explain how a Structure element is created from multiple material layers

diff --git a/docs/template-info/Materials/_materials.rst b/docs/template-info/Materials/_materials.rst
@@ -0,0 +1,12 @@
+
+Materials documentation
+=======================
+
+This section provide details on the template files
+
+.. toctree::
+   :hidden:
+   :glob:
+
+   opaque.rst
+   glazing.rst
diff --git a/docs/template-info/Materials/glazing.rst b/docs/template-info/Materials/glazing.rst
@@ -1,13 +1,12 @@
 
-----------------------------
 Glazing material description
-----------------------------
+============================
 
 .. index:: Conductivity
 .. _g_conductivity:
 
 Conductivity
-============
+------------
 
 .. todo::
    Section to be written
@@ -16,7 +15,7 @@ Conductivity
 .. _g_cost:
 
 Cost
-====
+----
 
 .. todo::
    Section to be written
@@ -26,7 +25,7 @@ Cost
 .. _g_density:
 
 Density
-=======
+-------
 
 .. todo::
    Section to be written
@@ -36,7 +35,7 @@ Density
 .. _g_embodied-carbon:
 
 Embodied Carbon
-===============
+---------------
 
 .. todo::
    Section to be written
@@ -46,7 +45,7 @@ Embodied Carbon
 .. _g_embodied-energy:
 
 Embodied Energy
-===============
+---------------
 
 .. todo::
    Section to be written
@@ -56,7 +55,7 @@ Embodied Energy
 .. _g_substitution-rate-pattern:
 
 Substitution Rate Pattern
-=========================
+-------------------------
 
 .. todo::
    Section to be written
@@ -66,7 +65,7 @@ Substitution Rate Pattern
 .. _g_substitution-timestep:
 
 Substitution Timestep
-=====================
+---------------------
 
 .. todo::
    Section to be written
@@ -76,7 +75,7 @@ Substitution Timestep
 .. _g_transportation-carbon:
 
 Transportation Carbon
-=====================
+---------------------
 
 .. todo::
    Section to be written
@@ -86,7 +85,7 @@ Transportation Carbon
 .. _g_transportation-distance:
 
 Transportation Distance
-=======================
+-----------------------
 
 .. todo::
    Section to be written
@@ -96,7 +95,7 @@ Transportation Distance
 .. _g_transportation-energy:
 
 Transportation Energy
-=====================
+---------------------
 
 .. todo::
    Section to be written
@@ -106,7 +105,7 @@ Transportation Energy
 .. _g_dirt-factor:
 
 Dirt Factor
-===========
+-----------
 
 .. todo::
    Section to be written
@@ -116,7 +115,7 @@ Dirt Factor
 .. _g_back-side-ir-emissivity:
 
 Back-side IR Emissivity
-=======================
+-----------------------
 
 .. todo::
    Section to be written
@@ -126,7 +125,7 @@ Back-side IR Emissivity
 .. _g_front-side-ir-emissivity:
 
 Front-side IR Emissivity
-========================
+------------------------
 
 .. todo::
    Section to be written
@@ -136,7 +135,7 @@ Front-side IR Emissivity
 .. _g_ir-transmittance:
 
 IR Transmittance
-================
+----------------
 
 .. todo::
    Section to be written
@@ -146,7 +145,7 @@ IR Transmittance
 .. _g_back-side-solar-reflectance:
 
 Back-side Solar Reflectance
-===========================
+---------------------------
 
 .. todo::
    Section to be written
@@ -156,7 +155,7 @@ Back-side Solar Reflectance
 .. _g_front-side-solar-reflectance:
 
 Front-side Solar Reflectance
-============================
+----------------------------
 
 .. todo::
    Section to be written
@@ -166,7 +165,7 @@ Front-side Solar Reflectance
 .. _g_solar-transmittance:
 
 Solar Transmittance
-===================
+-------------------
 
 .. todo::
    Section to be written
@@ -176,7 +175,7 @@ Solar Transmittance
 .. _g_back-side-visible-reflectance:
 
 Back-side Visible Reflectance
-=============================
+-----------------------------
 
 .. todo::
    Section to be written
@@ -186,7 +185,7 @@ Back-side Visible Reflectance
 .. _g_front-side-visible-reflectance:
 
 Front-side Visible Reflectance
-==============================
+------------------------------
 
 .. todo::
    Section to be written
@@ -196,7 +195,7 @@ Front-side Visible Reflectance
 .. _g_visible-transmittance:
 
 Visible Transmittance
-=====================
+---------------------
 
 .. todo::
    Section to be written
diff --git a/docs/template-info/Materials/opaque.rst b/docs/template-info/Materials/opaque.rst
@@ -1,13 +1,12 @@
 
----------------------------
 Opaque material description
----------------------------
+===========================
 
 .. index:: Conductivity
 .. _conductivity:
 
 Conductivity
-============
+------------
 
 .. todo::
    Section to be written
@@ -17,7 +16,7 @@ Conductivity
 .. _cost:
 
 Cost
-====
+----
 
 .. todo::
    Section to be written
@@ -27,7 +26,7 @@ Cost
 .. _density:
 
 Density
-=======
+-------
 
 .. todo::
    Section to be written
@@ -37,7 +36,7 @@ Density
 .. _embodied-carbon:
 
 Embodied Carbon
-===============
+---------------
 
 .. todo::
    Section to be written
@@ -47,7 +46,7 @@ Embodied Carbon
 .. _embodied-energy:
 
 Embodied Energy
-===============
+---------------
 
 .. todo::
    Section to be written
@@ -57,7 +56,7 @@ Embodied Energy
 .. _substitution-rate-pattern:
 
 Substitution Rate Pattern
-=========================
+-------------------------
 
 .. todo::
    Section to be written
@@ -67,7 +66,7 @@ Substitution Rate Pattern
 .. _substitution-timestep:
 
 Substitution Timestep
-=====================
+---------------------
 
 .. todo::
    Section to be written
@@ -77,7 +76,7 @@ Substitution Timestep
 .. _transportation-carbon:
 
 Transportation Carbon
-=====================
+---------------------
 
 .. todo::
    Section to be written
@@ -87,7 +86,7 @@ Transportation Carbon
 .. _transportation-distance:
 
 Transportation Distance
-=======================
+-----------------------
 
 .. todo::
    Section to be written
@@ -97,7 +96,7 @@ Transportation Distance
 .. _transportation-energy:
 
 Transportation Energy
-=====================
+---------------------
 
 .. todo::
    Section to be written
@@ -107,7 +106,7 @@ Transportation Energy
 .. _moisture-diffusion-resistance:
 
 Moisture Diffusion Resistance
-=============================
+-----------------------------
 
 .. todo::
    Section to be written
@@ -117,7 +116,7 @@ Moisture Diffusion Resistance
 .. _roughness:
 
 Roughness
-=========
+---------
 
 .. todo::
    Section to be written
@@ -127,7 +126,7 @@ Roughness
 .. _solar-absorptance:
 
 Solar Absorptance
-=================
+-----------------
 
 .. todo::
    Section to be written
@@ -137,7 +136,7 @@ Solar Absorptance
 .. _specific-heat:
 
 Specific Heat
-=============
+-------------
 
 .. todo::
    Section to be written
@@ -147,7 +146,7 @@ Specific Heat
 .. _thermal-emittance:
 
 Thermal Emittance
-=================
+-----------------
 
 .. todo::
    Section to be written
@@ -157,7 +156,7 @@ Thermal Emittance
 .. _visible-absorptance:
 
 Visible Absorptance
-===================
+-------------------
 
 .. todo::
    Section to be written