Merge pull request #1 from jrcain-usgs/docs

Docs
jrcain-usgs · Sep 7, 2023 · df2e391 · df2e391
2 parents 083bf0c + ef5f95a
commit df2e391
Show file tree

Hide file tree

Showing 15 changed files with 31,078 additions and 4 deletions.
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
@@ -0,0 +1,34 @@
+name: build-docs
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+jobs:
+  build-docs-job:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash -el {0}
+    steps:
+      - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9
+      - uses: conda-incubator/setup-miniconda@3b0f2504dd76ef23b6d31f291f4913fb60ab5ff3
+        with:
+          miniconda-version: "latest"
+          activate-environment: knoten-docs
+          environment-file: docs/environment.yml
+          auto-activate-base: false
+          auto-update-conda: true
+
+      - name: Check doc build environment
+        run: |
+          conda list
+
+      - name: Build Docs
+        run: |
+          cd docs
+          sphinx-build -b html . public
diff --git a/.github/workflows/deploy-docs-aws.yml b/.github/workflows/deploy-docs-aws.yml
@@ -0,0 +1,46 @@
+name: deploy-docs-aws
+
+on:
+  workflow_run:
+    workflows: ["build-docs"]
+    branches:
+      - main
+    types: 
+      - completed
+
+jobs:
+  deploy-docs-aws-job-test:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash -el {0}
+    steps:
+      - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9
+      - uses: conda-incubator/setup-miniconda@3b0f2504dd76ef23b6d31f291f4913fb60ab5ff3
+        with:
+          miniconda-version: "latest"
+          activate-environment: knoten-docs
+          environment-file: docs/environment.yml
+          auto-activate-base: false
+          auto-update-conda: true
+
+      - name: Check doc build environment
+        run: |
+          conda list
+
+      - name: Build Docs
+        run: |
+          cd docs
+          sphinx-build -b html . public
+            
+      - name: Set AWS credentials for upload
+        uses: aws-actions/configure-aws-credentials@0e613a0980cbf65ed5b322eb7a1e075d28913a83
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: us-west-2
+
+      - name: Upload to S3
+        working-directory: docs
+        run: aws s3 sync --delete public s3://asc-docs/knoten
diff --git a/docs/_static/common.css b/docs/_static/common.css
@@ -0,0 +1,272 @@
+@charset "UTF-8";
+/* CSS Document */
+
+footer, #navbar {
+	font-family: 'Source Sans Pro',sans-serif;
+	margin: 0;
+	position: relative;
+}
+
+*, *:before, *:after {
+    -webkit-box-sizing: border-box;
+    -moz-box-sizing: border-box;
+    box-sizing: border-box;
+}	
+
+footer, header, main, nav, div {
+    display: block;
+}
+
+.tmp-container {
+	margin-right: auto;
+    margin-left: auto;
+    padding-left: 15px;
+    padding-right: 15px;
+}
+
+.tmp-container a {
+	text-decoration: none;
+    background: transparent;
+}
+.tmp-container a:-webkit-any-link {
+    cursor: auto;
+}
+.tmp-container:before, .tmp-container:after {
+    content: " ";
+    display: table;
+}
+.tmp-container:after {
+    clear: both;
+}
+
+hr {
+	width: 100%; 
+	margin-top: 42px;
+	clear: both;
+}
+@media only screen and (max-width:490px) {
+    hr {
+    margin-top: 60px;
+    }
+}
+
+/* header (only) nav */
+.header-nav {
+	background: #00264c;
+}
+
+.logo-header img {
+	margin-top: 8px;
+	margin-bottom: 8px;
+	border: 0;
+	max-width: 100%;
+	height: auto;
+}
+
+.header-search form {
+  float: right;
+  width: auto;
+  padding-top: 0;
+  padding-bottom: 0;
+  margin-right: 0;
+  margin-left: 0;
+  border: 0;
+  -webkit-box-shadow: none;
+          box-shadow: none;
+}
+
+.header-search input[type="search"] {
+	height: 30px;
+	width: 260px;
+	margin-top: 18px;
+}
+.header-search button[type="submit"] {
+	position: absolute;
+	top: 0;
+	bottom: 0;
+	right: 15px;
+	border: 0;
+	color: #666;
+	background: transparent;
+	padding: 0;
+	width: 39px;
+	height: 39px;
+	margin-top: 21px;
+}
+
+input{line-height:normal}
+input[type="search"]{-webkit-appearance:textfield;-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box}
+input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}
+input,button{font-family:inherit;font-size:inherit;line-height:inherit}
+
+
+/* Always float the navbar header */
+.navbar-header {
+  float: left;
+}
+
+/* footer (only) css */
+
+.menu.nav {
+    margin-bottom: 0;
+    padding-left: 0;
+    list-style: none;
+}
+
+.nav:before, .nav:after {
+   content: none;
+}
+footer.footer {
+	background: #00264c;
+	padding-bottom: 0px;
+	position: relative;
+	width: 100%;
+	border-top: 1px solid #E5E5E5;
+}
+
+footer.footer .footer-doi {
+	padding-right: 0;
+	padding-left: 0;
+}
+
+footer.footer .footer-doi ul.menu li a {
+    padding: 5px 0px;
+    color: #ffffff;
+    float: left;
+    font-size: 12px;
+}
+
+footer.footer .footer-doi ul.menu li:first-of-type {
+    padding-left: 0px;
+}
+
+footer.footer .footer-doi ul.menu li {
+    float: left;
+    padding-right: 2px;
+    padding-left: 5px;
+}
+
+footer.footer .footer-doi ul.menu li:after {
+    content: "|";
+    color: #ffffff;
+    float: left;
+    padding-top: 5px;
+    padding-left: 7px;
+    font-size: 12px;
+}
+
+footer.footer .footer-doi ul.menu li:last-child:after {
+    content: "";
+}
+
+footer.footer .footer-wrap .menu.nav a {
+	padding: 4px 0px;
+	color: #ffffff;
+	font-size: 12px;
+}
+
+footer.footer .footer-social-links {
+	color: #ffffff;
+	font-size: 12px;
+	padding-right: 0;
+}
+
+footer.footer .footer-social-links ul {
+    float: right;
+	margin-top: 0px;
+}
+
+footer.footer .footer-social-links ul li.follow {
+    padding-top: 6px;
+    padding-right: 5px;
+}
+
+footer.footer .footer-social-links ul li {
+    float: left;
+    height: 24px;
+    margin: 0 2px;
+    list-style: none;
+    list-style-type: none;
+}
+
+footer.footer .footer-social-links ul li:last-of-type {
+    margin-right: 0px;
+}
+
+footer.footer .footer-social-links ul li a i {
+	color:#fff;
+	font-size: 24px;
+}
+
+/* Font Awesome Social Media icons */
+/*!
+ *  Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome
+ *  License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License)
+ */
+/* FONT PATH
+ * -------------------------- */
+@font-face {
+  font-family: 'FontAwesome';
+  src: url('../fonts/fontawesome-webfont.eot');
+  src: url('../fonts/fontawesome-webfont.eot') format('embedded-opentype'), url('../fonts/fontawesome-webfont.woff2') format('woff2'), url('../fonts/fontawesome-webfont.woff') format('woff'), url('../fonts/fontawesome-webfont.ttf') format('truetype'), url('../fonts/fontawesome-webfont.svg') format('svg');
+  font-weight: normal;
+  font-style: normal;
+}
+.fa-wrapper {
+	position: relative
+}
+.fa {
+  display: inline-block;
+  font: normal normal normal 14px/1 FontAwesome;
+  font-size: inherit;
+  text-rendering: auto;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+}
+.fa-ul {
+  padding-left: 0;
+  margin-left: 2.14285714em;
+  list-style-type: none;
+}
+.fa-ul > li {
+  position: relative;
+}
+.fa-li {
+  position: absolute;
+  left: -2.14285714em;
+  width: 2.14285714em;
+  top: 0.14285714em;
+  text-align: center;
+}
+.fa-search:before {
+	content: "\f002";
+}
+.fa-twitter-square:before {
+Content: "\f081";
+}
+.fa-facebook-square:before {
+Content: "\f082";
+}
+.fa-github:before {
+    content: "\f09b";
+}
+.fa-flickr:before {
+	content: "\f16e";
+}
+.fa-youtube-play:before {
+    content: "\f16a";
+}
+.fa-instagram:before {
+    content: "\f16d";
+}
+.only {
+  position: absolute;
+  width: 1px;
+  height: 1px;
+  padding: 0;
+  margin: -1px;
+  overflow: hidden;
+  clip: rect(0, 0, 0, 0);
+  border: 0;
+}
+[role="button"]{cursor:pointer}