Skip to content

Commit 1c3cb4b

Browse files
committed
finish documentation
1 parent 6f622d0 commit 1c3cb4b

8 files changed

Lines changed: 61 additions & 546018 deletions

docs/source/api.rst

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,61 @@
11
API Reference
22
=============
33

4-
.. automodule:: main.math
4+
.. contents:: Table of Contents
5+
:local:
6+
:depth: 2
7+
8+
9+
Data I/O
10+
========
11+
12+
.. automodule:: circStudio.io.base
13+
:members:
14+
:undoc-members:
15+
:show-inheritance:
16+
17+
.. automodule:: circStudio.io.mask
18+
:members:
19+
:undoc-members:
20+
:show-inheritance:
21+
22+
23+
Rest-Activity Metrics
24+
=====================
25+
26+
.. automodule:: circStudio.analysis.metrics.metrics
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
32+
Cosinor Analysis
33+
================
34+
35+
.. automodule:: circStudio.analysis.cosinor.cosinor
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:
39+
40+
41+
Mathematical Models
42+
===================
43+
44+
.. automodule:: circStudio.analysis.models.math_models
45+
:members:
46+
:undoc-members:
47+
:show-inheritance:
48+
49+
50+
Sleep Scoring and Diary
51+
=======================
52+
53+
.. automodule:: circStudio.analysis.sleep.sleep
54+
:members:
55+
:undoc-members:
56+
:show-inheritance:
57+
58+
.. automodule:: circStudio.analysis.sleep.diary
559
:members:
660
:undoc-members:
761
:show-inheritance:

docs/source/index.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,15 @@
66
circStudio documentation
77
========================
88

9-
Add your content using ``reStructuredText`` syntax. See the
10-
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
11-
documentation for details.
12-
9+
Welcome to `circStudio`, a Python package for mathematical modelling of circadian rhythms using actigraphy data,
10+
built on top of the open-source package `pyActigraphy`.
1311

1412
.. toctree::
1513
:maxdepth: 2
1614
:caption: Contents:
1715

18-
opening_files
16+
tutorial_1
17+
tutorial_2
18+
tutorial_3
19+
tutorial_4
1920
api

docs/source/notebooks/legacy_notebooks/03 - Masking spurious inactivity.ipynb

Lines changed: 0 additions & 114314 deletions
This file was deleted.

0 commit comments

Comments
 (0)