Skip to content
This repository was archived by the owner on Jan 10, 2024. It is now read-only.

Commit

Permalink
Move landing page into Docs directory and generate documenation manua…
Browse files Browse the repository at this point in the history
…l as a subdirectory.
  • Loading branch information
jrood-nrel committed Feb 4, 2021
1 parent b8359db commit e53991b
Show file tree
Hide file tree
Showing 82 changed files with 3,037 additions and 52 deletions.
6 changes: 2 additions & 4 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,11 @@ on:
branches: [development]
paths:
- 'Docs/**'
- 'README.rst'
- '.github/workflows/docs.yml'
pull_request:
branches: [development]
paths:
- 'Docs/**'
- 'README.rst'
- '.github/workflows/docs.yml'

jobs:
Expand Down Expand Up @@ -41,12 +39,12 @@ jobs:
echo "::remove-matcher owner=sphinx-problem-matcher-loose-no-severity::"
echo "::remove-matcher owner=sphinx-problem-matcher-loose::"
echo "::remove-matcher owner=sphinx-problem-matcher::"
touch ${{runner.workspace}}/build-docs/source/html/.nojekyll
touch ${{runner.workspace}}/build-docs/html/manual/html/.nojekyll
- name: Deploy
if: github.event_name == 'push' && github.ref == 'refs/heads/development'
uses: JamesIves/github-pages-deploy-action@releases/v3
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages
FOLDER: ${{runner.workspace}}/build-docs/source/html
FOLDER: ${{runner.workspace}}/build-docs/html
SINGLE_COMMIT: true
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,3 @@ grdlog

tempAscii.txt
Transient_Sl.txt
*.png
10 changes: 7 additions & 3 deletions Docs/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,13 @@ find_package(Sphinx REQUIRED)
#find_package(Doxygen)

add_custom_target(sphinx ALL
COMMAND ${SPHINX_EXECUTABLE} -M html
"${CMAKE_CURRENT_SOURCE_DIR}/source" "${CMAKE_CURRENT_BINARY_DIR}/source"
-c ${CMAKE_CURRENT_SOURCE_DIR}/source)
COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/html
COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/source/landing
${CMAKE_BINARY_DIR}/html
COMMAND ${SPHINX_EXECUTABLE} -M html "${CMAKE_SOURCE_DIR}/source/manual"
"${CMAKE_BINARY_DIR}/html/manual"
-c ${CMAKE_SOURCE_DIR}/source/manual
)

#if(DOXYGEN_FOUND)
# configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxygen/Doxyfile.in Doxyfile @ONLY)
Expand Down
6 changes: 3 additions & 3 deletions Docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = source
BUILDDIR = build
SOURCEDIR = source/manual
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
Expand All @@ -16,4 +16,4 @@ help:
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
4 changes: 4 additions & 0 deletions Docs/source/landing/css/font-awesome.min.css

Large diffs are not rendered by default.

247 changes: 247 additions & 0 deletions Docs/source/landing/css/skel.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,247 @@
/* Resets (http://meyerweb.com/eric/tools/css/reset/ | v2.0 | 20110126 | License: none (public domain)) */

html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,a,abbr,acronym,address,big,cite,code,del,dfn,em,img,ins,kbd,q,s,samp,small,strike,strong,sub,sup,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li,fieldset,form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td,article,aside,canvas,details,embed,figure,figcaption,footer,header,hgroup,menu,nav,output,ruby,section,summary,time,mark,audio,video{margin:0;padding:0;border:0;font-size:100%;font:inherit;vertical-align:baseline;}article,aside,details,figcaption,figure,footer,header,hgroup,menu,nav,section{display:block;}body{line-height:1;}ol,ul{list-style:none;}blockquote,q{quotes:none;}blockquote:before,blockquote:after,q:before,q:after{content:'';content:none;}table{border-collapse:collapse;border-spacing:0;}body{-webkit-text-size-adjust:none}

/* Box Model */

*, *:before, *:after {
-moz-box-sizing: border-box;
-webkit-box-sizing: border-box;
box-sizing: border-box;
}

/* Container */

.container {
margin-left: auto;
margin-right: auto;

/* width: (containers) */
width: 1200px;
}

/* Modifiers */

/* 125% */
.container.\31 25\25 {
width: 100%;

/* max-width: (containers * 1.25) */
max-width: 1500px;

/* min-width: (containers) */
min-width: 1200px;
}

/* 75% */
.container.\37 5\25 {

/* width: (containers * 0.75) */
width: 900px;

}

/* 50% */
.container.\35 0\25 {

/* width: (containers * 0.50) */
width: 600px;

}

/* 25% */
.container.\32 5\25 {

/* width: (containers * 0.25) */
width: 300px;

}

/* Grid */

.row {
border-bottom: solid 1px transparent;
}

.row > * {
float: left;
}

.row:after, .row:before {
content: '';
display: block;
clear: both;
height: 0;
}

.row.uniform > * > :first-child {
margin-top: 0;
}

.row.uniform > * > :last-child {
margin-bottom: 0;
}

/* Gutters */

/* Normal */

.row > * {
/* padding: (gutters.horizontal) 0 0 (gutters.vertical) */
padding: 0 0 0 2em;
}

.row {
/* margin: -(gutters.horizontal) 0 -1px -(gutters.vertical) */
margin: 0 0 -1px -2em;
}

.row.uniform > * {
/* padding: (gutters.vertical) 0 0 (gutters.vertical) */
padding: 2em 0 0 2em;
}

