Merge pull request #22 from AminAlam/dev

Readthedocs documentation is added

.github/workflows/python-package.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
-name: Python package
+name: CI
 
 on:
   push:

.gitignore

@@ -162,4 +162,12 @@ cython_debug/
 
 # data files
 test/data/npz*
-test/data/plots
+test/data/plots
+
+# documentation
+docs/build
+docs/source/_static
+docs/source/_templates
+docs/source/*.rst
+docs/*.bat
+docs/Makefile

.readthedocs.yaml

@@ -0,0 +1,32 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt

README.md

@@ -6,6 +6,9 @@
 <img src="https://img.shields.io/badge/Python-14354C?style=for-the-badge&logo=python&logoColor=white" alt="built with Python3" />
 </div>
 
+[![Documentation Status](https://readthedocs.org/projects/elecphys/badge/?version=latest)](https://elecphys.readthedocs.io/en/latest/?badge=latest) [![Ci testing](https://github.com/AminAlam/elecphys/workflows/CI/badge.svg?branch=main)](https://github.com/AminAlam/elecphys/workflows/CI/badge.svg?branch=main)
+
+
 ----------
 
 ElecPhys: A Python package for electrophysiology data analysis. It provides tools for data loading, analysis, conversion, preprocessing, and visualization.
@@ -16,7 +19,7 @@ ElecPhys: A Python package for electrophysiology data analysis. It provides tool
    * [Overview](https://github.com/AminAlam/ElecPhys#overview)
    * [Installation](https://github.com/AminAlam/ElecPhys#ElecPhys)
    * [Usage](https://github.com/AminAlam/ElecPhys#usage)
-
+   * [Documentation](https://github.com/AminAlam/ElecPhys#documentation)
 ----------
 ## Overview
 <p align="justify">
@@ -87,5 +90,5 @@ ds_factor = 5
 # call rhd to mat conversoin module
 elecphys.conversion.convert_rhd_to_mat_matlab(folder_path, output_mat_file, ds_factor)
 ```
-### Available Analysis methods
-Please check [this file](./docs/available_analysis.md)
+### Documentation
+Please check [this link](https://readthedocs.org/projects/elecphys) for full documentation

docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx
+pydata_sphinx_theme

docs/source/conf.py

@@ -0,0 +1,35 @@
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../../elecphys'))
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'ElecPhys'
+copyright = '2023, Amin Alam'
+author = 'Amin Alam'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+   'sphinx.ext.doctest',
+   'sphinx.ext.autodoc',
+   'sphinx.ext.autosummary',
+   'sphinx.ext.napoleon',
+]
+templates_path = ['_templates']
+exclude_patterns = []
+
+html_theme = "pydata_sphinx_theme"
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']