Update documentation

Author: charlesll

docs/conf.py

@@ -22,7 +22,7 @@
 author = 'Charles Le Losq'
 
 # The full version, including alpha/beta/rc tags
-release = '0.5.1'
+release = '0.5.2'
 
 
 # -- General configuration ---------------------------------------------------

docs/doctrees/environment.pickle

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 5b7b2bbb514d64fa635096b242d1cec4
+config: 1f805ab17dcbbe3620e7a2dd86b79d24
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/doctrees/firststeps.doctree

@@ -6,7 +6,7 @@
 Welcome to RamPy's documentation!
 =================================
 
-Copyright (2015-2021) C. Le Losq and co.
+Copyright (2015-2024) C. Le Losq and co.
 
 Charles Le Losq, Institut de physique du globe de Paris, University of Paris
 lelosq@ipgp.fr
@@ -47,4 +47,5 @@ Indices and tables
    preprocessing
    peakfitting
    machinelearning
+   maps
    rampy

docs/doctrees/index.doctree

@@ -1,17 +1,8 @@
 Maps
 ====
 
-Rampy offers the possiblity to analyse maps from Raman spectrometers.
+Rampy offers the possiblity to analyse maps from Raman spectrometers using the ``rampy.maps`` module.
 
-In the following, we assume you already performed library importation as
+Line and 2D Maps saved in CSV or TXT format from Horiba and Renishaw spectrometers can be loaded, and various data treatments can be performed afterwards.
 
-.. code-block:: python
-
-  # importing rampy
-  import rampy as rp
-  # and for numpy we will respect the usual name:
-  import numpy as np
-  # for matplotlib
-  import matplotlib.pyplot as plt
-
-IN CONSTRUCTION
+An Jupyter notebook example of processing a map of Raman spectra is `provided here <https://github.com/charlesll/rampy/blob/master/examples/Maps_example.ipynb>`_.

docs/doctrees/installation.doctree

@@ -4,6 +4,7 @@ Peak fitting
 Rampy does not offer a dedicated function for peak fitting. Instead, we invite users to use lmfit or scipy.optimize to perform peak fitting, which is basically the action to fit a model (sum of peaks) to your data.
 
 Rampy offers functions for various peak shapes, including:
+
 * gaussian peaks > ``rampy.gaussian``
 * lorentzian peaks > ``rampy.lorentzian``
 * pseudo-voigt peaks > ``rampy.pseudovoigt``

docs/doctrees/machinelearning.doctree

@@ -1,20 +1,9 @@
-/*
- * _sphinx_javascript_frameworks_compat.js
- * ~~~~~~~~~~
- *
- * Compatability shim for jQuery and underscores.js.
- *
- * WILL BE REMOVED IN Sphinx 6.0
- * xref RemovedInSphinx60Warning
+/* Compatability shim for jQuery and underscores.js.
  *
+ * Copyright Sphinx contributors
+ * Released under the two clause BSD licence
  */
 
-/**
- * select a different prefix for underscore
- */
-$u = _.noConflict();
-
-
 /**
  * small helper function to urldecode strings
  *

docs/doctrees/maps.doctree

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -237,6 +237,10 @@ a.headerlink {
     visibility: hidden;
 }
 
+a:visited {
+    color: #551A8B;
+}
+
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
 h3:hover > a.headerlink,
@@ -324,17 +328,17 @@ aside.sidebar {
 p.sidebar-title {
     font-weight: bold;
 }
+
 nav.contents,
 aside.topic,
-
 div.admonition, div.topic, blockquote {
     clear: left;
 }
 
 /* -- topics ---------------------------------------------------------------- */
+
 nav.contents,
 aside.topic,
-
 div.topic {
     border: 1px solid #ccc;
     padding: 7px;
@@ -375,7 +379,6 @@ div.sidebar > :last-child,
 aside.sidebar > :last-child,
 nav.contents > :last-child,
 aside.topic > :last-child,
-
 div.topic > :last-child,
 div.admonition > :last-child {
     margin-bottom: 0;
@@ -385,7 +388,6 @@ div.sidebar::after,
 aside.sidebar::after,
 nav.contents::after,
 aside.topic::after,
-
 div.topic::after,
 div.admonition::after,
 blockquote::after {
@@ -611,25 +613,6 @@ ul.simple p {
     margin-bottom: 0;
 }
 
-/* Docutils 0.17 and older (footnotes & citations) */
-dl.footnote > dt,
-dl.citation > dt {
-    float: left;
-    margin-right: 0.5em;
-}
-
-dl.footnote > dd,
-dl.citation > dd {
-    margin-bottom: 0em;
-}
-
-dl.footnote > dd:after,
-dl.citation > dd:after {
-    content: "";
-    clear: both;
-}
-
-/* Docutils 0.18+ (footnotes & citations) */
 aside.footnote > span,
 div.citation > span {
     float: left;
@@ -654,8 +637,6 @@ div.citation > p:last-of-type:after {
     clear: both;
 }
 
-/* Footnotes & citations ends */
-
 dl.field-list {
     display: grid;
     grid-template-columns: fit-content(30%) auto;
@@ -668,10 +649,6 @@ dl.field-list > dt {
     padding-right: 5px;
 }
 
-dl.field-list > dt:after {
-    content: ":";
-}
-
 dl.field-list > dd {
     padding-left: 0.5em;
     margin-top: 0em;
@@ -697,6 +674,16 @@ dd {
     margin-left: 30px;
 }
 
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
     margin-bottom: 0;
@@ -765,6 +752,14 @@ abbr, acronym {
     cursor: help;
 }
 
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {