Skip to content
This repository was archived by the owner on Mar 4, 2022. It is now read-only.

Commit 76c725b

Browse files
otorrenootorreno
authored
Fix/documentation rtfd (#1)
* Missing author in the LaTeX metadata was causing readthedocs documentation build to fail * Fixing documentation causing LaTeX compilation issues * Fix typo
1 parent 99e8b9d commit 76c725b

File tree

17 files changed

+329
-293
lines changed

17 files changed

+329
-293
lines changed

‎docs/source/conf.py‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@
1818

1919
sys.path.insert(0, os.path.abspath('../..'))
2020

21-
22-
2321
# -- Project information -----------------------------------------------------
2422

2523
project = 'khiva'
@@ -31,7 +29,6 @@
3129
# The full version, including alpha/beta/rc tags
3230
release = subprocess.check_output(["git", "describe"]).strip().decode("utf-8").split('-')[0]
3331

34-
3532
# -- General configuration ---------------------------------------------------
3633

3734
# If your documentation needs a minimal Sphinx version, state it here.
@@ -73,7 +70,6 @@
7370
# The name of the Pygments (syntax highlighting) style to use.
7471
pygments_style = 'sphinx'
7572

76-
7773
# -- Options for HTML output -------------------------------------------------
7874

7975
# The theme to use for HTML and HTML Help pages. See the documentation for
@@ -108,7 +104,6 @@
108104
# Output file base name for HTML help builder.
109105
htmlhelp_basename = 'khivadoc'
110106

111-
112107
# -- Options for LaTeX output ------------------------------------------------
113108

114109
latex_elements = {
@@ -133,10 +128,9 @@
133128
# (source start file, target name, title,
134129
# author, documentclass [howto, manual, or own class]).
135130
latex_documents = [
136-
(master_doc, 'khiva.tex', 'khiva Documentation', 'manual'),
131+
(master_doc, 'khiva.tex', 'khiva Documentation', 'Shapelets.io', 'manual'),
137132
]
138133

139-
140134
# -- Options for manual page output ------------------------------------------
141135

142136
# One entry per manual page. List of tuples
@@ -146,7 +140,6 @@
146140
[author], 1)
147141
]
148142

149-
150143
# -- Options for Texinfo output ----------------------------------------------
151144

152145
# Grouping the document tree into Texinfo files. List of tuples
@@ -158,4 +151,4 @@
158151
'Miscellaneous'),
159152
]
160153

161-
# -- Extension configuration -------------------------------------------------
154+
# -- Extension configuration -------------------------------------------------

‎docs/source/text/quick_start.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Quick Start
77
Install khiva
88
---------------
99

10-
First of all, the KHIVA C++ library should be installed by using the installer that we offer in wwww.shapelets.io
10+
First of all, the KHIVA C++ library should be installed by using the installer that we offer in http://www.shapelets.io
1111

1212
Then, the compiled KHIVA package is hosted on the Python Package Index (PyPI) so it can be installed with pip:
1313

‎khiva/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@
1616
from khiva.polynomial import *
1717
from khiva.regression import *
1818
from khiva.regularization import *
19-
from khiva.statistics import *
19+
from khiva.statistics import *

‎khiva/array.py‎

Lines changed: 114 additions & 82 deletions
Large diffs are not rendered by default.

‎khiva/dimensionality.py‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ def paa(a, bins):
3434
"""
3535
b = ctypes.c_void_p(0)
3636
KhivaLibrary().c_khiva_library.paa(ctypes.pointer(a.arr_reference), ctypes.pointer(ctypes.c_int(bins)),
37-
ctypes.pointer(b))
37+
ctypes.pointer(b))
3838

3939
return Array(array_reference=b)
4040

@@ -52,7 +52,7 @@ def pip(a, number_ips):
5252
"""
5353
b = ctypes.c_void_p(0)
5454
KhivaLibrary().c_khiva_library.pip(ctypes.pointer(a.arr_reference), ctypes.pointer(ctypes.c_int(number_ips)),
55-
ctypes.pointer(b))
55+
ctypes.pointer(b))
5656

5757
return Array(array_reference=b)
5858

