Skip to content

Commit 808c3a7

Browse files
committed
Move readthedocs.yaml to manual pip install
2 parents 186b5ba + ec92b07 commit 808c3a7

5 files changed

Lines changed: 60 additions & 11 deletions

File tree

.mailmap

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# .mailmap - Consolidate git author identities
2+
# See: https://git-scm.com/docs/gitmailmap
3+
#
4+
# Format: Canonical Name <canonical@email.com> Old Name <old@email.com>
5+
6+
# Afshin Zade
7+
Afshin Zade <afshin.akbarzadeh@childrens.harvard.edu> afshinmessiah <afshin.akbarzadeh@childrens.harvard.edu>
8+
Afshin Zade <afshin.akbarzadeh@childrens.harvard.edu> Afshin Zade <42010605+afshinmessiah@users.noreply.github.com>
9+
10+
# Andrey Fedorov
11+
Andrey Fedorov <andrey.fedorov@gmail.com> <fedorov@bwh.harvard.edu>
12+
13+
# Christopher P. Bridge
14+
Christopher P. Bridge <chrisbridge44@googlemail.com> Chris Bridge <cbridge@partners.org>
15+
Christopher P. Bridge <chrisbridge44@googlemail.com> Christopher Bridge <cbridge@partners.org>
16+
Christopher P. Bridge <chrisbridge44@googlemail.com> Christopher Bridge <chrisbridge44@gmail.com>
17+
Christopher P. Bridge <chrisbridge44@googlemail.com> CPBridge <chrisbridge44@googlemail.com>
18+
Christopher P. Bridge <chrisbridge44@googlemail.com> Christopher P Bridge <cpb28@glacier.nmr.mgh.harvard.edu>
19+
Christopher P. Bridge <chrisbridge44@googlemail.com> Chris Bridge <chrisbridge44@googlemail.com>
20+
21+
# Dimitri Papadopoulos Orfanos
22+
Dimitri Papadopoulos Orfanos <3234522+DimitriPapadopoulos@users.noreply.github.com> Dimitri Papadopoulos <3234522+DimitriPapadopoulos@users.noreply.github.com>
23+
24+
# Erik O Gabrielsson
25+
Erik O Gabrielsson <erik.o.gabrielsson@sectra.com> erikogabrielsson <83275777+erikogabrielsson@users.noreply.github.com>
26+
Erik O Gabrielsson <erik.o.gabrielsson@sectra.com> Erik O Gabrielsson <83275777+erikogabrielsson@users.noreply.github.com>
27+
28+
# Markus D. Herrmann
29+
Markus D. Herrmann <hackermd@protonmail.com> hackermd <hackermd@protonmail.com>
30+
Markus D. Herrmann <hackermd@protonmail.com> Markus D. Herrmann <hackermd@users.noreply.github.com>
31+
Markus D. Herrmann <hackermd@protonmail.com> hackermd <markusdherrmann@gmail.com>
32+
33+
# Robin Fourcade
34+
Robin Fourcade <29704178+RobinFrcd@users.noreply.github.com> RobinFrcd <29704178+RobinFrcd@users.noreply.github.com>

.readthedocs.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,28 @@ build:
1313
os: ubuntu-24.04
1414
tools:
1515
python: "3.14"
16+
<<<<<<< HEAD
1617
jobs:
1718
install:
1819
- pip install --upgrade pip
1920
- pip install . --group 'docs'
21+
=======
22+
>>>>>>> ec92b0750055472edb2bfb1e3c4a11ad2d506df8
2023

2124
# Build documentation with MkDocs
2225
#mkdocs:
2326
# configuration: mkdocs.yml
2427

2528
# Optionally build your docs in additional formats such as PDF and ePub
2629
formats: all
30+
<<<<<<< HEAD
31+
=======
32+
33+
# Optionally set the version of Python and requirements required to build your docs
34+
python:
35+
install:
36+
- method: pip
37+
path: .
38+
dependency_groups:
39+
- docs
40+
>>>>>>> ec92b0750055472edb2bfb1e3c4a11ad2d506df8

docs/conf.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
#
1313
import os
1414
import sys
15-
import pkg_resources
1615
import datetime
16+
import importlib.metadata
1717

1818
source_dir = os.path.dirname(__file__)
1919
pkg_dir = os.path.join(source_dir, '..', '..', 'src', 'highdicom')
@@ -23,14 +23,15 @@
2323

2424
project = 'highdicom'
2525
copyright = f'2020-{datetime.datetime.now().year}, highdicom contributors'
26-
author = 'Markus D. Herrmann'
26+
author = 'Markus D. Herrmann, Christopher P. Bridge'
2727

2828
# The full version, including alpha/beta/rc tags
2929
try:
30-
release = pkg_resources.get_distribution('highdicom').version
31-
except pkg_resources.DistributionNotFound:
30+
release = importlib.metadata.version("highdicom")
31+
except importlib.metadata.PackageNotFoundError:
3232
print('Package "highdicom" must be installed to build docs.')
3333
sys.exit(1)
34+
3435
# The short X.Y version
3536
version = '.'.join(release.split('.')[:2])
3637

@@ -48,7 +49,7 @@
4849
'sphinxcontrib.autoprogram',
4950
'sphinx.ext.autodoc',
5051
'sphinx.ext.napoleon',
51-
'sphinx_autodoc_typehints',
52+
# 'sphinx_autodoc_typehints',
5253
'sphinx.ext.extlinks',
5354
]
5455

pyproject.toml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,11 @@ test = [
5656
"pytest-flake8==1.3.0",
5757
]
5858
docs = [
59-
"sphinx-autodoc-typehints==1.17.0",
60-
"sphinx-pyreverse==0.0.17",
61-
"sphinx-rtd-theme==1.0.0",
62-
"sphinxcontrib-autoprogram==0.1.7",
63-
"sphinxcontrib-websupport==1.2.4",
59+
"sphinx-autodoc-typehints==3.9.9",
60+
"sphinx-pyreverse==0.0.18",
61+
"sphinx-rtd-theme==3.1.0",
62+
"sphinxcontrib-autoprogram==0.1.9",
63+
"sphinxcontrib-websupport==2.0.0",
6464
]
6565

6666
[project.urls]

src/highdicom/seg/sop.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ def __init__(
218218
"""
219219
Parameters
220220
----------
221-
source_images: Sequence[Dataset]
221+
source_images: Sequence[pydicom.Dataset]
222222
Image(s) from which this segmentation was derived. A sequence
223223
containing either one or more single-frame images, or exactly one
224224
multi-frame image. Passing the metadata of the image(s) is

0 commit comments

Comments
 (0)