pnnl · RBirmiwal · Nov 7, 2023 · Nov 7, 2023 · Nov 7, 2023 · Nov 7, 2023
diff --git a/.github/workflows/update_docs.yml b/.github/workflows/update_docs.yml
@@ -3,7 +3,7 @@ name: Automate Documentation Build #name of action
 on: #trigger event
   push:
     branches:
-      - master #execute on a push to master branch
+      - bug/gha-docs-fix #execute on a push to master branch
 
 permissions:
   contents: write #grant access to write to master branch
@@ -15,6 +15,8 @@ jobs: #define set of jobs. Here there is only one job, each job is instantiated
 
       # step 1: syntax for telling GHA to use this repository's code as "root" directory. Rest of GHA is able to have access
       - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
       # step 2: #syntax for telling GHA to set-up Python on this runner associated for this whole job
       - uses: actions/setup-python@v3
 
@@ -26,17 +28,22 @@ jobs: #define set of jobs. Here there is only one job, each job is instantiated
       # Step 4: Build docs using sphinx. TZ=UTC needed to circumvent a nuance of running Sphinx on GHA runner
       - name: Sphinx build
         run: |
-          TZ=UTC sphinx-build docs html
+          cd docs 
+          TZ=UTC sphinx-build source build
+          ls
+
 
       # Step 5: Deploy the newly built docs to gh-pages branch
       - name: Deploy to GitHub Pages
         #uses a github action "extension" called actions-gh-pages
         uses: peaceiris/actions-gh-pages@v3
-        if: github.ref == 'refs/heads/master' #ensure that we are on the master branch
-
+        #if: github.ref == 'refs/heads/bug/gha-docs-fix' #ensure that we are on the master branch
+        #fooe
         #following is syntax for using actions-gh-pages action
         with:
           publish_branch: gh-pages
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: html/ #docs to publish to html directory
-          force_orphan: true #common command associated with deploying a GitHub Page
+          publish_dir: docs/build/html
+          keep_files: true 
+
+
diff --git a/docs/.DS_Store b/docs/.DS_Store
diff --git a/docs/Makefile b/docs/Makefile
@@ -5,8 +5,8 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = ../../docs/
+SOURCEDIR     = source
+BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".
 help:

