[mod] misc, docs

NaokiHori · Jan 30, 2024 · ed4600a · ed4600a
1 parent 33e4271
commit ed4600a
Show file tree

Hide file tree

Showing 7 changed files with 335 additions and 345 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -25,7 +25,9 @@ jobs:
           pip install requests numpy matplotlib
       - name: Download artifacts
         run: |
-          python .github/workflows/documentation_download_artifact.py ${{ secrets.GITHUB_TOKEN }}
+          python \
+            .github/workflows/documentation_download_artifact.py \
+            ${{ secrets.GITHUB_TOKEN }}
       - name: Draw figures
         run: |
           for fname in $(find docs/source -type f -name "draw_figure_*.py"); do
@@ -38,8 +40,8 @@ jobs:
             --volume ${PWD}:/project \
             --workdir /project \
             sphinxdoc/sphinx:latest \
-            sphinx-build -M linkcheck "docs/source" "docs/build"
-          log=docs/build/linkcheck/output.txt
+            sphinx-build -b linkcheck docs/source .
+          log=output.txt
           if [ -e ${log} ]; then
             wc -l ${log}
             cat ${log}
@@ -51,12 +53,12 @@ jobs:
             --volume ${PWD}:/project \
             --workdir /project \
             sphinxdoc/sphinx:latest \
-            sphinx-build -M html "docs/source" "docs/build"
+            sphinx-build -b html docs/source docs/build
       - name: Upload HTML artifacts
         uses: actions/upload-artifact@v3
         with:
           name: DocHTML
-          path: docs/build/html
+          path: docs/build
 
   deploy-doc:
     name: Deploy documentation
@@ -77,13 +79,13 @@ jobs:
         uses: actions/download-artifact@v3
         with:
           name: DocHTML
-          path: docs/build/html
+          path: artifacts
       - name: Setup GitHub Pages
         uses: actions/configure-pages@main
       - name: Upload HTML
         uses: actions/upload-pages-artifact@main
         with:
-          path: docs/build/html
+          path: artifacts
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@main

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -6,7 +6,7 @@
 
 project = "Simple NS Solver"
 author = "Naoki Hori"
-copyright = f"2019-2023, {author}"
+copyright = f"2019, {author}"
 
 extensions = [
         "myliteralinclude",

diff --git a/docs/source/implementation/fluid/compute_potential/main.rst b/docs/source/implementation/fluid/compute_potential/main.rst
@@ -23,8 +23,7 @@ The mathematical background is briefly described in the following pages:
    :maxdepth: 1
 
    math/governing_equation
-   math/eigen_decomposition
-   math/implementation
+   math/orthogonal_decomposition
 
 .. mydeclare:: /../../src/fluid/compute_potential/dft.c
    :language: c

diff --git a/docs/source/implementation/fluid/compute_potential/math/eigen_decomposition.rst b/docs/source/implementation/fluid/compute_potential/math/eigen_decomposition.rst
diff --git a/docs/source/implementation/fluid/compute_potential/math/governing_equation.rst b/docs/source/implementation/fluid/compute_potential/math/governing_equation.rst
@@ -55,5 +55,5 @@ while the periodicity is assumed in the :math:`y` direction:
 
 where :math:`n = 0, 1, 2, \cdots`.
 
-In :ref:`the next section <poisson_eigen_decomposition>`, the discretisation of this equation is described and discussed.
+In :ref:`the next section <poisson_orthogonal_decomposition>`, the discretisation of this equation is described and discussed.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -55,5 +55,5 @@ while the periodicity is assumed in the :math:`y` direction:

		where :math:`n = 0, 1, 2, \cdots`.

		In :ref:`the next section <poisson_eigen_decomposition>`, the discretisation of this equation is described and discussed.
		In :ref:`the next section <poisson_orthogonal_decomposition>`, the discretisation of this equation is described and discussed.