admin, doc: introduce sphinxcontrib.seqdiag

for rendering sequence-diagram. unlike ditaa, seqdiag allows us to
create sequence-diagram without worrying about the layout. and the
syntax is quite like that of dot.

Signed-off-by: Kefu Chai <kchai@redhat.com>

diff --git a/admin/doc-requirements.txt b/admin/doc-requirements.txt
index 165255db1399eb3a2850c38a9a6eec6d663a62e7..fef7b6590c9e1758f48b14afde67c5a24933ffab 100644 (file)
--- a/admin/doc-requirements.txt
+++ b/admin/doc-requirements.txt
@@ -12,3 +12,4 @@ sphinx_rtd_theme == 0.5.2
 Sphinx-Substitution-Extensions
 typed-ast
 sphinxcontrib-openapi
+sphinxcontrib-seqdiag

diff --git a/doc/conf.py b/doc/conf.py
index f1123da387b1557a1abaf5f94ac2ba8e6ffb1452..073a7ca171e9efdb84758a2fd9d1d265a722b6d2 100644 (file)
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -121,7 +121,8 @@ extensions = [
     'ceph_commands',
     'ceph_releases',
     'ceph_confval',
-    'sphinxcontrib.openapi'
+    'sphinxcontrib.openapi',
+    'sphinxcontrib.seqdiag',
     ]
 
 ditaa = shutil.which("ditaa")
@@ -227,6 +228,10 @@ for c in pybinds:
 openapi_logger = sphinx.util.logging.getLogger('sphinxcontrib.openapi.openapi30')
 openapi_logger.setLevel(logging.WARNING)
 
+# seqdiag
+seqdiag_antialias = True
+seqdiag_html_image_format = 'SVG'
+
 # ceph_confval
 ceph_confval_imports = glob.glob(os.path.join(top_level,
                                               'src/common/options',