Skip to content

Commit d9494e3

Browse files
committed
Configure sphinx_toolbox.documentation_summary.
1 parent 0566d9d commit d9494e3

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

doc-source/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
"sphinx_toolbox",
4040
"sphinx_toolbox.more_autodoc",
4141
"sphinx_toolbox.more_autosummary",
42+
"sphinx_toolbox.documentation_summary",
4243
"sphinx_toolbox.tweaks.param_dash",
4344
"sphinx_toolbox.tweaks.latex_toc",
4445
"sphinx.ext.intersphinx",
@@ -116,7 +117,7 @@
116117
hide_none_rtype = True
117118
all_typevars = True
118119
overloads_location = "bottom"
119-
120+
documentation_summary = "Helpful functions for Python 🐍 🛠️"
120121

121122
autodoc_exclude_members = [ # Exclude "standard" methods.
122123
"__dict__",

doc-source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ domdf_python_tools
44

55
.. start short_desc
66
7-
**Helpful functions for Python 🐍 🛠️**
7+
.. documentation-summary::
88

99
.. end short_desc
1010

doc-source/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ sphinx-highlights>=0.1.0
1515
sphinx-notfound-page>=0.5
1616
sphinx-prompt>=1.1.0
1717
sphinx-tabs>=1.1.13
18-
sphinx-toolbox>=2.1.0
18+
sphinx-toolbox>=2.2.0
1919
sphinxcontrib-httpdomain>=1.7.0
2020
sphinxemoji>=0.1.6
2121
toctree-plus>=0.1.0

0 commit comments

Comments
 (0)