.row.uniform {
/* margin: -(gutters.vertical) 0 -1px -(gutters.vertical) */
margin: -2em 0 -1px -2em;
}

/* 200% */

.row.\32 00\25 > * {
/* padding: (gutters.horizontal) 0 0 (gutters.vertical) */
padding: 0 0 0 4em;
}

.row.\32 00\25 {
/* margin: -(gutters.horizontal) 0 -1px -(gutters.vertical) */
margin: 0 0 -1px -4em;
}

.row.uniform.\32 00\25 > * {
/* padding: (gutters.vertical) 0 0 (gutters.vertical) */
padding: 4em 0 0 4em;
}

.row.uniform.\32 00\25 {
/* margin: -(gutters.vertical) 0 -1px -(gutters.vertical) */
margin: -4em 0 -1px -4em;
}

/* 150% */

.row.\31 50\25 > * {
/* padding: (gutters.horizontal) 0 0 (gutters.vertical) */
padding: 0 0 0 1.5em;
}

.row.\31 50\25 {
/* margin: -(gutters.horizontal) 0 -1px -(gutters.vertical) */
margin: 0 0 -1px -1.5em;
}

.row.uniform.\31 50\25 > * {
/* padding: (gutters.vertical) 0 0 (gutters.vertical) */
padding: 1.5em 0 0 1.5em;
}

.row.uniform.\31 50\25 {
/* margin: -(gutters.vertical) 0 -1px -(gutters.vertical) */
margin: -1.5em 0 -1px -1.5em;
}

/* 50% */

.row.\35 0\25 > * {
/* padding: (gutters.horizontal) 0 0 (gutters.vertical) */
padding: 0 0 0 1em;
}

.row.\35 0\25 {
/* margin: -(gutters.horizontal) 0 -1px -(gutters.vertical) */
margin: 0 0 -1px -1em;
}

.row.uniform.\35 0\25 > * {
/* padding: (gutters.vertical) 0 0 (gutters.vertical) */
padding: 1em 0 0 1em;
}

.row.uniform.\35 0\25 {
/* margin: -(gutters.vertical) 0 -1px -(gutters.vertical) */
margin: -1em 0 -1px -1em;
}

/* 25% */

.row.\32 5\25 > * {
/* padding: (gutters.horizontal) 0 0 (gutters.vertical) */
padding: 0 0 0 0.5em;
}

.row.\32 5\25 {
/* margin: -(gutters.horizontal) 0 -1px -(gutters.vertical) */
margin: 0 0 -1px -0.5em;
}

.row.uniform.\32 5\25 > * {
/* padding: (gutters.vertical) 0 0 (gutters.vertical) */
padding: 0.5em 0 0 0.5em;
}

.row.uniform.\32 5\25 {
/* margin: -(gutters.vertical) 0 -1px -(gutters.vertical) */
margin: -0.5em 0 -1px -0.5em;
}

/* 0% */

.row.\30 \25 > * {
padding: 0;
}

.row.\30 \25 {
margin: 0 0 -1px 0;
}

/* Cells */

.\31 2u, .\31 2u\24 { width: 100%; clear: none; margin-left: 0; }
.\31 1u, .\31 1u\24 { width: 91.6666666667%; clear: none; margin-left: 0; }
.\31 0u, .\31 0u\24 { width: 83.3333333333%; clear: none; margin-left: 0; }
.\39 u, .\39 u\24 { width: 75%; clear: none; margin-left: 0; }
.\38 u, .\38 u\24 { width: 66.6666666667%; clear: none; margin-left: 0; }
.\37 u, .\37 u\24 { width: 58.3333333333%; clear: none; margin-left: 0; }
.\36 u, .\36 u\24 { width: 50%; clear: none; margin-left: 0; }
.\35 u, .\35 u\24 { width: 41.6666666667%; clear: none; margin-left: 0; }
.\34 u, .\34 u\24 { width: 33.3333333333%; clear: none; margin-left: 0; }
.\33 u, .\33 u\24 { width: 25%; clear: none; margin-left: 0; }
.\32 u, .\32 u\24 { width: 16.6666666667%; clear: none; margin-left: 0; }
.\31 u, .\31 u\24 { width: 8.3333333333%; clear: none; margin-left: 0; }

.\31 2u\24 + *,
.\31 1u\24 + *,
.\31 0u\24 + *,
.\39 u\24 + *,
.\38 u\24 + *,
.\37 u\24 + *,
.\36 u\24 + *,
.\35 u\24 + *,
.\34 u\24 + *,
.\33 u\24 + *,
.\32 u\24 + *,
.\31 u\24 + * {
clear: left;
}

.\-11u { margin-left: 91.6666666667% }
.\-10u { margin-left: 83.3333333333% }
.\-9u { margin-left: 75% }
.\-8u { margin-left: 66.6666666667% }
.\-7u { margin-left: 58.3333333333% }
.\-6u { margin-left: 50% }
.\-5u { margin-left: 41.6666666667% }
.\-4u { margin-left: 33.3333333333% }
.\-3u { margin-left: 25% }
.\-2u { margin-left: 16.6666666667% }
.\-1u { margin-left: 8.3333333333% }
5 changes: 5 additions & 0 deletions Docs/source/landing/css/style-large.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/*
Transit by TEMPLATED
templated.co @templatedco
Released for free under the Creative Commons Attribution 3.0 license (templated.co/license)
*/
Loading

0 comments on commit e53991b

Please sign in to comment.