Restructure the doc. (#149)

* Restructure the doc. * Update Copyright and minor changes.
AMReX-Combustion · Dec 7, 2022 · 45a2053 · 45a2053
1 parent bb8d273
commit 45a2053
Show file tree

Hide file tree

Showing 47 changed files with 448 additions and 222 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -17,9 +17,9 @@ jobs:
   Docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
         with:
           python-version: '3.x'
       - name: Dependencies
@@ -40,12 +40,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
+        uses: JamesIves/github-pages-deploy-action@releases/v4
         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
diff --git a/.gitignore b/.gitignore
@@ -2,14 +2,15 @@
 *.ex
 tmp_build*
 
-
 # Run output
 *.p3d
-plt*
-*plt*old*
 Backtrace*
+*plt*old*
 chk*
+plt*
 grdlog
+temporals
 
 # OSX files
 .DS_Store
+.AppleDouble
diff --git a/Docs/CMakeLists.txt b/Docs/CMakeLists.txt
@@ -6,6 +6,10 @@ 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
+  )
diff --git a/Docs/Makefile b/Docs/Makefile
@@ -2,10 +2,10 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = PeleLMeX
-SOURCEDIR     = source
+SOURCEDIR     = source/manual
 BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".

diff --git a/Docs/source/Model.rst b/Docs/source/Model.rst
diff --git a/Docs/source/landing/.nojekyll b/Docs/source/landing/.nojekyll
diff --git a/Docs/landing/css/font-awesome.min.css → Docs/source/landing/css/font-awesome.min.css b/Docs/landing/css/font-awesome.min.css → Docs/source/landing/css/font-awesome.min.css
diff --git a/Docs/landing/css/skel.css → Docs/source/landing/css/skel.css b/Docs/landing/css/skel.css → Docs/source/landing/css/skel.css
diff --git a/Docs/landing/css/style-large.css → Docs/source/landing/css/style-large.css b/Docs/landing/css/style-large.css → Docs/source/landing/css/style-large.css
diff --git a/Docs/landing/css/style-medium.css → Docs/source/landing/css/style-medium.css b/Docs/landing/css/style-medium.css → Docs/source/landing/css/style-medium.css
diff --git a/Docs/landing/css/style-small.css → Docs/source/landing/css/style-small.css b/Docs/landing/css/style-small.css → Docs/source/landing/css/style-small.css
diff --git a/Docs/landing/css/style-xlarge.css → Docs/source/landing/css/style-xlarge.css b/Docs/landing/css/style-xlarge.css → Docs/source/landing/css/style-xlarge.css
diff --git a/Docs/landing/css/style-xsmall.css → Docs/source/landing/css/style-xsmall.css b/Docs/landing/css/style-xsmall.css → Docs/source/landing/css/style-xsmall.css
diff --git a/Docs/landing/css/style.css → Docs/source/landing/css/style.css b/Docs/landing/css/style.css → Docs/source/landing/css/style.css
diff --git a/Docs/landing/fonts/FontAwesome.otf → Docs/source/landing/fonts/FontAwesome.otf b/Docs/landing/fonts/FontAwesome.otf → Docs/source/landing/fonts/FontAwesome.otf
diff --git a/Docs/landing/fonts/fontawesome-webfont.eot → ...rce/landing/fonts/fontawesome-webfont.eot b/Docs/landing/fonts/fontawesome-webfont.eot → ...rce/landing/fonts/fontawesome-webfont.eot
diff --git a/Docs/landing/fonts/fontawesome-webfont.svg → ...rce/landing/fonts/fontawesome-webfont.svg b/Docs/landing/fonts/fontawesome-webfont.svg → ...rce/landing/fonts/fontawesome-webfont.svg
diff --git a/Docs/landing/fonts/fontawesome-webfont.ttf → ...rce/landing/fonts/fontawesome-webfont.ttf b/Docs/landing/fonts/fontawesome-webfont.ttf → ...rce/landing/fonts/fontawesome-webfont.ttf
diff --git a/Docs/landing/fonts/fontawesome-webfont.woff → ...ce/landing/fonts/fontawesome-webfont.woff b/Docs/landing/fonts/fontawesome-webfont.woff → ...ce/landing/fonts/fontawesome-webfont.woff
diff --git a/Docs/landing/gallery.html → Docs/source/landing/gallery.html b/Docs/landing/gallery.html → Docs/source/landing/gallery.html
@@ -81,8 +81,8 @@ <h4>Acknowledgment</h4>
 	<div class="row">
 	  <div class="8u 12u$(medium)">
 	    <ul class="copyright">
-	      <li>National Renewable Energy Laboratory (NREL), Golden, CO (United States) </li>
-	    </ul>
+	      <li>&copy; Alliance for Sustainable Energy, LLC and The Regents of the University of California, through Lawrence Berkeley National Laboratory
+All rights reserved.</li>
 	  </div>
 	</div>
       </div>

diff --git a/Docs/landing/help.html → Docs/source/landing/help.html b/Docs/landing/help.html → Docs/source/landing/help.html
@@ -76,8 +76,8 @@ <h1><a href="index.html">PeleLMeX</a></h1>
 	<div class="row">
 	  <div class="8u 12u$(medium)">
 	    <ul class="copyright">
-	      <li>&copy; PeleLMeX development team. All rights reserved.</li>
-	    </ul>
+	      <li>&copy; Alliance for Sustainable Energy, LLC and The Regents of the University of California, through Lawrence Berkeley National Laboratory
+All rights reserved.</li>
 	  </div>
 	</div>
       </div>

diff --git a/Docs/landing/images/CoverPistonBowl.png → ...source/landing/images/CoverPistonBowl.png b/Docs/landing/images/CoverPistonBowl.png → ...source/landing/images/CoverPistonBowl.png
diff --git a/Docs/landing/images/PB_AMR.gif → Docs/source/landing/images/PB_AMR.gif b/Docs/landing/images/PB_AMR.gif → Docs/source/landing/images/PB_AMR.gif