From 2ce053171db9ea59a7c588f5a90744d7880dee72 Mon Sep 17 00:00:00 2001
From: JM Etancelin <jean-matthieu.etancelin@univ-pau.fr>
Date: Fri, 17 Feb 2023 17:10:46 +0100
Subject: [PATCH] prepare for importing mergin doc to generated doc from hysop
---
build_doc.sh | 3 +
docs/conf.py | 68 ------------------
.../images}/advection_scalaire_passif.png | Bin
.../images}/dissolution_castlegate.png | Bin
{images => docs/images}/logo_hysop_rgb.png | Bin
{images => docs/images}/sediments.png | Bin
{images => docs/images}/sphere_3D_wake.png | Bin
{images => docs/images}/vorticity_field.png | Bin
docs/index.rst | 10 +--
9 files changed, 8 insertions(+), 73 deletions(-)
delete mode 100644 docs/conf.py
rename {images => docs/images}/advection_scalaire_passif.png (100%)
rename {images => docs/images}/dissolution_castlegate.png (100%)
rename {images => docs/images}/logo_hysop_rgb.png (100%)
rename {images => docs/images}/sediments.png (100%)
rename {images => docs/images}/sphere_3D_wake.png (100%)
rename {images => docs/images}/vorticity_field.png (100%)
diff --git a/build_doc.sh b/build_doc.sh
index 79c7844..29c12c0 100755
--- a/build_doc.sh
+++ b/build_doc.sh
@@ -10,6 +10,9 @@ BUILD_DIR="$(pwd)/build"
INSTALL_DIR="$(pwd)/install"
git clone https://gricad-gitlab.univ-grenoble-alpes.fr/particle_methods/hysop.git
+# Merge content from hysop-doc
+cp -r docs/* hysop/docs/sphinx/.
+
mkdir -p "${BUILD_DIR}"
cd "${BUILD_DIR}"
diff --git a/docs/conf.py b/docs/conf.py
deleted file mode 100644
index 18a54cb..0000000
--- a/docs/conf.py
+++ /dev/null
@@ -1,68 +0,0 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
-
-
-# -- Project information -----------------------------------------------------
-
-project = 'hysop'
-copyright = '2021, hysop team'
-author = 'hysop team'
-
-# The full version, including alpha/beta/rc tags
-release = '1.0.0'
-
-
-# -- General configuration ---------------------------------------------------
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-]
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
-
-
-# -- Options for HTML output -------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
-#
-html_theme = 'sphinx_rtd_theme'
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-
-html_logo = "./../images/logo_hysop_rgb.png"
-html_theme_options = {
- 'logo_only': True,
- 'display_version': False,
-}
-
-
-# Bibtex configuration
-extensions = ['sphinxcontrib.bibtex']
-bibtex_bibfiles = ['hysop.bib']
-bibtex_default_style = 'unsrt'
diff --git a/images/advection_scalaire_passif.png b/docs/images/advection_scalaire_passif.png
similarity index 100%
rename from images/advection_scalaire_passif.png
rename to docs/images/advection_scalaire_passif.png
diff --git a/images/dissolution_castlegate.png b/docs/images/dissolution_castlegate.png
similarity index 100%
rename from images/dissolution_castlegate.png
rename to docs/images/dissolution_castlegate.png
diff --git a/images/logo_hysop_rgb.png b/docs/images/logo_hysop_rgb.png
similarity index 100%
rename from images/logo_hysop_rgb.png
rename to docs/images/logo_hysop_rgb.png
diff --git a/images/sediments.png b/docs/images/sediments.png
similarity index 100%
rename from images/sediments.png
rename to docs/images/sediments.png
diff --git a/images/sphere_3D_wake.png b/docs/images/sphere_3D_wake.png
similarity index 100%
rename from images/sphere_3D_wake.png
rename to docs/images/sphere_3D_wake.png
diff --git a/images/vorticity_field.png b/docs/images/vorticity_field.png
similarity index 100%
rename from images/vorticity_field.png
rename to docs/images/vorticity_field.png
diff --git a/docs/index.rst b/docs/index.rst
index 4b8ad78..2ebc8ed 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -5,7 +5,7 @@
Welcome to HySoP's webpage!
===========================
-.. image:: ../images/logo_hysop_rgb.png
+.. image:: ./images/logo_hysop_rgb.png
HySoP (Hybrid Simulation with Particles) is a library dedicated to high performance direct numerical simulation of fluid related problems based on semi-lagrangian particle methods, for hybrid architectures providing multiple compute devices including CPUs, GPUs or MICs.
@@ -13,19 +13,19 @@ Gallery
=======
Passive scalar advection
-.. image:: ../images/advection_scalaire_passif.png
+.. image:: ./images/advection_scalaire_passif.png
Wake of a sphere
-.. image:: ../images/sphere_3D_wake.png
+.. image:: ./images/sphere_3D_wake.png
Sediment flows
-.. image:: ../images/sediments.png
+.. image:: ./images/sediments.png
Dissolution of carbonate rock
-.. image:: ../images/dissolution_castlegate.png
+.. image:: ./images/dissolution_castlegate.png
Playlist of several simulations
--
GitLab