Fixing the docs

cssr-tools · Oct 28, 2022 · 166b0ec · 166b0ec
1 parent c9d8236
commit 166b0ec
Show file tree

Hide file tree

Showing 41 changed files with 29 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 
 # pymm: An open-source image-based framework for CFD in microsystems 
 
-<img src="docsrc/figs/pymm.gif" width="830" height="700">
+<img src="docs/text/figs/pymm.gif" width="830" height="700">
 
 This repository provides a workflow to perform computational fluid dynamics (CFD) simulations in microsystems. Given an image of a microsystem and an input text file with few parameters, then the _pymm_ executable process the image and builds the grid using [_Gmsh_](https://gmsh.info) and runs the CFD simulations using [_OpenFOAM_](https://www.openfoam.com).
 

diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,25 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = text
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	sphinx-apidoc --private -e -f -o text ../src/pymm
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+github:
+	@make html
+	cp -a _build/html/. .
diff --git a/docs/_sources/about.rst.txt b/docs/_sources/about.rst.txt
@@ -3,6 +3,7 @@ About pymm
 ==========
 
 .. image:: ./figs/pymm_logo.png
+    :scale: 35%
 
 The image-based Python package for computational fluid dynamics **pymm** was funded by 
 NORCE Norwegian Research Centre As [project number 101070]. 

diff --git a/docs/about.html b/docs/about.html
@@ -75,7 +75,7 @@
 
   <section id="about-pymm">
 <h1>About pymm<a class="headerlink" href="#about-pymm" title="Permalink to this heading"></a></h1>
-<img alt="_images/pymm_logo.png" src="_images/pymm_logo.png" />
+<a class="reference internal image-reference" href="_images/pymm_logo.png"><img alt="_images/pymm_logo.png" src="_images/pymm_logo.png" style="width: 259.0px; height: 259.0px;" /></a>
 <p>The image-based Python package for computational fluid dynamics <strong>pymm</strong> was funded by
 NORCE Norwegian Research Centre As [project number 101070].</p>
 <p>Contributions are more than welcome using the fork and pull request approach.</p>

diff --git a/docsrc/Makefile → docs/text/Makefile b/docsrc/Makefile → docs/text/Makefile
diff --git a/docsrc/about.rst → docs/text/about.rst b/docsrc/about.rst → docs/text/about.rst
@@ -3,6 +3,7 @@ About pymm
 ==========
 
 .. image:: ./figs/pymm_logo.png
+    :scale: 35%
 
 The image-based Python package for computational fluid dynamics **pymm** was funded by 
 NORCE Norwegian Research Centre As [project number 101070]. 

diff --git a/docsrc/api.rst → docs/text/api.rst b/docsrc/api.rst → docs/text/api.rst
diff --git a/docsrc/conf.py → docs/text/conf.py b/docsrc/conf.py → docs/text/conf.py
@@ -28,4 +28,3 @@
     "logo_only": True,
     "style_nav_header_background": "#aaaaaa",
 }
