Parsing type hints in Sphinx documentation (#205)

* update sphinx in order to parse type hints; make flake8-docstyle numpydocstyle compatible * update deps
tinkoff-ai · Nov 24, 2021 · e66058f · e66058f
1 parent e814219
commit e66058f
Show file tree

Hide file tree

Showing 9 changed files with 82 additions and 25 deletions.
diff --git a/.flake8 b/.flake8
@@ -2,6 +2,7 @@
 ignore = F, E203, W605, E501, W503, D100, D104
 max-line-length = 121
 max-complexity = 18
+docstring-convention=numpy
 select = E, W, C, F401, N, D101, D102, D103, D200, D201, D202, D206, D207, D208, D209, D300, D400, D401, D402, D403, D404, D405, D414, D413, D417, D409
 per-file-ignores=
     __init__.py:F401
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -72,6 +72,10 @@
     "sphinx.ext.githubpages",
 ]
 
+autodoc_typehints = "both"
+autodoc_typehints_description_target = "all"
+add_module_names = False
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 

diff --git a/etna/analysis/outliers/median_outliers.py b/etna/analysis/outliers/median_outliers.py
@@ -28,7 +28,7 @@ def get_anomalies_median(
 
     Returns
     -------
-    dict of outliers: typing.Dict[str, typing.List[pd.Timestamp]]
+    :
         dict of outliers in format {segment: [outliers_timestamps]}
     """
     outliers_per_segment = {}

diff --git a/etna/analysis/plotters.py b/etna/analysis/plotters.py
@@ -333,7 +333,7 @@ def get_correlation_matrix(ts: "TSDataset", segments: Optional[List[str]] = None
     """Compute pairwise correlation of timeseries for selected segments.
 
     Parameters
-    -----------
+    ----------
     ts:
         TSDataset with timeseries data
     segments:
@@ -362,7 +362,7 @@ def plot_correlation_matrix(
     """Plot pairwise correlation heatmap for selected segments.
 
     Parameters
-    -----------
+    ----------
     ts:
         TSDataset with timeseries data
     segments:

diff --git a/etna/datasets/tsdataset.py b/etna/datasets/tsdataset.py
@@ -160,7 +160,8 @@ def make_future(self, future_steps: int) -> "TSDataset":
 
         Returns
         -------
-        dataset with features in the future.
+        :
+            dataset with features in the future.
 
         Examples
         --------

diff --git a/etna/metrics/metrics.py b/etna/metrics/metrics.py
@@ -19,7 +19,8 @@ def __init__(self, mode: str = MetricAggregationMode.per_segment, **kwargs):
         .. math::
             MAE(y\_true, y\_pred) = \\frac{\\sum_{i=0}^{n-1}{\\mid y\_true_i - y\_pred_i \\mid}}{n}
 
-        Notes:
+        Notes
+        -----
         You can read more about logic of multi-segment metrics in Metric docs.
 
         Parameters

diff --git a/etna/transforms/special_days.py b/etna/transforms/special_days.py
@@ -37,7 +37,7 @@ def __init__(self, find_special_weekday: bool = True, find_special_month_day: bo
             flag, if True, find special monthdays in transform
 
         Raises
-        ----------
+        ------
         ValueError:
             if all the modes are False
         """
@@ -179,7 +179,7 @@ def __init__(self, find_special_weekday: bool = True, find_special_month_day: bo
             flag, if True, find special monthdays in transform
 
         Raises
-        ----------
+        ------
         ValueError:
             if all the modes are False
         """

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -51,6 +51,7 @@ loguru = "^0.5.3"
 saxpy = "^1.0.1-dev167"
 hydra-slayer = "^0.2.0"
 typer = "^0.4.0"
+omegaconf = "^2.1.1"
 
 prophet = {version = "^1.0", optional = true}
 
@@ -61,10 +62,10 @@ wandb = {version = "^0.12.2", optional = true}
 
 sphinx-mathjax-offline = {version = "^0.0.1", optional = true}
 nbsphinx = {version = "^0.8.2", optional = true}
-Sphinx = {version = "^3.5.1", optional = true}
+Sphinx = {version = "^4.1", optional = true}
 numpydoc = {version = "^1.1.0", optional = true}
 sphinx-rtd-theme = {version = "^0.5.1", optional = true}
-myst-parser = {version = "^0.14.0", optional = true}
+myst-parser = {version = "^0.15.0", optional = true}
 GitPython = {version = "^3.1.20", optional = true}
 
 pytest = {version = "^6.2", optional = true}
@@ -86,7 +87,6 @@ ipywidgets = {version = "^7.6.5", optional = true}
 
 jupyter = {version = "*", optional = true}
 nbconvert = {version = "*", optional = true}
-omegaconf = "^2.1.1"
 
 [tool.poetry.extras]
 # optional deps
@@ -154,4 +154,4 @@ line_length = 120
 
 [build-system]
 requires = ["poetry>=0.12"]
-build-backend = "poetry.masonry.api"
+build-backend = "poetry.masonry.api"