From 1a36bf82fc5fa30052498b33c2f7135aa0c52095 Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Mon, 2 Aug 2021 19:00:35 +0800 Subject: [PATCH] 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 --- admin/doc-requirements.txt | 1 + doc/conf.py | 7 ++++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/admin/doc-requirements.txt b/admin/doc-requirements.txt index 165255db1399e..fef7b6590c9e1 100644 --- 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 f1123da387b15..073a7ca171e9e 100644 --- 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', -- 2.39.5