diff --git a/docs/build/.DS_Store b/docs/build/.DS_Store
diff --git a/docs/build/doctrees/activations.doctree b/docs/build/doctrees/activations.doctree
diff --git a/docs/build/doctrees/arg.doctree b/docs/build/doctrees/arg.doctree
diff --git a/docs/build/doctrees/blocks.doctree b/docs/build/doctrees/blocks.doctree
diff --git a/docs/build/doctrees/bounds.doctree b/docs/build/doctrees/bounds.doctree
diff --git a/docs/build/doctrees/callbacks.doctree b/docs/build/doctrees/callbacks.doctree
diff --git a/docs/build/doctrees/component.doctree b/docs/build/doctrees/component.doctree
diff --git a/docs/build/doctrees/constraint.doctree b/docs/build/doctrees/constraint.doctree
diff --git a/docs/build/doctrees/dataset.doctree b/docs/build/doctrees/dataset.doctree
diff --git a/docs/build/doctrees/dynamics.doctree b/docs/build/doctrees/dynamics.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/estimators.doctree b/docs/build/doctrees/estimators.doctree
diff --git a/docs/build/doctrees/gnn.doctree b/docs/build/doctrees/gnn.doctree
diff --git a/docs/build/doctrees/gradients.doctree b/docs/build/doctrees/gradients.doctree
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/integrators.doctree b/docs/build/doctrees/integrators.doctree
diff --git a/docs/build/doctrees/interpolation.doctree b/docs/build/doctrees/interpolation.doctree
diff --git a/docs/build/doctrees/loggers.doctree b/docs/build/doctrees/loggers.doctree
diff --git a/docs/build/doctrees/loss.doctree b/docs/build/doctrees/loss.doctree
diff --git a/docs/build/doctrees/maps.doctree b/docs/build/doctrees/maps.doctree
diff --git a/docs/build/doctrees/modules.doctree b/docs/build/doctrees/modules.doctree
diff --git a/docs/build/doctrees/neuromancer.doctree b/docs/build/doctrees/neuromancer.doctree
diff --git a/docs/build/doctrees/neuromancer.dynamics.doctree b/docs/build/doctrees/neuromancer.dynamics.doctree
diff --git a/docs/build/doctrees/neuromancer.modules.doctree b/docs/build/doctrees/neuromancer.modules.doctree
diff --git a/docs/build/doctrees/neuromancer.psl.doctree b/docs/build/doctrees/neuromancer.psl.doctree
diff --git a/docs/build/doctrees/neuromancer.slim.butterfly.doctree b/docs/build/doctrees/neuromancer.slim.butterfly.doctree
diff --git a/docs/build/doctrees/neuromancer.slim.doctree b/docs/build/doctrees/neuromancer.slim.doctree
diff --git a/docs/build/doctrees/ode.doctree b/docs/build/doctrees/ode.doctree
diff --git a/docs/build/doctrees/operators.doctree b/docs/build/doctrees/operators.doctree
diff --git a/docs/build/doctrees/physics.doctree b/docs/build/doctrees/physics.doctree
diff --git a/docs/build/doctrees/plot.doctree b/docs/build/doctrees/plot.doctree
diff --git a/docs/build/doctrees/problem.doctree b/docs/build/doctrees/problem.doctree
diff --git a/docs/build/doctrees/pwa_maps.doctree b/docs/build/doctrees/pwa_maps.doctree
diff --git a/docs/build/doctrees/readme_rst.doctree b/docs/build/doctrees/readme_rst.doctree
diff --git a/docs/build/doctrees/rnn.doctree b/docs/build/doctrees/rnn.doctree
diff --git a/docs/build/doctrees/simulator.doctree b/docs/build/doctrees/simulator.doctree
diff --git a/docs/build/doctrees/simulators.doctree b/docs/build/doctrees/simulators.doctree
diff --git a/docs/build/doctrees/solvers.doctree b/docs/build/doctrees/solvers.doctree
diff --git a/docs/build/doctrees/trainer.doctree b/docs/build/doctrees/trainer.doctree
diff --git a/docs/build/doctrees/visuals.doctree b/docs/build/doctrees/visuals.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -0,0 +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: 6f85d9628ed1b1b34af9e91a79d5f500
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/psl/.nojekyll → docs/build/html/.nojekyll b/docs/psl/.nojekyll → docs/build/html/.nojekyll
diff --git a/docs/build/html/_images/class_diagram.png b/docs/build/html/_images/class_diagram.png
diff --git a/docs/build/html/_modules/index.html b/docs/build/html/_modules/index.html
@@ -0,0 +1,141 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; Neuromancer 1.4.2 documentation</title>
+      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
+    <link rel="shortcut icon" href="../_static/tiny_dadaist.ico"/>
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../_static/documentation_options.js?v=02f2166e"></script>
+        <script src="../_static/doctools.js?v=888ff710"></script>
+        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            Neuromancer
+              <img src="../_static/dadaist.png" class="logo" alt="Logo"/>
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <ul>
+<li class="toctree-l1"><a class="reference internal" href="../neuromancer.html">neuromancer package</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">Neuromancer</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="neuromancer/arg.html">neuromancer.arg</a></li>
+<li><a href="neuromancer/callbacks.html">neuromancer.callbacks</a></li>
+<li><a href="neuromancer/constraint.html">neuromancer.constraint</a></li>
+<li><a href="neuromancer/dataset.html">neuromancer.dataset</a></li>
+<li><a href="neuromancer/dynamics/integrators.html">neuromancer.dynamics.integrators</a></li>
+<li><a href="neuromancer/dynamics/interpolation.html">neuromancer.dynamics.interpolation</a></li>
+<li><a href="neuromancer/dynamics/ode.html">neuromancer.dynamics.ode</a></li>
+<li><a href="neuromancer/dynamics/physics.html">neuromancer.dynamics.physics</a></li>
+<li><a href="neuromancer/gradients.html">neuromancer.gradients</a></li>
+<li><a href="neuromancer/loggers.html">neuromancer.loggers</a></li>
+<li><a href="neuromancer/loss.html">neuromancer.loss</a></li>
+<li><a href="neuromancer/modules/activations.html">neuromancer.modules.activations</a></li>
+<li><a href="neuromancer/modules/blocks.html">neuromancer.modules.blocks</a></li>
+<li><a href="neuromancer/modules/functions.html">neuromancer.modules.functions</a></li>
+<li><a href="neuromancer/modules/rnn.html">neuromancer.modules.rnn</a></li>
+<li><a href="neuromancer/modules/solvers.html">neuromancer.modules.solvers</a></li>
+<li><a href="neuromancer/plot.html">neuromancer.plot</a></li>
+<li><a href="neuromancer/problem.html">neuromancer.problem</a></li>
+<li><a href="neuromancer/psl/autonomous.html">neuromancer.psl.autonomous</a></li>
+<li><a href="neuromancer/psl/base.html">neuromancer.psl.base</a></li>
+<li><a href="neuromancer/psl/building_envelope.html">neuromancer.psl.building_envelope</a></li>
+<li><a href="neuromancer/psl/coupled_systems.html">neuromancer.psl.coupled_systems</a></li>
+<li><a href="neuromancer/psl/file_emulator.html">neuromancer.psl.file_emulator</a></li>
+<li><a href="neuromancer/psl/nonautonomous.html">neuromancer.psl.nonautonomous</a></li>
+<li><a href="neuromancer/psl/norms.html">neuromancer.psl.norms</a></li>
+<li><a href="neuromancer/psl/perturb.html">neuromancer.psl.perturb</a></li>
+<li><a href="neuromancer/psl/plot.html">neuromancer.psl.plot</a></li>
+<li><a href="neuromancer/psl/signals.html">neuromancer.psl.signals</a></li>
+<li><a href="neuromancer/psl/system_emulator.html">neuromancer.psl.system_emulator</a></li>
+<li><a href="neuromancer/slim/butterfly/butterfly.html">neuromancer.slim.butterfly.butterfly</a></li>
+<li><a href="neuromancer/slim/butterfly/butterfly_multiply.html">neuromancer.slim.butterfly.butterfly_multiply</a></li>
+<li><a href="neuromancer/slim/butterfly/complex_utils.html">neuromancer.slim.butterfly.complex_utils</a></li>
+<li><a href="neuromancer/slim/butterfly/permutation.html">neuromancer.slim.butterfly.permutation</a></li>
+<li><a href="neuromancer/slim/butterfly/permutation_multiply.html">neuromancer.slim.butterfly.permutation_multiply</a></li>
+<li><a href="neuromancer/slim/butterfly/utils.html">neuromancer.slim.butterfly.utils</a></li>
+<li><a href="neuromancer/slim/linear.html">neuromancer.slim.linear</a></li>
+<li><a href="neuromancer/slim/rnn.html">neuromancer.slim.rnn</a></li>
+<li><a href="neuromancer/system.html">neuromancer.system</a></li>
+<li><a href="neuromancer/trainer.html">neuromancer.trainer</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2023, Jan Drogna.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>