Skip to content

Commit af3a618

Browse files
hombithombit
committed
Initial Sphinx docs
1 parent 719040b commit af3a618

File tree

8 files changed

+451
-0
lines changed

8 files changed

+451
-0
lines changed

‎docs/Makefile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/conf.py

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# For the full list of built-in configuration values, see the documentation:
4+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
5+
6+
# -- Project information -----------------------------------------------------
7+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8+
9+
project = "light-curve"
10+
copyright = "2023, Konstantin Malanchev, Anastasia Lavrukhina"
11+
author = "Konstantin Malanchev, Anastasia Lavrukhina"
12+
13+
# -- General configuration ---------------------------------------------------
14+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
15+
16+
extensions = [
17+
"sphinx.ext.autodoc",
18+
"sphinx.ext.autosummary",
19+
"sphinx.ext.napoleon",
20+
"sphinx.ext.viewcode",
21+
"sphinxcontrib.katex",
22+
]
23+
24+
templates_path = ["_templates"]
25+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
26+
27+
28+
# -- Options for HTML output -------------------------------------------------
29+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
30+
31+
html_theme = "alabaster"
32+
html_static_path = ["_static"]
33+
34+
35+
# KaTeX
36+
katex_inline = ["$", "$"]
37+
katex_display = ["$$", "$$"]
38+
39+
40+
# Convert docstrings from Markdown to reStructuredText
41+
def docstring(app, what, name, obj, options, lines):
42+
# import re
43+
44+
import m2r2
45+
46+
md = "\n".join(lines)
47+
48+
# Replace '$$' with '```math ... ```'
49+
# md = re.sub(r'\$\$(.*?)\$\$', r'```math\n\1\n```', md)
50+
51+
rst = m2r2.convert(md)
52+
53+
lines.clear()
54+
lines.extend(rst.splitlines())
55+
56+
57+
def setup(app):
58+
app.connect("autodoc-process-docstring", docstring)

‎docs/index.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.. light-curve documentation master file, created by
2+
sphinx-quickstart on Tue May 30 16:32:24 2023.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to light-curve's documentation!
7+
=======================================
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
13+
modules.rst
14+
15+
16+
Indices and tables
17+
==================
18+
19+
* :ref:`genindex`
20+
* :ref:`modindex`
21+
* :ref:`search`

‎docs/light_curve.light_curve_py.features.rst

