automatic docs

pablogila · Oct 18, 2024 · d20488e · d20488e
1 parent fc13715
commit d20488e
Show file tree

Hide file tree

Showing 23 changed files with 6,615 additions and 411 deletions.
diff --git a/README.md b/README.md
@@ -4,8 +4,12 @@
 
 This Python package makes my life easier when analyzing INS, FTIR and Raman CSV data files, among others.  
 
+Check the latest documentation [here](https://pablogila.github.io/Maat/).  
+
 ## Install
 
+To install, clone the repository from [GitHub](https://github.com/pablogila/Maat/) and run:  
+
 ```shell
 pip install .
 ```

diff --git a/build_docs.sh b/build_docs.sh
@@ -0,0 +1 @@
+pdoc ./maat/ -o ./docs
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,7 @@
+<!doctype html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="refresh" content="0; url=./maat.html"/>
+</head>
+</html>
diff --git a/docs/maat.html b/docs/maat.html
diff --git a/docs/maat/classes.html b/docs/maat/classes.html
diff --git a/docs/maat/constants.html b/docs/maat/constants.html
diff --git a/docs/maat/deuteration.html b/docs/maat/deuteration.html
diff --git a/docs/maat/fit.html b/docs/maat/fit.html
diff --git a/docs/maat/material.html b/docs/maat/material.html
diff --git a/docs/maat/normalize.html b/docs/maat/normalize.html
diff --git a/docs/maat/plot.html b/docs/maat/plot.html
diff --git a/docs/maat/utils.html b/docs/maat/utils.html
diff --git a/docs/search.js b/docs/search.js
diff --git a/maat/__init__.py b/maat/__init__.py
@@ -1,3 +1,8 @@
+'''
+.. include:: ../README.md
+'''
+
+
 from .constants import *
 from .classes import *
 from .utils import *

diff --git a/maat/classes.py b/maat/classes.py
@@ -1,3 +1,8 @@
+'''
+This module contains the core classes and their functions.
+'''
+
+
 from .constants import *
 import numpy as np
 import matplotlib.pyplot as plt
@@ -6,11 +11,6 @@
 import os
 
 
-'''
-This module contains the core classes and their functions.
-'''
-
-
 class ScaleRange:
     '''
     If `plotting.normalize=True`, the data will be normalized inside the specified range.

diff --git a/maat/constants.py b/maat/constants.py
@@ -1,12 +1,12 @@
-import numpy as np
-
-
 '''
 This module contains constants and conversion factors.
 '''
 
 
-version = 'v2.1.0'
+import numpy as np
+
+
+version = 'v2.1.1'
 
 
 #############################