docs(projectinfo): Add a webpage for schema documentation

ladybug-tools · Feb 1, 2024 · 0fd85f9 · 0fd85f9
1 parent 8c79b83
commit 0fd85f9
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 1 deletion.
diff --git a/docs.py b/docs.py
@@ -6,7 +6,7 @@
 from honeybee_schema.energy.simulation import SimulationParameter
 from honeybee_schema.validation import ValidationReport
 from honeybee_schema.comparison import ComparisonReport, SyncInstructions
-from honeybee_schema.project_info import ProjectInfo
+from honeybee_schema.projectinfo import ProjectInfo
 
 import json
 import argparse

diff --git a/docs/index.html b/docs/index.html
@@ -64,6 +64,7 @@
   <a href="./model.html">Model Schema</a><br>
   <a href="./simulation-parameter.html">Energy Simulation Parameter Schema</a><br>
   <a href="./validation-report.html">Validation Report Schema</a><br>
+  <a href="./project-info.html">Project Information Schema</a><br>
   <a href="./comparison-report.html">Comparison Report Schema</a><br>
   <a href="./sync-instructions.html">Sync Instructions Schema</a><br>
 </div>

diff --git a/docs/project-info.html b/docs/project-info.html
@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>Honeybee Project Info Schema</title>
+<!-- needed for adaptive design -->
+<meta charset="utf-8"/>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+
+<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
+
+<link rel="shortcut icon" href="https://github.com/ladybug-tools/artwork/raw/master/icons_bugs/ico/honeybee.ico">
+<style>
+  body {
+    margin: 0;
+    padding: 0;
+  }
+</style>
+</head>
+<body>
+<redoc spec-url="./project-information.json"></redoc>
+<script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
+</body>
+</html>
diff --git a/honeybee_schema/project_info.py → honeybee_schema/projectinfo.py b/honeybee_schema/project_info.py → honeybee_schema/projectinfo.py