Lines changed: 250 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,250 @@
1+
light\_curve.light\_curve\_py.features package
2+
==============================================
3+
4+
.. automodule:: light_curve.light_curve_py.features
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Submodules
10+
----------
11+
12+
light\_curve.light\_curve\_py.features.adnormal module
13+
------------------------------------------------------
14+
15+
.. automodule:: light_curve.light_curve_py.features.adnormal
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
light\_curve.light\_curve\_py.features.amplitude module
21+
-------------------------------------------------------
22+
23+
.. automodule:: light_curve.light_curve_py.features.amplitude
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
light\_curve.light\_curve\_py.features.beyondnstd module
29+
--------------------------------------------------------
30+
31+
.. automodule:: light_curve.light_curve_py.features.beyondnstd
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
light\_curve.light\_curve\_py.features.bins module
37+
--------------------------------------------------
38+
39+
.. automodule:: light_curve.light_curve_py.features.bins
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
44+
light\_curve.light\_curve\_py.features.cusum module
45+
---------------------------------------------------
46+
47+
.. automodule:: light_curve.light_curve_py.features.cusum
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:
51+
52+
light\_curve.light\_curve\_py.features.eta module
53+
-------------------------------------------------
54+
55+
.. automodule:: light_curve.light_curve_py.features.eta
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
60+
light\_curve.light\_curve\_py.features.etae module
61+
--------------------------------------------------
62+
63+
.. automodule:: light_curve.light_curve_py.features.etae
64+
:members:
65+
:undoc-members:
66+
:show-inheritance:
67+
68+
light\_curve.light\_curve\_py.features.excvar module
69+
----------------------------------------------------
70+
71+
.. automodule:: light_curve.light_curve_py.features.excvar
72+
:members:
73+
:undoc-members:
74+
:show-inheritance:
75+
76+
light\_curve.light\_curve\_py.features.extractor module
77+
-------------------------------------------------------
78+
79+
.. automodule:: light_curve.light_curve_py.features.extractor
80+
:members:
81+
:undoc-members:
82+
:show-inheritance:
83+
84+
light\_curve.light\_curve\_py.features.flux\_n\_not\_det\_before\_fd module
85+
---------------------------------------------------------------------------
86+
87+
.. automodule:: light_curve.light_curve_py.features.flux_n_not_det_before_fd
88+
:members:
89+
:undoc-members:
90+
:show-inheritance:
91+
92+
light\_curve.light\_curve\_py.features.intpercrange module
93+
----------------------------------------------------------
94+
95+
.. automodule:: light_curve.light_curve_py.features.intpercrange
96+
:members:
97+
:undoc-members:
98+
:show-inheritance:
99+
100+
light\_curve.light\_curve\_py.features.kurtosis module
101+
------------------------------------------------------
102+
103+
.. automodule:: light_curve.light_curve_py.features.kurtosis
104+
:members:
105+
:undoc-members:
106+
:show-inheritance:
107+
108+
light\_curve.light\_curve\_py.features.linfit module
109+
----------------------------------------------------
110+
111+
.. automodule:: light_curve.light_curve_py.features.linfit
112+
:members:
113+
:undoc-members:
114+
:show-inheritance:
115+
116+
light\_curve.light\_curve\_py.features.lintrend module
117+
------------------------------------------------------
118+
119+
.. automodule:: light_curve.light_curve_py.features.lintrend
120+
:members:
121+
:undoc-members:
122+
:show-inheritance:
123+
124+
light\_curve.light\_curve\_py.features.magnitude\_n\_not\_det\_before\_fd module
125+
--------------------------------------------------------------------------------
126+
127+
.. automodule:: light_curve.light_curve_py.features.magnitude_n_not_det_before_fd
128+
:members:
129+
:undoc-members:
130+
:show-inheritance:
131+
132+
light\_curve.light\_curve\_py.features.magnpratio module
133+
--------------------------------------------------------
134+
135+
.. automodule:: light_curve.light_curve_py.features.magnpratio
136+
:members:
137+
:undoc-members:
138+
:show-inheritance:
139+
140+
light\_curve.light\_curve\_py.features.maxslope module
141+
------------------------------------------------------
142+
143+
.. automodule:: light_curve.light_curve_py.features.maxslope
144+
:members:
145+
:undoc-members:
146+
:show-inheritance:
147+
148+
light\_curve.light\_curve\_py.features.mean module
149+
--------------------------------------------------
150+
151+
.. automodule:: light_curve.light_curve_py.features.mean
152+
:members:
153+
:undoc-members:
154+
:show-inheritance:
155+
156+
light\_curve.light\_curve\_py.features.meanvar module
157+
-----------------------------------------------------
158+
159+
.. automodule:: light_curve.light_curve_py.features.meanvar
160+
:members:
161+
:undoc-members:
162+
:show-inheritance:
163+
164+
light\_curve.light\_curve\_py.features.medabsdev module
165+
-------------------------------------------------------
166+
167+
.. automodule:: light_curve.light_curve_py.features.medabsdev
168+
:members:
169+
:undoc-members:
170+
:show-inheritance:
171+
172+
light\_curve.light\_curve\_py.features.medbufrperc module
173+
---------------------------------------------------------
174+
175+
.. automodule:: light_curve.light_curve_py.features.medbufrperc
176+
:members:
177+
:undoc-members:
178+
:show-inheritance:
179+
180+
light\_curve.light\_curve\_py.features.median module
181+
----------------------------------------------------
182+
183+
.. automodule:: light_curve.light_curve_py.features.median
184+
:members:
185+
:undoc-members:
186+
:show-inheritance:
187+
188+
light\_curve.light\_curve\_py.features.otsusplit module
189+
-------------------------------------------------------
190+
191+
.. automodule:: light_curve.light_curve_py.features.otsusplit
192+
:members:
193+
:undoc-members:
194+
:show-inheritance:
195+
196+
light\_curve.light\_curve\_py.features.pdiffmperc module
197+
--------------------------------------------------------
198+
199+
.. automodule:: light_curve.light_curve_py.features.pdiffmperc
200+
:members:
201+
:undoc-members:
202+
:show-inheritance:
203+
204+
light\_curve.light\_curve\_py.features.percampl module
205+
------------------------------------------------------
206+
207+
.. automodule:: light_curve.light_curve_py.features.percampl
208+
:members:
209+
:undoc-members:
210+
:show-inheritance:
211+
212+
light\_curve.light\_curve\_py.features.redchi2 module
213+
-----------------------------------------------------
214+
215+
.. automodule:: light_curve.light_curve_py.features.redchi2
216+
:members:
217+
:undoc-members:
218+
:show-inheritance:
219+
220+
light\_curve.light\_curve\_py.features.skew module
221+
--------------------------------------------------
222+
223+
.. automodule:: light_curve.light_curve_py.features.skew
224+
:members:
225+
:undoc-members:
226+
:show-inheritance:
227+
228+
light\_curve.light\_curve\_py.features.stdev module
229+
---------------------------------------------------
230+
231+
.. automodule:: light_curve.light_curve_py.features.stdev
232+
:members:
233+
:undoc-members:
234+
:show-inheritance:
235+
236+
light\_curve.light\_curve\_py.features.stetsonk module
237+
------------------------------------------------------
238+
239+
.. automodule:: light_curve.light_curve_py.features.stetsonk
240+
:members:
241+
:undoc-members:
242+
:show-inheritance:
243+
244+
light\_curve.light\_curve\_py.features.weightmean module
245+
--------------------------------------------------------
246+
247+
.. automodule:: light_curve.light_curve_py.features.weightmean
248+
:members:
249+
:undoc-members:
250+
:show-inheritance:

‎docs/light_curve.light_curve_py.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
light\_curve.light\_curve\_py package
2+
=====================================
3+
4+
.. automodule:: light_curve.light_curve_py
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Subpackages
10+
-----------
11+
12+
.. toctree::
13+
:maxdepth: 4
14+
15+
light_curve.light_curve_py.features
16+
17+
Submodules
18+
----------
19+
20+
light\_curve.light\_curve\_py.warnings module
21+
---------------------------------------------
22+
23+
.. automodule:: light_curve.light_curve_py.warnings
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:

0 commit comments

Comments
 (0)