Skip to content

Commit 9d130cd

Browse files
ndem0ndem0
committed
fix documentation
1 parent fd65de7 commit 9d130cd

File tree

17 files changed

+78
-42
lines changed

17 files changed

+78
-42
lines changed

‎docs/source/ae.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
AE
22
=====================
33

4-
.. currentmodule:: ezyrb.ae
4+
.. currentmodule:: ezyrb.reduction.ae
55

6-
.. automodule:: ezyrb.ae
6+
.. automodule:: ezyrb.reduction.ae
77

88
.. autosummary::
99
:toctree: _summaries

‎docs/source/ann.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
ANN
22
=====================
33

4-
.. currentmodule:: ezyrb.ann
4+
.. currentmodule:: ezyrb.approximation.ann
55

6-
.. automodule:: ezyrb.ann
6+
.. automodule:: ezyrb.approximation.ann
77

88
.. autosummary::
99
:toctree: _summaries

‎docs/source/code.rst‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,17 @@ Code Documentation
22
==================
33

44
.. toctree::
5-
:maxdepth: 2
5+
:maxdepth: 2
66

77
database
8+
parameter
9+
snapshot
810
approximation
911
linear
1012
rbf
1113
radius_neighbors_regressor
1214
kneighbors_regressor
15+
neighbors_regressor
1316
gpr
1417
ann
1518
reduction

‎docs/source/conf.py‎

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,7 @@
1414

1515
import sys
1616
import os
17-
import shlex
1817
import sphinx
19-
from sphinx.errors import VersionRequirementError
20-
import sphinx_rtd_theme
2118
import time
2219
import importlib.metadata
2320

@@ -32,17 +29,11 @@
3229
_DISTRIBUTION_METADATA = importlib.metadata.metadata("ezyrb")
3330
project = _DISTRIBUTION_METADATA["Name"]
3431
copyright = f'2016-{time.strftime("%Y")}, EZyRB contributors'
35-
author = _DISTRIBUTION_METADATA["Author"]
32+
author = _DISTRIBUTION_METADATA["Author-email"]
3633

3734

3835
# -- General configuration ------------------------------------------------
3936

40-
# If your documentation needs a minimal Sphinx version, state it here.
41-
needs_sphinx = '1.4'
42-
if needs_sphinx > sphinx.__display_version__:
43-
message = 'This project needs at least Sphinx v{0!s}'.format(needs_sphinx)
44-
raise VersionRequirementError(message)
45-
4637
# Add any Sphinx extension module names here, as strings. They can be
4738
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
4839
# ones.
@@ -56,14 +47,16 @@
5647
'sphinx.ext.todo',
5748
'sphinx.ext.viewcode',
5849
'sphinx.ext.coverage',
59-
'sphinx.ext.imgmath',
6050
'sphinx.ext.ifconfig',
51+
'sphinx.ext.mathjax',
6152
]
6253

63-
intersphinx_mapping = {'python': ('http://docs.python.org/2', None),
64-
'numpy': ('http://docs.scipy.org/doc/numpy/', None),
65-
'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None),
66-
'matplotlib': ('http://matplotlib.sourceforge.net/', None)}
54+
intersphinx_mapping = {
55+
"python": ("https://docs.python.org/3", None),
56+
"numpy": ("https://numpy.org/doc/stable/", None),
57+
"scipy": ("https://docs.scipy.org/doc/scipy/", None),
58+
"matplotlib": ("https://matplotlib.org/stable", None),
59+
}
6760

6861
# Add any paths that contain templates here, relative to this directory.
6962
templates_path = ['_templates']
@@ -97,7 +90,7 @@
9790
#
9891
# This is also used if you do content translation via gettext catalogs.
9992
# Usually you set "language" from the command line for these cases.
100-
language = None
93+
language = 'en'
10194

10295
# There are two options for replacing |today|: either, you set today to some
10396
# non-false value, then it is used:
@@ -142,7 +135,7 @@
142135
# classes and attributes. As side effects, this option ... ???
143136
# If false, ... ???.
144137
# The default is True.
145-
viewcode_import = True
138+
viewcode_follow_imported_members = True
146139

147140
# -- Options for HTML output ----------------------------------------------
148141

@@ -157,7 +150,7 @@
157150
#html_theme_options = {}
158151

159152
# Add any paths that contain custom themes here, relative to this directory.
160-
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
153+
# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
161154

162155
# The name for this set of Sphinx documents. If None, it defaults to
163156
# "<project> v<release> documentation".

‎docs/source/database.rst‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ Database
1010
:nosignatures:
1111

1212
Database
13-
Database.parameters
14-
Database.snapshots
1513
Database.__getitem__
1614
Database.__len__
1715
Database.add

‎docs/source/gpr.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
GPR
22
=====================
33

4-
.. currentmodule:: ezyrb.gpr
4+
.. currentmodule:: ezyrb.approximation.gpr
55

6-
.. automodule:: ezyrb.gpr
6+
.. automodule:: ezyrb.approximation.gpr
77

88
.. autosummary::
99
:toctree: _summaries

‎docs/source/kneighbors_regressor.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
KNeighborsRegressor
22
=====================
33

4-
.. currentmodule:: ezyrb.kneighbors_regressor
4+
.. currentmodule:: ezyrb.approximation.kneighbors_regressor
55

6-
.. automodule:: ezyrb.kneighbors_regressor
6+
.. automodule:: ezyrb.approximation.kneighbors_regressor
77

88
.. autosummary::
99
:toctree: _summaries

‎docs/source/linear.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
Linear
22
=====================
33

4-
.. currentmodule:: ezyrb.linear
4+
.. currentmodule:: ezyrb.approximation.linear
55

6-
.. automodule:: ezyrb.linear
6+
.. automodule:: ezyrb.approximation.linear
77

88
.. autosummary::
99
:toctree: _summaries

‎docs/source/neighbors_regressor.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
NeighborsRegressor
22
=====================
33

4-
.. currentmodule:: ezyrb.neighbors_regressor
4+
.. currentmodule:: ezyrb.approximation.neighbors_regressor
55

6-
.. automodule:: ezyrb.neighbors_regressor
6+
.. automodule:: ezyrb.approximation.neighbors_regressor
77

88
.. autosummary::
99
:toctree: _summaries

‎docs/source/parameter.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Parameter
2+
=====================
3+
4+
.. currentmodule:: ezyrb.parameter
5+
6+
.. automodule:: ezyrb.parameter
7+
8+
.. autosummary::
9+
:toctree: _summaries
10+
:nosignatures:
11+
12+
.. autoclass:: Parameter
13+
:members:
14+
:private-members:
15+
:undoc-members:
16+
:show-inheritance:
17+
:noindex:

0 commit comments

Comments
 (0)