From eb1f1edbd595c8fdbe25e9b693030e95fec38816 Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Fri, 26 Jun 2020 14:49:32 -0400 Subject: [PATCH] Add support for sphinx-tabs extension This extension allows us to use code tabs in docs. Change-Id: I5e57e5056d5b6abc05842aa37ad6b7fadfe94ca8 Ref: https://github.com/djungelorm/sphinx-tabs Signed-off-by: Thanh Ha --- docs_conf/defaults/default.yaml | 1 + docs_conf/defaults/lfdocs.yaml | 1 + docs_conf/defaults/opendaylight.yaml | 1 + releasenotes/notes/support-sphinx-tabs-7a9e3e9ed2a7795a.yaml | 4 ++++ requirements.txt | 1 + 5 files changed, 8 insertions(+) create mode 100644 releasenotes/notes/support-sphinx-tabs-7a9e3e9ed2a7795a.yaml diff --git a/docs_conf/defaults/default.yaml b/docs_conf/defaults/default.yaml index a04e982..bcf0140 100644 --- a/docs_conf/defaults/default.yaml +++ b/docs_conf/defaults/default.yaml @@ -13,6 +13,7 @@ extensions: - sphinx.ext.todo - sphinx.ext.coverage - sphinx.ext.viewcode + - sphinx_tabs.tabs exclude_patterns: - .DS_Store - _build diff --git a/docs_conf/defaults/lfdocs.yaml b/docs_conf/defaults/lfdocs.yaml index 5227262..12d0315 100644 --- a/docs_conf/defaults/lfdocs.yaml +++ b/docs_conf/defaults/lfdocs.yaml @@ -13,6 +13,7 @@ extensions: - sphinx.ext.todo - sphinx.ext.coverage - sphinx.ext.viewcode + - sphinx_tabs.tabs exclude_patterns: - .DS_Store - _build diff --git a/docs_conf/defaults/opendaylight.yaml b/docs_conf/defaults/opendaylight.yaml index 65c3a0b..2998551 100644 --- a/docs_conf/defaults/opendaylight.yaml +++ b/docs_conf/defaults/opendaylight.yaml @@ -14,6 +14,7 @@ extensions: - sphinx.ext.todo - sphinx.ext.coverage - sphinx.ext.viewcode + - sphinx_tabs.tabs exclude_patterns: - .DS_Store - _build diff --git a/releasenotes/notes/support-sphinx-tabs-7a9e3e9ed2a7795a.yaml b/releasenotes/notes/support-sphinx-tabs-7a9e3e9ed2a7795a.yaml new file mode 100644 index 0000000..5e809ef --- /dev/null +++ b/releasenotes/notes/support-sphinx-tabs-7a9e3e9ed2a7795a.yaml @@ -0,0 +1,4 @@ +--- +features: + - | + Add support for sphinx-tabs (https://github.com/djungelorm/sphinx-tabs). diff --git a/requirements.txt b/requirements.txt index 3b53a6e..b6148ef 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,6 +2,7 @@ pytest pyyaml Sphinx~=3.0.4 sphinx_bootstrap_theme~=0.7.1 +sphinx-tabs # Indirect Dependencies # >6.0.0 requires Python >=3.4 -- 2.16.6