diff --git a/README.md b/README.md index f4b9b25..449990e 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ # pymm: An open-source image-based framework for CFD in microsystems - + 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 new file mode 100644 index 0000000..7154c17 --- /dev/null +++ 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 index e317139..dac56ed 100644 --- 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 index 259d9bf..c6f5e22 100644 --- a/docs/about.html +++ b/docs/about.html @@ -75,7 +75,7 @@

About pymm

-_images/pymm_logo.png +_images/pymm_logo.png

The image-based Python package for computational fluid dynamics pymm was funded by NORCE Norwegian Research Centre As [project number 101070].

Contributions are more than welcome using the fork and pull request approach.

diff --git a/docsrc/Makefile b/docs/text/Makefile similarity index 100% rename from docsrc/Makefile rename to docs/text/Makefile diff --git a/docsrc/about.rst b/docs/text/about.rst similarity index 97% rename from docsrc/about.rst rename to docs/text/about.rst index e317139..dac56ed 100644 --- a/docsrc/about.rst +++ b/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 b/docs/text/api.rst similarity index 100% rename from docsrc/api.rst rename to docs/text/api.rst diff --git a/docsrc/conf.py b/docs/text/conf.py similarity index 97% rename from docsrc/conf.py rename to docs/text/conf.py index 8d207b3..01bc0ff 100644 --- a/docsrc/conf.py +++ b/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 b/docs/text/configuration_file.rst similarity index 100% rename from docsrc/configuration_file.rst rename to docs/text/configuration_file.rst diff --git a/docsrc/device.rst b/docs/text/device.rst similarity index 100% rename from docsrc/device.rst rename to docs/text/device.rst diff --git a/docsrc/examples.rst b/docs/text/examples.rst similarity index 100% rename from docsrc/examples.rst rename to docs/text/examples.rst diff --git a/docsrc/figs/contents.png b/docs/text/figs/contents.png similarity index 100% rename from docsrc/figs/contents.png rename to docs/text/figs/contents.png diff --git a/docsrc/figs/device.png b/docs/text/figs/device.png similarity index 100% rename from docsrc/figs/device.png rename to docs/text/figs/device.png diff --git a/docsrc/figs/device_pressure.png b/docs/text/figs/device_pressure.png similarity index 100% rename from docsrc/figs/device_pressure.png rename to docs/text/figs/device_pressure.png diff --git a/docsrc/figs/device_tracer.png b/docs/text/figs/device_tracer.png similarity index 100% rename from docsrc/figs/device_tracer.png rename to docs/text/figs/device_tracer.png diff --git a/docsrc/figs/device_velocity.png b/docs/text/figs/device_velocity.png similarity index 100% rename from docsrc/figs/device_velocity.png rename to docs/text/figs/device_velocity.png diff --git a/docsrc/figs/mesh_1e4.png b/docs/text/figs/mesh_1e4.png similarity index 100% rename from docsrc/figs/mesh_1e4.png rename to docs/text/figs/mesh_1e4.png diff --git a/docsrc/figs/mesh_1e5.png b/docs/text/figs/mesh_1e5.png similarity index 100% rename from docsrc/figs/mesh_1e5.png rename to docs/text/figs/mesh_1e5.png diff --git a/docsrc/figs/microsystem.png b/docs/text/figs/microsystem.png similarity index 100% rename from docsrc/figs/microsystem.png rename to docs/text/figs/microsystem.png diff --git a/docsrc/figs/online_pressure.png b/docs/text/figs/online_pressure.png similarity index 100% rename from docsrc/figs/online_pressure.png rename to docs/text/figs/online_pressure.png diff --git a/docsrc/figs/online_tracer.png b/docs/text/figs/online_tracer.png similarity index 100% rename from docsrc/figs/online_tracer.png rename to docs/text/figs/online_tracer.png diff --git a/docsrc/figs/online_velocity.png b/docs/text/figs/online_velocity.png similarity index 100% rename from docsrc/figs/online_velocity.png rename to docs/text/figs/online_velocity.png diff --git a/docsrc/figs/output.png b/docs/text/figs/output.png similarity index 100% rename from docsrc/figs/output.png rename to docs/text/figs/output.png diff --git a/docsrc/figs/pressure.png b/docs/text/figs/pressure.png similarity index 100% rename from docsrc/figs/pressure.png rename to docs/text/figs/pressure.png diff --git a/docsrc/figs/pymm.gif b/docs/text/figs/pymm.gif similarity index 100% rename from docsrc/figs/pymm.gif rename to docs/text/figs/pymm.gif diff --git a/docsrc/figs/pymm_logo.png b/docs/text/figs/pymm_logo.png similarity index 100% rename from docsrc/figs/pymm_logo.png rename to docs/text/figs/pymm_logo.png diff --git a/docsrc/figs/size_0_0_0.png b/docs/text/figs/size_0_0_0.png similarity index 100% rename from docsrc/figs/size_0_0_0.png rename to docs/text/figs/size_0_0_0.png diff --git a/docsrc/figs/size_100_1_1.png b/docs/text/figs/size_100_1_1.png similarity index 100% rename from docsrc/figs/size_100_1_1.png rename to docs/text/figs/size_100_1_1.png diff --git a/docsrc/figs/size_500_5_5.png b/docs/text/figs/size_500_5_5.png similarity index 100% rename from docsrc/figs/size_500_5_5.png rename to docs/text/figs/size_500_5_5.png diff --git a/docsrc/figs/tracer.png b/docs/text/figs/tracer.png similarity index 100% rename from docsrc/figs/tracer.png rename to docs/text/figs/tracer.png diff --git a/docsrc/figs/velocity.png b/docs/text/figs/velocity.png similarity index 100% rename from docsrc/figs/velocity.png rename to docs/text/figs/velocity.png diff --git a/docsrc/image.rst b/docs/text/image.rst similarity index 100% rename from docsrc/image.rst rename to docs/text/image.rst diff --git a/docsrc/index.rst b/docs/text/index.rst similarity index 100% rename from docsrc/index.rst rename to docs/text/index.rst diff --git a/docsrc/introduction.rst b/docs/text/introduction.rst similarity index 100% rename from docsrc/introduction.rst rename to docs/text/introduction.rst diff --git a/docsrc/make.bat b/docs/text/make.bat similarity index 100% rename from docsrc/make.bat rename to docs/text/make.bat diff --git a/docsrc/modules.rst b/docs/text/modules.rst similarity index 100% rename from docsrc/modules.rst rename to docs/text/modules.rst diff --git a/docsrc/online.rst b/docs/text/online.rst similarity index 100% rename from docsrc/online.rst rename to docs/text/online.rst diff --git a/docsrc/output_folder.rst b/docs/text/output_folder.rst similarity index 100% rename from docsrc/output_folder.rst rename to docs/text/output_folder.rst diff --git a/docsrc/pymm.core.pymm.rst b/docs/text/pymm.core.pymm.rst similarity index 100% rename from docsrc/pymm.core.pymm.rst rename to docs/text/pymm.core.pymm.rst diff --git a/docsrc/pymm.core.rst b/docs/text/pymm.core.rst similarity index 100% rename from docsrc/pymm.core.rst rename to docs/text/pymm.core.rst diff --git a/docsrc/pymm.rst b/docs/text/pymm.rst similarity index 100% rename from docsrc/pymm.rst rename to docs/text/pymm.rst