-html_static_path = ["_static"]
diff --git a/docsrc/configuration_file.rst → docs/text/configuration_file.rst b/docsrc/configuration_file.rst → docs/text/configuration_file.rst
diff --git a/docsrc/device.rst → docs/text/device.rst b/docsrc/device.rst → docs/text/device.rst
diff --git a/docsrc/examples.rst → docs/text/examples.rst b/docsrc/examples.rst → docs/text/examples.rst
diff --git a/docsrc/figs/contents.png → docs/text/figs/contents.png b/docsrc/figs/contents.png → docs/text/figs/contents.png
diff --git a/docsrc/figs/device.png → docs/text/figs/device.png b/docsrc/figs/device.png → docs/text/figs/device.png
diff --git a/docsrc/figs/device_pressure.png → docs/text/figs/device_pressure.png b/docsrc/figs/device_pressure.png → docs/text/figs/device_pressure.png
diff --git a/docsrc/figs/device_tracer.png → docs/text/figs/device_tracer.png b/docsrc/figs/device_tracer.png → docs/text/figs/device_tracer.png
diff --git a/docsrc/figs/device_velocity.png → docs/text/figs/device_velocity.png b/docsrc/figs/device_velocity.png → docs/text/figs/device_velocity.png
diff --git a/docsrc/figs/mesh_1e4.png → docs/text/figs/mesh_1e4.png b/docsrc/figs/mesh_1e4.png → docs/text/figs/mesh_1e4.png
diff --git a/docsrc/figs/mesh_1e5.png → docs/text/figs/mesh_1e5.png b/docsrc/figs/mesh_1e5.png → docs/text/figs/mesh_1e5.png
diff --git a/docsrc/figs/microsystem.png → docs/text/figs/microsystem.png b/docsrc/figs/microsystem.png → docs/text/figs/microsystem.png
diff --git a/docsrc/figs/online_pressure.png → docs/text/figs/online_pressure.png b/docsrc/figs/online_pressure.png → docs/text/figs/online_pressure.png
diff --git a/docsrc/figs/online_tracer.png → docs/text/figs/online_tracer.png b/docsrc/figs/online_tracer.png → docs/text/figs/online_tracer.png
diff --git a/docsrc/figs/online_velocity.png → docs/text/figs/online_velocity.png b/docsrc/figs/online_velocity.png → docs/text/figs/online_velocity.png
diff --git a/docsrc/figs/output.png → docs/text/figs/output.png b/docsrc/figs/output.png → docs/text/figs/output.png
diff --git a/docsrc/figs/pressure.png → docs/text/figs/pressure.png b/docsrc/figs/pressure.png → docs/text/figs/pressure.png
diff --git a/docsrc/figs/pymm.gif → docs/text/figs/pymm.gif b/docsrc/figs/pymm.gif → docs/text/figs/pymm.gif
diff --git a/docsrc/figs/pymm_logo.png → docs/text/figs/pymm_logo.png b/docsrc/figs/pymm_logo.png → docs/text/figs/pymm_logo.png
diff --git a/docsrc/figs/size_0_0_0.png → docs/text/figs/size_0_0_0.png b/docsrc/figs/size_0_0_0.png → docs/text/figs/size_0_0_0.png
diff --git a/docsrc/figs/size_100_1_1.png → docs/text/figs/size_100_1_1.png b/docsrc/figs/size_100_1_1.png → docs/text/figs/size_100_1_1.png
diff --git a/docsrc/figs/size_500_5_5.png → docs/text/figs/size_500_5_5.png b/docsrc/figs/size_500_5_5.png → docs/text/figs/size_500_5_5.png
diff --git a/docsrc/figs/tracer.png → docs/text/figs/tracer.png b/docsrc/figs/tracer.png → docs/text/figs/tracer.png
diff --git a/docsrc/figs/velocity.png → docs/text/figs/velocity.png b/docsrc/figs/velocity.png → docs/text/figs/velocity.png
diff --git a/docsrc/image.rst → docs/text/image.rst b/docsrc/image.rst → docs/text/image.rst
diff --git a/docsrc/index.rst → docs/text/index.rst b/docsrc/index.rst → docs/text/index.rst
diff --git a/docsrc/introduction.rst → docs/text/introduction.rst b/docsrc/introduction.rst → docs/text/introduction.rst
diff --git a/docsrc/make.bat → docs/text/make.bat b/docsrc/make.bat → docs/text/make.bat
diff --git a/docsrc/modules.rst → docs/text/modules.rst b/docsrc/modules.rst → docs/text/modules.rst
diff --git a/docsrc/online.rst → docs/text/online.rst b/docsrc/online.rst → docs/text/online.rst
diff --git a/docsrc/output_folder.rst → docs/text/output_folder.rst b/docsrc/output_folder.rst → docs/text/output_folder.rst
diff --git a/docsrc/pymm.core.pymm.rst → docs/text/pymm.core.pymm.rst b/docsrc/pymm.core.pymm.rst → docs/text/pymm.core.pymm.rst
diff --git a/docsrc/pymm.core.rst → docs/text/pymm.core.rst b/docsrc/pymm.core.rst → docs/text/pymm.core.rst
diff --git a/docsrc/pymm.rst → docs/text/pymm.rst b/docsrc/pymm.rst → docs/text/pymm.rst