From a35c8b8a711dfdf87a1577609f9bd66c8020c289 Mon Sep 17 00:00:00 2001
From: Victor Poughon <victor.poughon@cnes.fr>
Date: Thu, 21 Mar 2019 14:59:55 +0100
Subject: [PATCH] DOC: shorten recipe section titles
---
.../Scripts/otbGenerateExamplesRstDoc.py | 2 +-
.../Cookbook/_static/css/otb_theme.css | 5 +++++
Documentation/Cookbook/rst/Recipes.rst | 21 -------------------
Documentation/Cookbook/rst/index.rst | 16 +++++++++++++-
Documentation/Cookbook/rst/recipes/improc.rst | 4 ++--
Documentation/Cookbook/rst/recipes/stereo.rst | 4 ++--
6 files changed, 25 insertions(+), 27 deletions(-)
delete mode 100644 Documentation/Cookbook/rst/Recipes.rst
diff --git a/Documentation/Cookbook/Scripts/otbGenerateExamplesRstDoc.py b/Documentation/Cookbook/Scripts/otbGenerateExamplesRstDoc.py
index 025f836a85..95463f1191 100644
--- a/Documentation/Cookbook/Scripts/otbGenerateExamplesRstDoc.py
+++ b/Documentation/Cookbook/Scripts/otbGenerateExamplesRstDoc.py
@@ -42,7 +42,7 @@ def generate_examples_index(rst_dir, list_of_examples):
# Render index file and tag index files
os.makedirs(join(rst_dir, "Examples"), exist_ok=True)
index_f = open(join(rst_dir, "Examples.rst"), "w")
- index_f.write(RstPageHeading("Examples", 3, ref="cpp-examples"))
+ index_f.write(RstPageHeading("C++ Examples", 3, ref="cpp-examples"))
for tag, examples_filenames in tag_files.items():
tag_filename = join("Examples", tag + ".rst")
diff --git a/Documentation/Cookbook/_static/css/otb_theme.css b/Documentation/Cookbook/_static/css/otb_theme.css
index 54aa37cc9f..ef635c46f4 100644
--- a/Documentation/Cookbook/_static/css/otb_theme.css
+++ b/Documentation/Cookbook/_static/css/otb_theme.css
@@ -10,6 +10,11 @@
margin-top: .8em;
}
+/* Small fix for the last section of the menu */
+.wy-menu-vertical {
+ margin-bottom: 1em;
+};
+
/* Reduce the effect of the p bottom margin before lists
* Very useful for choice parameters in app doc for example
*/
diff --git a/Documentation/Cookbook/rst/Recipes.rst b/Documentation/Cookbook/rst/Recipes.rst
deleted file mode 100644
index 775519aed6..0000000000
--- a/Documentation/Cookbook/rst/Recipes.rst
+++ /dev/null
@@ -1,21 +0,0 @@
-Recipes
-=======
-
-This chapter presents guidelines to perform various remote sensing and/or
-image processing tasks. Its goal is not to be
-exhaustive, but rather to familiarise users with the OTB package functionality
-and demonstrate how they can be applied.
-
-.. toctree::
- :maxdepth: 6
-
- recipes/optpreproc.rst
- recipes/sarprocessing.rst
- recipes/residual_registration.rst
- recipes/improc.rst
- recipes/bandmathx.rst
- recipes/contrast_enhancement.rst
- recipes/pbclassif.rst
- recipes/featextract.rst
- recipes/stereo.rst
- recipes/hyperspectral.rst
diff --git a/Documentation/Cookbook/rst/index.rst b/Documentation/Cookbook/rst/index.rst
index 15234d085a..b39e4ecda0 100644
--- a/Documentation/Cookbook/rst/index.rst
+++ b/Documentation/Cookbook/rst/index.rst
@@ -53,9 +53,23 @@ Table of Contents
GraphicalInterface
PythonAPI
QGISInterface
- Recipes
Applications
+.. toctree::
+ :maxdepth: 2
+ :caption: Recipes
+
+ recipes/optpreproc.rst
+ recipes/sarprocessing.rst
+ recipes/residual_registration.rst
+ recipes/improc.rst
+ recipes/bandmathx.rst
+ recipes/contrast_enhancement.rst
+ recipes/pbclassif.rst
+ recipes/featextract.rst
+ recipes/stereo.rst
+ recipes/hyperspectral.rst
+
.. toctree::
:maxdepth: 2
:caption: C++ API
diff --git a/Documentation/Cookbook/rst/recipes/improc.rst b/Documentation/Cookbook/rst/recipes/improc.rst
index 36aa46f1b9..4216062f7e 100644
--- a/Documentation/Cookbook/rst/recipes/improc.rst
+++ b/Documentation/Cookbook/rst/recipes/improc.rst
@@ -1,5 +1,5 @@
-Image processing and information extraction
-===========================================
+Image processing
+================
Simple calculus with channels
-----------------------------
diff --git a/Documentation/Cookbook/rst/recipes/stereo.rst b/Documentation/Cookbook/rst/recipes/stereo.rst
index c25b3f74a8..6d90c2f151 100644
--- a/Documentation/Cookbook/rst/recipes/stereo.rst
+++ b/Documentation/Cookbook/rst/recipes/stereo.rst
@@ -1,5 +1,5 @@
-Stereoscopic reconstruction from VHR optical images pair
-========================================================
+Stereoscopic reconstruction
+===========================
This section describes how to convert pair of stereo images into
elevation information.
--
GitLab