Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(projectinfo): Add a webpage for schema documentation #384

Merged
merged 1 commit into from
Feb 1, 2024
Merged

docs(projectinfo): Add a webpage for schema documentation #384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
23 changes: 23 additions & 0 deletions docs/project-info.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>
0 honeybee_schema/project_info.py → honeybee_schema/projectinfo.py
View file
Open in desktop
File renamed without changes.
Loading