Merge pull request #21 from ludwig-cf/feature-22

Move to github action
ludwig-cf · Jul 25, 2024 · 695609c · 695609c
2 parents 148ec58 + 69a02d8
commit 695609c
Show file tree

Hide file tree

Showing 67 changed files with 36 additions and 25 deletions.
diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml
@@ -0,0 +1,36 @@
+name: "Web site"
+on: 
+- workflow_dispatch
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+    - name: Install dependencies
+      run: |
+        pip install sphinx
+
+    - name: Build
+      run: |
+        cd docs
+        make html
+
+    - name: Commit documentation changes
+      run: |
+        git clone https://github.com/ludwig-cf/ludwig-cf.github.io.git --branch gh-pages --single-branch gh-pages
+        cp -r docs/_build/html/* gh-pages/
+	cp    docs/_build/html/.nojekyll gh-pages
+        cd gh-pages
+        git config --local user.email "[email protected]"
+        git config --local user.name "GitHub Action"
+        git add .
+        git commit -m "Update documentation" -a || true
+
+    - name: Push changes
+      uses: ad-m/github-push-action@master
+      with:
+        branch: gh-pages
+        directory: gh-pages
+        github_token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.travis.yml b/.travis.yml
diff --git a/.nojekyll → docs/.nojekyll b/.nojekyll → docs/.nojekyll
diff --git a/CNAME → docs/CNAME b/CNAME → docs/CNAME
diff --git a/Makefile → docs/Makefile b/Makefile → docs/Makefile
@@ -19,4 +19,3 @@ help:
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 	cp CNAME $(BUILDDIR)/html/CNAME
 	cp .nojekyll $(BUILDDIR)/html/.nojekyll
-	cp README.md $(BUILDDIR)/html/README.md
diff --git a/_static/alabaster.css → docs/_static/alabaster.css b/_static/alabaster.css → docs/_static/alabaster.css
diff --git a/_templates/navigation.html → docs/_templates/navigation.html b/_templates/navigation.html → docs/_templates/navigation.html
diff --git a/building/index.rst → docs/building/index.rst b/building/index.rst → docs/building/index.rst
diff --git a/conf.py → docs/conf.py b/conf.py → docs/conf.py
diff --git a/index.rst → docs/index.rst b/index.rst → docs/index.rst
diff --git a/initial/composition.rst → docs/initial/composition.rst b/initial/composition.rst → docs/initial/composition.rst
diff --git a/initial/fluid.rst → docs/initial/fluid.rst b/initial/fluid.rst → docs/initial/fluid.rst
diff --git a/initial/index.rst → docs/initial/index.rst b/initial/index.rst → docs/initial/index.rst
diff --git a/initial/liquid-crystal.rst → docs/initial/liquid-crystal.rst b/initial/liquid-crystal.rst → docs/initial/liquid-crystal.rst
diff --git a/initial/minion-brown.svg → docs/initial/minion-brown.svg b/initial/minion-brown.svg → docs/initial/minion-brown.svg
diff --git a/initial/ternary_2d_double_droplet.svg → docs/initial/ternary_2d_double_droplet.svg b/initial/ternary_2d_double_droplet.svg → docs/initial/ternary_2d_double_droplet.svg
diff --git a/initial/ternary_2d_double_emulsion.svg → docs/initial/ternary_2d_double_emulsion.svg b/initial/ternary_2d_double_emulsion.svg → docs/initial/ternary_2d_double_emulsion.svg
diff --git a/initial/ternary_2d_lens.svg → docs/initial/ternary_2d_lens.svg b/initial/ternary_2d_lens.svg → docs/initial/ternary_2d_lens.svg
diff --git a/initial/ternary_2d_tee.svg → docs/initial/ternary_2d_tee.svg b/initial/ternary_2d_tee.svg → docs/initial/ternary_2d_tee.svg
diff --git a/initial/three-phase.rst → docs/initial/three-phase.rst b/initial/three-phase.rst → docs/initial/three-phase.rst
diff --git a/inputs/colloid-anchoring-normal.svg → docs/inputs/colloid-anchoring-normal.svg b/inputs/colloid-anchoring-normal.svg → docs/inputs/colloid-anchoring-normal.svg
diff --git a/inputs/colloid-anchoring-planar.svg → docs/inputs/colloid-anchoring-planar.svg b/inputs/colloid-anchoring-planar.svg → docs/inputs/colloid-anchoring-planar.svg
diff --git a/inputs/colloid.rst → docs/inputs/colloid.rst b/inputs/colloid.rst → docs/inputs/colloid.rst
diff --git a/inputs/fe.rst → docs/inputs/fe.rst b/inputs/fe.rst → docs/inputs/fe.rst
diff --git a/inputs/force.rst → docs/inputs/force.rst b/inputs/force.rst → docs/inputs/force.rst
diff --git a/inputs/format.rst → docs/inputs/format.rst b/inputs/format.rst → docs/inputs/format.rst
diff --git a/inputs/index.rst → docs/inputs/index.rst b/inputs/index.rst → docs/inputs/index.rst
diff --git a/inputs/lespc.rst → docs/inputs/lespc.rst b/inputs/lespc.rst → docs/inputs/lespc.rst
diff --git a/inputs/lubrication-wall-colloid.svg → docs/inputs/lubrication-wall-colloid.svg b/inputs/lubrication-wall-colloid.svg → docs/inputs/lubrication-wall-colloid.svg
diff --git a/inputs/openbc.rst → docs/inputs/openbc.rst b/inputs/openbc.rst → docs/inputs/openbc.rst
diff --git a/inputs/order.rst → docs/inputs/order.rst b/inputs/order.rst → docs/inputs/order.rst
diff --git a/inputs/parallel.rst → docs/inputs/parallel.rst b/inputs/parallel.rst → docs/inputs/parallel.rst
diff --git a/inputs/parameters.rst → docs/inputs/parameters.rst b/inputs/parameters.rst → docs/inputs/parameters.rst
diff --git a/inputs/porous.rst → docs/inputs/porous.rst b/inputs/porous.rst → docs/inputs/porous.rst
diff --git a/inputs/visc.rst → docs/inputs/visc.rst b/inputs/visc.rst → docs/inputs/visc.rst
diff --git a/inputs/wall-anchor-fixed.svg → docs/inputs/wall-anchor-fixed.svg b/inputs/wall-anchor-fixed.svg → docs/inputs/wall-anchor-fixed.svg
diff --git a/inputs/wall-anchor-normal.svg → docs/inputs/wall-anchor-normal.svg b/inputs/wall-anchor-normal.svg → docs/inputs/wall-anchor-normal.svg
diff --git a/inputs/wall-anchor-planar.svg → docs/inputs/wall-anchor-planar.svg b/inputs/wall-anchor-planar.svg → docs/inputs/wall-anchor-planar.svg
diff --git a/inputs/walls.rst → docs/inputs/walls.rst b/inputs/walls.rst → docs/inputs/walls.rst
diff --git a/inputs/walls_wet_ternary.svg → docs/inputs/walls_wet_ternary.svg b/inputs/walls_wet_ternary.svg → docs/inputs/walls_wet_ternary.svg
diff --git a/outputs/colloid.rst → docs/outputs/colloid.rst b/outputs/colloid.rst → docs/outputs/colloid.rst
diff --git a/outputs/diagnostic.rst → docs/outputs/diagnostic.rst b/outputs/diagnostic.rst → docs/outputs/diagnostic.rst
diff --git a/outputs/fluid.rst → docs/outputs/fluid.rst b/outputs/fluid.rst → docs/outputs/fluid.rst
diff --git a/outputs/index.rst → docs/outputs/index.rst b/outputs/index.rst → docs/outputs/index.rst
diff --git a/tutorials/colloid-postprocessing/colloid.rst → ...orials/colloid-postprocessing/colloid.rst b/tutorials/colloid-postprocessing/colloid.rst → ...orials/colloid-postprocessing/colloid.rst
diff --git a/...ials/colloid-postprocessing/pipeline1.png → ...ials/colloid-postprocessing/pipeline1.png b/...ials/colloid-postprocessing/pipeline1.png → ...ials/colloid-postprocessing/pipeline1.png
diff --git a/...s/electrokinetics/counter-charge-only.svg → ...s/electrokinetics/counter-charge-only.svg b/...s/electrokinetics/counter-charge-only.svg → ...s/electrokinetics/counter-charge-only.svg
diff --git a/.../electrokinetics/electro-osmotic-flow.svg → .../electrokinetics/electro-osmotic-flow.svg b/.../electrokinetics/electro-osmotic-flow.svg → .../electrokinetics/electro-osmotic-flow.svg
diff --git a/...rials/electrokinetics/electrokinetics.rst → ...rials/electrokinetics/electrokinetics.rst b/...rials/electrokinetics/electrokinetics.rst → ...rials/electrokinetics/electrokinetics.rst
diff --git a/...rials/electrokinetics/liquid-junction.svg → ...rials/electrokinetics/liquid-junction.svg b/...rials/electrokinetics/liquid-junction.svg → ...rials/electrokinetics/liquid-junction.svg
diff --git a/tutorials/index.rst → docs/tutorials/index.rst b/tutorials/index.rst → docs/tutorials/index.rst
diff --git a/tutorials/lees-edwards/le-droplet-flow.svg → ...utorials/lees-edwards/le-droplet-flow.svg b/tutorials/lees-edwards/le-droplet-flow.svg → ...utorials/lees-edwards/le-droplet-flow.svg
diff --git a/tutorials/lees-edwards/le-droplet-raw.svg → ...tutorials/lees-edwards/le-droplet-raw.svg b/tutorials/lees-edwards/le-droplet-raw.svg → ...tutorials/lees-edwards/le-droplet-raw.svg
diff --git a/...ials/lees-edwards/le-droplet-unrolled.svg → ...ials/lees-edwards/le-droplet-unrolled.svg b/...ials/lees-edwards/le-droplet-unrolled.svg → ...ials/lees-edwards/le-droplet-unrolled.svg
diff --git a/tutorials/lees-edwards/le-schematic-lb.svg → ...utorials/lees-edwards/le-schematic-lb.svg b/tutorials/lees-edwards/le-schematic-lb.svg → ...utorials/lees-edwards/le-schematic-lb.svg
diff --git a/tutorials/lees-edwards/le-schematic-md.svg → ...utorials/lees-edwards/le-schematic-md.svg b/tutorials/lees-edwards/le-schematic-md.svg → ...utorials/lees-edwards/le-schematic-md.svg
diff --git a/tutorials/lees-edwards/lees-edwards.rst → docs/tutorials/lees-edwards/lees-edwards.rst b/tutorials/lees-edwards/lees-edwards.rst → docs/tutorials/lees-edwards/lees-edwards.rst
diff --git a/tutorials/liquid-crystal/blue-phase.png → docs/tutorials/liquid-crystal/blue-phase.png b/tutorials/liquid-crystal/blue-phase.png → docs/tutorials/liquid-crystal/blue-phase.png
diff --git a/tutorials/liquid-crystal/liquid-crystal.rst → ...torials/liquid-crystal/liquid-crystal.rst b/tutorials/liquid-crystal/liquid-crystal.rst → ...torials/liquid-crystal/liquid-crystal.rst
diff --git a/tutorials/poiseuille-flow/gnuplot.svg → docs/tutorials/poiseuille-flow/gnuplot.svg b/tutorials/poiseuille-flow/gnuplot.svg → docs/tutorials/poiseuille-flow/gnuplot.svg
diff --git a/tutorials/poiseuille-flow/simple-flow.rst → ...tutorials/poiseuille-flow/simple-flow.rst b/tutorials/poiseuille-flow/simple-flow.rst → ...tutorials/poiseuille-flow/simple-flow.rst
diff --git a/tutorials/simple-spinodal/contour.png → docs/tutorials/simple-spinodal/contour.png b/tutorials/simple-spinodal/contour.png → docs/tutorials/simple-spinodal/contour.png
diff --git a/tutorials/simple-spinodal/glyph.png → docs/tutorials/simple-spinodal/glyph.png b/tutorials/simple-spinodal/glyph.png → docs/tutorials/simple-spinodal/glyph.png
diff --git a/tutorials/simple-spinodal/pipeline.png → docs/tutorials/simple-spinodal/pipeline.png b/tutorials/simple-spinodal/pipeline.png → docs/tutorials/simple-spinodal/pipeline.png
diff --git a/tutorials/simple-spinodal/snapshot.png → docs/tutorials/simple-spinodal/snapshot.png b/tutorials/simple-spinodal/snapshot.png → docs/tutorials/simple-spinodal/snapshot.png
diff --git a/tutorials/simple-spinodal/spinodal.rst → docs/tutorials/simple-spinodal/spinodal.rst b/tutorials/simple-spinodal/spinodal.rst → docs/tutorials/simple-spinodal/spinodal.rst
diff --git a/tutorials/simple-spinodal/timecontrol.png → ...tutorials/simple-spinodal/timecontrol.png b/tutorials/simple-spinodal/timecontrol.png → ...tutorials/simple-spinodal/timecontrol.png