Skip to content

Commit

Permalink
deploy: eab294f
Browse files Browse the repository at this point in the history
  • Loading branch information
jwaldrop107 committed Nov 17, 2023
1 parent a7edf65 commit 8ea24a4
Show file tree
Hide file tree
Showing 85 changed files with 14,278 additions and 14,755 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: a805c1e3f7c669b7a3ee929400863528
config: 515b50739eaec6e9d66c074d012fa749
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file removed _images/architecture.png
Binary file not shown.
331 changes: 98 additions & 233 deletions _sources/continuous_deployment/ci_maintainer_notes.rst.txt

Large diffs are not rendered by default.

18 changes: 0 additions & 18 deletions _sources/continuous_deployment/documentation.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -69,21 +69,3 @@ provided in ``CMakeLists.txt``, in lowercase. It can be linked to in your main
(substituting in the project name for the first ``x``. When Sphinx is run the
index of the resulting documentation will be located at
``docs/build/html/index.html``.

Documentation
=============

Deployment of documentation to GitHub pages assumes that each repo's
documentation is written as outlined in previous section. Additionally:

#. Each repo must have the ``build_docs.sh`` workflow script in it's ``.github``
directory.
#. Repositories should include two YAML files: ``test_docs.yaml`` and
``deploy_docs.yaml`` which can be copy/pasted from this repo's versions and
modified appropriately.
#. With 1 and 2 satisfied, when a user submits a PR ``test_docs.yaml`` will
ensure the documentation builds.
#. Once the PR is merged into master ``deploy_docs.yaml`` will build the
documentation and push it to the repo's ``gh-pages`` branch.
#. GitHub will automatically publish the contents of the ``gh-pages`` branch as
a GitHub pages website, which can be linked to like any other website.
134 changes: 0 additions & 134 deletions _static/_sphinx_javascript_frameworks_compat.js

This file was deleted.

16 changes: 11 additions & 5 deletions _static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -222,7 +222,7 @@ table.modindextable td {
/* -- general body styles --------------------------------------------------- */

div.body {
min-width: 360px;
min-width: 450px;
max-width: 800px;
}

Expand All @@ -236,6 +236,7 @@ div.body p, div.body dd, div.body li, div.body blockquote {
a.headerlink {
visibility: hidden;
}

a.brackets:before,
span.brackets > a:before{
content: "[";
Expand All @@ -246,7 +247,6 @@ span.brackets > a:after {
content: "]";
}


h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
Expand Down Expand Up @@ -334,11 +334,13 @@ aside.sidebar {
p.sidebar-title {
font-weight: bold;
}

div.admonition, div.topic, blockquote {
clear: left;
}

/* -- topics ---------------------------------------------------------------- */

div.topic {
border: 1px solid #ccc;
padding: 7px;
Expand Down Expand Up @@ -426,6 +428,10 @@ table.docutils td, table.docutils th {
border-bottom: 1px solid #aaa;
}

table.footnote td, table.footnote th {
border: 0 !important;
}

th {
text-align: left;
padding-right: 5px;
Expand Down Expand Up @@ -608,6 +614,7 @@ ol.simple p,
ul.simple p {
margin-bottom: 0;
}

dl.footnote > dt,
dl.citation > dt {
float: left;
Expand Down Expand Up @@ -636,11 +643,11 @@ dl.field-list > dt {
padding-left: 0.5em;
padding-right: 5px;
}

dl.field-list > dt:after {
content: ":";
}


dl.field-list > dd {
padding-left: 0.5em;
margin-top: 0em;
Expand Down Expand Up @@ -750,7 +757,6 @@ span.pre {
-ms-hyphens: none;
-webkit-hyphens: none;
hyphens: none;
white-space: nowrap;
}

div[class*="highlight-"] {
Expand Down
Loading

0 comments on commit 8ea24a4

Please sign in to comment.