@@ -71,8 +71,8 @@ def pla_bottom_up(ts, max_error):
7171
"""
7272
b = ctypes.c_void_p(0)
7373
KhivaLibrary().c_khiva_library.pla_bottom_up(ctypes.pointer(ts.arr_reference),
74-
ctypes.pointer(ctypes.c_float(max_error)),
75-
ctypes.pointer(b))
74+
ctypes.pointer(ctypes.c_float(max_error)),
75+
ctypes.pointer(b))
7676

7777
return Array(array_reference=b)
7878

@@ -91,8 +91,8 @@ def pla_sliding_window(ts, max_error):
9191
"""
9292
b = ctypes.c_void_p(0)
9393
KhivaLibrary().c_khiva_library.pla_sliding_window(ctypes.pointer(ts.arr_reference),
94-
ctypes.pointer(ctypes.c_float(max_error)),
95-
ctypes.pointer(b))
94+
ctypes.pointer(ctypes.c_float(max_error)),
95+
ctypes.pointer(b))
9696

9797
return Array(array_reference=b)
9898

@@ -116,8 +116,8 @@ def ramer_douglas_peucker(a, epsilon):
116116
"""
117117
b = ctypes.c_void_p(0)
118118
KhivaLibrary().c_khiva_library.ramer_douglas_peucker(ctypes.pointer(a.arr_reference),
119-
ctypes.pointer(ctypes.c_double(epsilon)),
120-
ctypes.pointer(b))
119+
ctypes.pointer(ctypes.c_double(epsilon)),
120+
ctypes.pointer(b))
121121

122122
return Array(array_reference=b)
123123

@@ -141,7 +141,7 @@ def sax(a, alphabet_size):
141141
"""
142142
b = ctypes.c_void_p(0)
143143
KhivaLibrary().c_khiva_library.sax(ctypes.pointer(a.arr_reference), ctypes.pointer(ctypes.c_int(alphabet_size)),
144-
ctypes.pointer(b))
144+
ctypes.pointer(b))
145145

146146
return Array(array_reference=b)
147147

@@ -161,7 +161,7 @@ def visvalingam(a, num_points):
161161
"""
162162
b = ctypes.c_void_p(0)
163163
KhivaLibrary().c_khiva_library.visvalingam(ctypes.pointer(a.arr_reference),
164-
ctypes.pointer(ctypes.c_int(num_points)),
165-
ctypes.pointer(b))
164+
ctypes.pointer(ctypes.c_int(num_points)),
165+
ctypes.pointer(b))
166166

167167
return Array(array_reference=b)

‎khiva/distances.py‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def euclidean(tss):
2626
"""
2727
b = ctypes.c_void_p(0)
2828
KhivaLibrary().c_khiva_library.euclidean(ctypes.pointer(tss.arr_reference),
29-
ctypes.pointer(b))
29+
ctypes.pointer(b))
3030
return Array(array_reference=b)
3131

3232

@@ -41,7 +41,7 @@ def dtw(tss):
4141
"""
4242
b = ctypes.c_void_p(0)
4343
KhivaLibrary().c_khiva_library.dtw(ctypes.pointer(tss.arr_reference),
44-
ctypes.pointer(b))
44+
ctypes.pointer(b))
4545
return Array(array_reference=b)
4646

4747

@@ -56,7 +56,7 @@ def hamming(tss):
5656
"""
5757
b = ctypes.c_void_p(0)
5858
KhivaLibrary().c_khiva_library.hamming(ctypes.pointer(tss.arr_reference),
59-
ctypes.pointer(b))
59+
ctypes.pointer(b))
6060
return Array(array_reference=b)
6161

6262

@@ -71,7 +71,7 @@ def manhattan(tss):
7171
"""
7272
b = ctypes.c_void_p(0)
7373
KhivaLibrary().c_khiva_library.manhattan(ctypes.pointer(tss.arr_reference),
74-
ctypes.pointer(b))
74+
ctypes.pointer(b))
7575
return Array(array_reference=b)
7676

7777

@@ -86,6 +86,5 @@ def squared_euclidean(tss):
8686
"""
8787
b = ctypes.c_void_p(0)
8888
KhivaLibrary().c_khiva_library.squared_euclidean(ctypes.pointer(tss.arr_reference),
89-
ctypes.pointer(b))
89+
ctypes.pointer(b))
9090
return Array(array_reference=b)
91-

0 commit comments

Comments
 (0)