Skip to content

Commit

Permalink
Merge pull request #21 from NREL-Sienna/kd/format
Browse files Browse the repository at this point in the history
Format fixes
  • Loading branch information
kdayday authored Dec 24, 2024
2 parents 078df87 + 58cb362 commit 1f7b92b
Show file tree
Hide file tree
Showing 17 changed files with 148 additions and 141 deletions.
6 changes: 4 additions & 2 deletions SiennaDocs/docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import DataStructures: OrderedDict
using SiennaDocs

pages = OrderedDict(
"Documentation Hub" => "index.md",
"Sienna Documentation Hub" => "index.md",
"How-to" => Any["Install Sienna" => "how-to/install.md"],
"Reference" => Any[
"Developers" => ["Developer Guidelines" => "reference/developer_guidelines.md",]
Expand All @@ -13,8 +13,10 @@ pages = OrderedDict(
makedocs(
modules = [SiennaDocs],
format = Documenter.HTML(
sidebar_sitename = false,
prettyurls = haskey(ENV, "GITHUB_ACTIONS"),
size_threshold = nothing,),
size_threshold = nothing,
footer = "Return to the [Sienna homepage](https://nrel-sienna.github.io/Sienna/). Docs powered by [Documenter.jl] (https://github.com/JuliaDocs/Documenter.jl) and the [Julia Programming Language](https://julialang.org/).",),
sitename = "Sienna Documentation Hub",
authors = "Kate Doubleday",
pages = Any[p for p in pages],
Expand Down
Binary file added SiennaDocs/docs/src/assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 6 additions & 5 deletions SiennaDocs/docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# [The Sienna Documentation Hub](@id hub)
# [Sienna Documentation Hub](@id hub)

```@meta
CurrentModule = SiennaDocs
```
## Quick Links

| Sienna\Data | Sienna\Ops | Sienna\Dyn |
| :----------- | :---------- | :---------- |
Expand All @@ -16,16 +17,16 @@ CurrentModule = SiennaDocs

## About

The National Renewable Energy Laboratory's [Sienna ecosystem](https://www.nrel.gov/analysis/sienna.html)
The National Renewable Energy Laboratory's [Sienna ecosystem](https://nrel-sienna.github.io/Sienna/)
is a open source framework for scheduling problems and dynamic simulations for power systems.
Sienna is a modular, extensible platform with three core applications enabled by multiple
packages in the [`Julia`](http://www.julialang.org) programming language:

- [Sienna\Data](https://github.com/NREL-Sienna/Sienna?tab=readme-ov-file#siennadata) enables
- [Sienna\Data](https://nrel-sienna.github.io/Sienna/pages/applications/sienna_data.html) enables
efficient data input, analysis, and transformation
- [Sienna\Ops](https://github.com/NREL-Sienna/Sienna?tab=readme-ov-file#siennaops) enables
- [Sienna\Ops](https://nrel-sienna.github.io/Sienna/pages/applications/sienna_ops.html) enables
enables system scheduling simulations by formulating and solving optimization problems
- [Sienna\Dyn](https://github.com/NREL-Sienna/Sienna?tab=readme-ov-file#siennadyn) enables
- [Sienna\Dyn](https://nrel-sienna.github.io/Sienna/pages/applications/sienna_dyn.html) enables
system transient analysis including small signal stability and full system dynamic
simulations

Expand Down
10 changes: 5 additions & 5 deletions _data/navigation-menu/secondary.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,22 @@ toc:
subfolderitems:

- page: Sienna\Data
url: pages/applications/sienna_data.html
url: /Sienna/pages/applications/sienna_data.html

- page: Sienna\Ops
url: pages/applications/sienna_ops.html
url: /Sienna/pages/applications/sienna_ops.html

- page: Sienna\Dyn
url: pages/applications/sienna_dyn.html
url: /Sienna/pages/applications/sienna_dyn.html

- title: Documentation
subfolderitems:

- page: Documentation
url: SiennaDocs/docs/build/index.html
url: /Sienna/SiennaDocs/docs/build/index.html

- title: Getting Started
subfolderitems:

- page: Installation
url: SiennaDocs/docs/build/how-to/install
url: /Sienna/SiennaDocs/docs/build/how-to/install
6 changes: 3 additions & 3 deletions _data/navigation-menu/sidemenu.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ toc:
subfolderitems:

- page: Sienna\Data
url: sienna_data.html
url: /Sienna/pages/applications/sienna_data.html

- page: Sienna\Ops
url: sienna_ops.html
url: /Sienna/pages/applications/sienna_ops.html

- page: Sienna\Dyn
url: sienna_dyn.html
url: /Sienna/pages/applications/sienna_dyn.html

- title: Documentation
subfolderitems:
Expand Down
27 changes: 4 additions & 23 deletions _data/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,16 @@ name: "Sienna"
description: "Sienna Platform"

# Logo
logo_home_agency: /assets/img/logo8.png
logo_home_studio: /assets/img/logo_13.png
logo_home_freelancer: /assets/img/logo_8.png
logo_home_developer: /assets/img/miles-developer.png
logo_home_blogger: /assets/img/logo_2.png
logo_home_startup: /assets/img/logo_12.png
logo_home_coach: /assets/img/logo_3.png
logo_home_marketingagency: /assets/img/logo_1.png
logo_home_businessconsulting: /Sienna/assets/Sienna-logo-dark.png
logo_home_creativeagency: /assets/img/logo_1.png
logo_home_creativeagency2: /assets/img/miles-agency-white.png
logo_home_portfolio: /assets/img/logo_12.png
logo_home_portfolio2: /assets/img/logo14.png
logo_white: /Sienna/assets/Sienna-logo-white.png
logo_dark: /Sienna/assets/Sienna-logo-dark.png
logo_portfolio: /assets/img/logo13.png

# Logo Pages
logo_about_agency: /Sienna/assets/Sienna-logo-dark.png
logo_about_business: /Sienna/assets/Sienna-logo-white.png
logo_about_me: /Sienna/assets/Sienna-logo-dark.png

# Contact info
contact_settings:
phone_number: "+65-3002 56 56 376"
email: "miles.studio@gmail.com"
mailto: "mailto:miles.studio@gmail.com"
address1: "90 Fairground Rd, FL 3290, United States"

phone_number: "(+1) 303-275-3000"
email: "sienna@nrel.gov"
mailto: "mailto:sienna@nrel.gov"
address1: "15013 Denver West Parkway Golden, CO 80401"

# Footer info
footer_settings:
Expand Down
8 changes: 0 additions & 8 deletions _includes/header/header-consulting.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,7 @@
</nav>
<!--nav end-->

<button class="nav-toggle-btn a-nav-toggle">
<span class="nav-toggle nav-toggle-sm">
<span class="stick stick-1"></span>
<span class="stick stick-2"></span>
<span class="stick stick-3"></span>
</span>
</button>
</div>
<!--header-content-v8 end-->
</div>
</header>
{% include sidemenu.html %}
44 changes: 27 additions & 17 deletions _includes/header/header-default.html
Original file line number Diff line number Diff line change
@@ -1,25 +1,35 @@
<header>
<div class="container-fluid">
<div class="header-content d-flex flex-wrap align-items-center">
<div class="logo">
<a href="/Sienna/" title=""><img src="{{site.baseurl}}/assets/Sienna-logo-white.png" alt="" /></a>
<header class="header-v6">
<div class="container">
<div class="header-content-v8">
<div class="logo-v8">
<a href="/Sienna/" title=""><img src="{{site.data.settings.logo_dark}}" alt=""></a>
</div>
<!--logo end-->
<div class="mile-right ms-auto">
<button class="nav-toggle-btn a-nav-toggle ms-auto">
<span class="nav-toggle-title">Menu</span>
<span class="nav-toggle nav-toggle-sm">
<span class="stick stick-1"></span>
<span class="stick stick-2"></span>
<span class="stick stick-3"></span>
</span>
</button>

</div>
<nav>
<ul>
{% for item in site.data.navigation-menu.secondary.toc %}
<li>
<a href="#" title="">{{ item.title }}</a>
<ul>
{% for entry in item.subfolderitems %}
<li>
<a
href="{{ entry.url }}"
title="{{ entry.page }}"
class="{% if item.url == page.url %}active{% endif %}"
>{{ entry.page }}</a
>
</li>
{% endfor %}
</ul>
</li>
{% endfor %}
</ul>
</nav>
<!--nav end-->
<!--mile-right end-->
</div>
<!--header-content end-->
</div>
</header>
<!--header end-->
{% include sidemenu.html %}
8 changes: 1 addition & 7 deletions _includes/sidemenu.html
Original file line number Diff line number Diff line change
@@ -1,16 +1,10 @@
<div class="responsive-menu">
<div class="rep-header">
<div class="rep-logo">
<img src="{{site.baseurl}}/assets/Sienna-logo-white.png" alt="" />
<img src="{{site.baseurl}}/assets/Sienna-logo-white-bg.png" alt="" />
</div>
<a href="#" title="" class="close-menu"><i class="lni lni-close"></i></a>
</div>
<div class="search-box">
<form>
<input type="text" name="search" placeholder="Search" />
<button type="submit"><i class="lni lni-search-alt"></i></button>
</form>
</div>
<ul class="mobile-menu">
{% for item in site.data.navigation-menu.sidemenu.toc %}
<li>
Expand Down
Binary file added assets/Sienna-Data-info-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/Sienna-Dyn-info-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/Sienna-Ops-info-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/Sienna-logo-white-bg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 1f7b92b

Please sign in to comment.