Skip to content

Commit 9e0b7e5

Browse files
committed
Add highlights to docs.
1 parent 4290294 commit 9e0b7e5

File tree

4 files changed

+16
-0
lines changed

4 files changed

+16
-0
lines changed

doc-source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252
"sphinxcontrib.toctree_plus",
5353
"seed_intersphinx_mapping",
5454
"sphinx_autofixture",
55+
"sphinx_highlights",
5556
]
5657

5758
sphinxemoji_style = "twemoji"

doc-source/index.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,19 @@ Installation
139139
.. end installation
140140
141141
142+
Highlights
143+
---------------
144+
145+
.. api-highlights::
146+
:module: domdf_python_tools
147+
:colours: blue,green,red,orange
148+
149+
.stringlist.StringList
150+
.testing.check_file_regression
151+
.paths.PathPlus
152+
.iterative.groupfloats
153+
.words.Plural
154+
142155

143156
.. toctree::
144157
:hidden:

doc-source/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ seed-intersphinx-mapping>=0.3.1
77
sphinx<3.4.0,>=3.0.3
88
sphinx-autofixture>=0.2.1
99
sphinx-copybutton>=0.2.12
10+
sphinx-highlights>=0.1.0
1011
sphinx-notfound-page>=0.5
1112
sphinx-prompt>=1.1.0
1213
sphinx-tabs>=1.1.13

repo_helper.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ mypy_deps:
6060

6161
extra_sphinx_extensions:
6262
- sphinx_autofixture
63+
- sphinx_highlights
6364

6465
tox_unmanaged:
6566
- testenv

0 commit comments

Comments
 (0)