Merge pull request lbl-srg#67 from lbl-srg/issue66_obc_icon

Issue66 obc icon

specification/generate_cdl_from_modelica.py

@@ -121,6 +121,6 @@ def run_simulation(worDir, cmd):
 shutil.copytree(os.path.join(TMP, "CDL", "Resources", "Images"), os.path.join(html_output_dir, "Resources", "Images"))
 
 # Move image with logo
-shutil.copy2(os.path.join("source", "_static", "cdl-logo.png"), os.path.join(html_output_dir, "Resources", "www", "library-logo.png"))
+shutil.copy2(os.path.join("source", "_static", "obc-logo.png"), os.path.join(html_output_dir, "Resources", "www", "library-logo.png"))
 
 print("HTML documentation is in {}".format(html_output_dir))

specification/source/_static/custom.css

@@ -1,14 +1,13 @@
 html{
-  background-color: #f8f8f8;
+  background-color: #f0f0f0;
   color: #022e4d;
   font-family: "Helvetica Neue", Helvetica, Verdana, sans-serif;
   /*padding: 10px;*/
-  background-color: #BFD1D4;
 }
 body{
   color: #022e4d;
-  border-radius: 4px;
-  box-shadow: 2px -2px 5px 0px rgba(0,0,0,0.4);
+  border-radius: 0px;
+  /*box-shadow: 2px -2px 5px 0px rgba(0,0,0,0.4);*/
 }
 
 .starter-template {
@@ -18,33 +17,36 @@ body{
 
 .navbar-toggle{
     right: 0px;
-    top: 5px;
+    top: 80px;
 }
 .navbar {
-    height: 82px;
-    max-height: 82px;
-/*    border: none;*/
+    height: 132px;
+    max-height: 132px;
+    background-color: #f0f0f0;
+    /*border: none;*/
+    border-radius: 0px;
     -webkit-user-select:none;
     -moz-user-select:none;
-    -ms-user-select:none;user-select:none;
+    -ms-user-select:none;
+    user-select:none;
 }
 
 .navbar .navbar-nav{
-  background: #f8f8f8;
   margin-bottom: 0px;
   margin-left: -20px;
 }
 
 
 .navbar .navbar-nav > input.form-control{
    position: absolute;
-   top: 30px;
+   top: 100px;
    right: 0;
 }
 
 /* ---------------------------------- */
 .navbar .navbar-nav > li > a{
     color: #750000;
+    background-color: #f0f0f0;
     padding-top: 5px;
     padding-bottom: 5px;
     text-decoration: none;
@@ -67,27 +69,27 @@ body{
 .navbar-collapse{
   border-style: none;
   position: absolute;
-  top: 50px;
+  top: 100px;
   z-index: 100;
 }
 /* ---------------------------------- */
 
 
 .navbar > .container-fluid .navbar-brand > img{
    position: absolute;
-   left: 10px;
-   height: 30px;
+   left: 30px;
+   height: 80px;
 }
 
 .footer{
 /*  background-color: white;
   border-color: white; */
-  background-color: #f8f8f8;
+  background-color: #f0f0f0;
   padding: 10px;
   font-size: 75%;
   border-width:0px;
   background-image: none;
-  border-radius: 4px;
+  border-radius: 0px;
 
 }
 .footer .narrow{
@@ -122,7 +124,7 @@ color: #750000;
 #markdown-toc{
     border: 0;
     color: #750000;
-    background-color: #f8f8f8;
+    background-color: #f0f0f0;
 }
 
 
@@ -161,7 +163,7 @@ blockquote{
 
 
 span.pre{
-  background-color: #f8f8f8;
+  background-color: #f0f0f0;
   border: none;
 }
 

specification/source/_static/sphinxdoc.css

@@ -229,7 +229,7 @@ pre {
     line-height: 120%;
     padding: 0.5em;
     border: 1px solid #ccc;
-    background-color: #f8f8f8;
+    background-color: #f0f0f0;
 }
 
 pre a {
@@ -242,15 +242,15 @@ td.linenos pre {
 }
 
 div.quotebar {
-    background-color: #f8f8f8;
+    background-color: #f0f0f0;
     max-width: 250px;
     float: right;
     padding: 2px 7px;
     border: 1px solid #ccc;
 }
 
 div.topic {
-    background-color: #f8f8f8;
+    background-color: #f0f0f0;
 }
 
 table {

specification/source/conf.py

@@ -51,7 +51,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'Open Building Control'
+project = u'OpenBuildingControl'
 copyright = u'(c) All rights reserved'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -112,7 +112,7 @@
 html_theme = 'bootstrap'
 html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
 print("*********** {}".format(html_theme_path))
-html_logo = '_static/cdl-logo.png'
+html_logo = '_static/obc-logo.png'
 # Theme options are theme-specific and customize the look and feel of a
 # theme further.
 html_theme_options = {
@@ -199,7 +199,7 @@
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-html_title = "Control Description Language"
+html_title = "OpenBuildingControl"
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None
@@ -282,7 +282,7 @@
 latex_documents = [
   ('index',
    'obc_report.tex',
-   u'Control Description Language',
+   u'OpenBuildingControl',
    '', 'manual'),
 ]
 
@@ -303,13 +303,50 @@
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-latex_logo = '_static/cdl-logo.png'
+latex_logo = '_static/obc-logo.png'
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
 latex_use_parts = False
 
 # Additional stuff for the LaTeX preamble.
+
+
+latex_elements['maketitle'] = r'''
+\begin{titlepage}
+\begin{minipage}{\headwidth}
+%%\begin{flushright}
+\includegraphics[scale=0.2]{../../source/_static/obc-logo.pdf}
+\hspace{3cm}
+\includegraphics[scale=0.4]{../../source/_static/lbl-text.pdf}
+%%\end{flushright}
+\begin{flushright}
+\hrulefill
+\\[50mm]
+\Large\sffamily\bfseries{Working Report}\\
+\Large\sffamily\bfseries{~}
+\\
+%%\hrulefill
+~\\[10mm]
+\end{flushright}
+\begin{center}
+~\\[50mm]
+\large{https://github.com/lbl-srg/obc}
+~\\[10mm]
+\large{\today}
+\\[10mm]
+\end{center}
+\hrule
+~\\[2mm]
+Copyright (c) 2017-2020\\
+The Regents of the University of California
+(through Lawrence Berkeley National Laboratory),\\
+subject to receipt of any required approvals from U.S. Department of Energy.\\
+All rights reserved.
+\end{minipage}
+\end{titlepage}
+'''
+
 latex_elements['preamble'] = r'''
 % The pdf output has too large picture compared to the html output.
 % The next statement reduces the figure size
@@ -488,6 +525,7 @@
 
 '''
 
+
 def setup(app):
     app.add_stylesheet('basic.css')
     app.add_stylesheet('pygments.css')

specification/source/preample.rst

@@ -8,10 +8,11 @@ Preamble
 Purpose of the Document
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-This document describes the process workflow,
-use cases, requirements and
-specification of the Control Description Language (CDL).
-It also describes a case study that illustrates the use of CDL for
+This document describes the development of the
+Control Description Language (CDL)
+that is being developed within the OpenBuildingControl project.
+It also describes the process workflow,
+use cases and requirements, as well as a case study that illustrates the use of CDL for
 performance comparison of a control sequence during design.
 
 The document is a working document that is used as a discussion basis