Skip to content

Commit c15e1d8

Browse files
committedJan 16, 2022
Update docs.
1 parent a079a4c commit c15e1d8

File tree

4 files changed

+6
-3
lines changed

4 files changed

+6
-3
lines changed
 

‎doc-source/requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ git+https://github.com/sphinx-toolbox/sphinx-toolbox-experimental.git
22
default-values>=0.5.0
33
domdf-sphinx-theme>=0.3.0
44
extras-require>=0.2.0
5+
html-section>=0.1.0
56
pandas>=1.1.2
67
pytest>=6.2.0
78
pytest-regressions>=2.0.2

‎domdf_python_tools/utils.py

+4-1
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,10 @@ def head(obj: Union[Tuple, List, "DataFrame", "Series", String, HasHead], n: int
410410
:param obj:
411411
:param n: Show the first ``n`` items of ``obj``.
412412
413-
.. seealso:: :func:`textwrap.shorten`, which truncates a string to fit within a given number of characters.
413+
.. seealso::
414+
415+
* :func:`textwrap.shorten`, which truncates a string to fit within a given number of characters.
416+
* :func:`itertools.islice`, which returns the first ``n`` elements from an iterator.
414417
"""
415418

416419
if isinstance(obj, tuple) and hasattr(obj, "_fields"):

‎pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ extensions = [
6363
"sphinx_debuginfo",
6464
"sphinx_licenseinfo",
6565
"seed_intersphinx_mapping",
66+
"html_section",
6667
"sphinx_autofixture",
6768
"sphinx_highlights",
68-
"sphinx_toolbox_experimental.html_section",
6969
"sphinx_toolbox_experimental.needspace",
7070
"sphinx_toolbox_experimental.autosummary_widths",
7171
"sphinx_toolbox_experimental.succinct_seealso",

‎repo_helper.yml

-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ mypy_deps:
6666
extra_sphinx_extensions:
6767
- sphinx_autofixture
6868
- sphinx_highlights
69-
- sphinx_toolbox_experimental.html_section
7069
- sphinx_toolbox_experimental.needspace
7170
- sphinx_toolbox_experimental.autosummary_widths
7271
- sphinx_toolbox_experimental.succinct_seealso

0 commit comments

Comments
 (0)
Please sign in to comment.