Skip to content

Commit 130f002

Browse files
committed
Update documentation; unpin towncrier since sphinxcontrib-towncrier supports recent towncrier version
1 parent 93df153 commit 130f002

File tree

2 files changed

+2
-3
lines changed

2 files changed

+2
-3
lines changed

doc/api/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The **dictionary** contains the following fields:
3535
* ``'metadata'`` -- dictionary containing the parsed metadata
3636
* ``'original_metadata'`` -- dictionary containing the full metadata tree from the
3737
input file
38-
* ``'file_handle'`` -- (compatible format only) the file handle when ``lazy`` is ``True`` otherwise ``None``
38+
* ``'file_handle'`` -- (compatible format only: :ref:`emd <emd-format>`, :ref:`hspy <hspy-format>`, :ref:`NeXus <nexus-format>`, :ref:`tiff <tiff-format>`, :ref:`USID <usid-format>`) the file handle when ``lazy`` is ``True`` otherwise ``None``
3939

4040
Interfacing the reader from one of the IO plugins:
4141

pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,7 @@ doc = [
117117
"sphinx-favicon",
118118
"sphinxcontrib-towncrier",
119119
"sphinx-copybutton",
120-
# unpin when sphinxcontrib-towncrier supports towncrier >=24
121-
"towncrier<24",
120+
"towncrier",
122121
"sphinx_design",
123122
]
124123
all = [

0 commit comments

Comments
 (0)