automatic documentation update

germolinal · Nov 28, 2024 · 46d2fc4 · 46d2fc4
1 parent 1fafbd9
commit 46d2fc4
Show file tree

Hide file tree

Showing 11 changed files with 222 additions and 207 deletions.
diff --git a/auto_src/docs/index.html b/auto_src/docs/index.html
@@ -4,6 +4,10 @@
 <head>
     <title>SIMPLE validation report</title>
     <style>
+        code {
+            font-family: 'Courier New', Courier, monospace;
+            font-weight: bold;
+        }
         * {
             font-family: Arial, Helvetica, sans-serif;
         }
@@ -13,6 +17,16 @@
             text-decoration: none;
         }
 
+        a.primary {
+            background-color: #0071e3;
+            color: white;
+            padding: 0.8em 1em;
+            border: none;
+            border-radius: 0.5em;            
+
+            display: inline-block;
+        }
+
         body {
             padding: 1em;
             max-width: 800px;
@@ -38,31 +52,34 @@
 
         ul>li a {
             display: block;
-            padding: 0.6em;            
+            padding: 0.6em;
         }
 
-        ul>li a  h1 {
-            font-size: 1rem;            
+        ul>li a h1 {
+            font-size: 1rem;
         }
-        ul>li a  p {
-            font-size: 0.9rem;            
+
+        ul>li a p {
+            font-size: 0.9rem;
             opacity: 0.6;
         }
+
         .danger {
-            color:red;
+            color: red;
         }
-        ul>li a  p.danger {
-            font-size: 0.8rem;                        
+
+        ul>li a p.danger {
+            font-size: 0.8rem;
         }
+
         li:hover {
             box-shadow: 0 14px 28px rgba(0, 0, 0, 0.25), 0 10px 10px rgba(0, 0, 0, 0.22);
         }
-
     </style>
 </head>
 
 <body>
-    <h1>Welcome to the <code>SIMPLE</code> validation report</h1>
+    <h1>Welcome to <code>SIMPLE</code>'s documentation</h1>
     <p>
         <code>SIMPLE</code> aims to be as reliable and transparent as
         possible. This report is a crucial piece of that effort.
@@ -77,16 +94,13 @@ <h1>Welcome to the <code>SIMPLE</code> validation report</h1>
         ever be deployed.
     </p>
 
-    <h2>Input Output reference</h2>
-    <p>Find it <a href="./ioreference/book/index.html">HERE</a>.</p>
-    <p>
-        This documentation can give you an idea of what is and how
-        <code>SIMPLE</code> works.
-    </p>
+
+    <a class="primary" href="./ioreference/book/index.html">Go to <code>SIMPLE</code>'s user guide</a>
+
 
     <h2>Validation reports</h2>
     <p>
-        We are quite transparent in our efforts to make SIMPLE reliable. We are not 
+        We are quite transparent in our efforts to make SIMPLE reliable. We are not
         perfect, but these are some of the tests we run every time we attempt to publish
         a new verion. Also, this report is updated EVERY TIME we publish a new version.
         Feel free to comment and—if you think you can make the results better—let us know

diff --git a/auto_src/docs/ioreference/src/auto-building.md b/auto_src/docs/ioreference/src/auto-building.md
@@ -1,9 +1,9 @@
 # Building
 
-This object has two purposes. First, it can be utilized to group 
+This object has two purposes. First, it can be utilized to group
 `Space` objects together for metering. Also, there are some
-physical aspects of the the building that can be calculated from 
-some parameters of the building. For example, the `Infiltrations` 
+physical aspects of the the building that can be calculated from
+some parameters of the building. For example, the `Infiltrations`
 can be estimated from the number of storeys
 and the `ShelterClass` (check docs for those).
 

diff --git a/auto_src/docs/ioreference/src/auto-hvac.md b/auto_src/docs/ioreference/src/auto-hvac.md
@@ -4,14 +4,14 @@ A collection of elements heating and cooling systems
 
 ## Example `.spl`
 
-```rs
+```json
 {{ #include ../../../model/tests/scanner/hvac_electric_heater.spl }}
 
 ```
 
 ## Example `.json`
 
-```rs
+```json
 {{ #include ../../../model/tests//scanner/hvac_electric_heater.json }}
 
 ```