From: Sebastian Wagner <sebastian.wagner@suse.com>
Date: Thu, 27 Feb 2020 12:16:00 +0000 (+0100)
Subject: doc: Add sphinx_autodoc_typehints extension
X-Git-Tag: v15.1.1~226^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=30d415974c5a5165098d33e25cac45979de1ea86;p=ceph-ci.git

doc: Add sphinx_autodoc_typehints extension

`mgr/orchestrator_modules.rst` makes heavy use type hints.

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
---

diff --git a/admin/doc-requirements.txt b/admin/doc-requirements.txt
index 16f3766784f..d52f8dee0ed 100644
--- a/admin/doc-requirements.txt
+++ b/admin/doc-requirements.txt
@@ -4,3 +4,5 @@ breathe == 4.14.0
 pyyaml >= 5.1.2
 Cython
 prettytable
+sphinx-autodoc-typehints
+typed-ast
diff --git a/doc/conf.py b/doc/conf.py
index f22871dca34..f5fb6ffc975 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -48,6 +48,7 @@ sys.path.insert(0, os.path.abspath('_ext'))
 
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx_autodoc_typehints',
     'sphinx.ext.graphviz',
     'sphinx.ext.todo',
     'sphinxcontrib.ditaa',