Enhance documentation with theme migration, new features, and updates

[rafaelscsilva]

This PR focuses on improving and expanding BioSPPy's documentation while standardizing docstrings across the codebase. The goal is to provide a more consistent experience and ensure compatibility with the documentation generation pipelin with theme improvements. No functional changes have been made: all code behavior, APIs, and implementations remain unchanged.

Documentation updates

Documentation restructure

The documentation has been reorganized into a module-centric structure, making it easier to navigate and discover functionality.

In addition, the documentation now includes:

• A new Biosignals section introducing the supported biosignal modalities and providing an overview of their purpose within the library.
• A new Machine Learning section documenting the recently introduced ML sub-package.
• New figures, diagrams, and explanatory content throughout the documentation to improve clarity and usability.

Docstring improvements

Docstrings were standardized across the project to improve consistency and ensure they are correctly parsed by the documentation generation pipeline. These updates include:

• Consistent formatting of sections such as Parameters, Returns, and Notes.
• Improved parameter descriptions and naming where appropriate.
• Grammar, readability, and formatting improvements.
• Consolidation of license information into appropriate Notes sections where applicable.
• Formatting fixes required for reliable documentation generation.

Modules updated

The following modules received documentation and formatting updates only, with no changes to function behavior or implementation:

• biosppy/features/time.py
• biosppy/quality.py
• biosppy/signals/bvp.py
• biosppy/signals/ecg.py
• biosppy/signals/eda.py
• biosppy/signals/eeg.py
• biosppy/signals/egm.py
• biosppy/signals/ppg.py
• biosppy/storage.py
• biosppy/synthesizers/ecg.py
• biosppy/synthesizers/emg.py

Generating the documentation locally

To build and preview the documentation locally, run the following commands from the project root:

cd BioSPPy
python -m sphinx -b html -E docs docs/_build/html

This generates the HTML documentation in:

docs/_build/html

To serve the generated documentation locally, start a local HTTP server from the generated documentation directory:

cd docs/_build/html
python -m http.server 8000

Then open the documentation in your browser:

http://localhost:8000