Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit883b03a

Browse files
authored
Merge pull request#1872 from EliahKagan/doc-extra
Add a "doc" extra for documentation build dependencies
2 parentsfc669cc +74df5a8 commit883b03a

File tree

4 files changed

+21
-16
lines changed

4 files changed

+21
-16
lines changed

‎.github/workflows/pythonpackage.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,5 +100,5 @@ jobs:
100100

101101
-name:Documentation
102102
run:|
103-
pip install-r doc/requirements.txt
103+
pip install".[doc]"
104104
make -C doc html

‎.readthedocs.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,5 @@ python:
3232
install:
3333
-method:pip
3434
path:.
35-
-requirements:doc/requirements.txt
35+
extra_requirements:
36+
-doc

‎setup.py

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,24 @@
11
#!/usr/bin/env python
22

3+
importos
4+
importsys
5+
frompathlibimportPath
36
fromtypingimportSequence
7+
48
fromsetuptoolsimportsetup,find_packages
59
fromsetuptools.command.build_pyimportbuild_pyas_build_py
610
fromsetuptools.command.sdistimportsdistas_sdist
7-
importos
8-
importsys
911

10-
withopen(os.path.join(os.path.dirname(__file__),"VERSION"),encoding="utf-8")asver_file:
11-
VERSION=ver_file.readline().strip()
1212

13-
withopen("requirements.txt",encoding="utf-8")asreqs_file:
14-
requirements=reqs_file.read().splitlines()
13+
def_read_content(path:str)->str:
14+
return (Path(__file__).parent/path).read_text(encoding="utf-8")
1515

16-
withopen("test-requirements.txt",encoding="utf-8")asreqs_file:
17-
test_requirements=reqs_file.read().splitlines()
1816

19-
withopen("README.md",encoding="utf-8")asrm_file:
20-
long_description=rm_file.read()
17+
version=_read_content("VERSION").strip()
18+
requirements=_read_content("requirements.txt").splitlines()
19+
test_requirements=_read_content("test-requirements.txt").splitlines()
20+
doc_requirements=_read_content("doc/requirements.txt").splitlines()
21+
long_description=_read_content("README.md")
2122

2223

2324
classbuild_py(_build_py):
@@ -48,7 +49,7 @@ def _stamp_version(filename: str) -> None:
4849
withopen(filename)asf:
4950
forlineinf:
5051
if"__version__ ="inline:
51-
line=line.replace('"git"',"'%s'"%VERSION)
52+
line=line.replace('"git"',"'%s'"%version)
5253
found=True
5354
out.append(line)
5455
exceptOSError:
@@ -64,7 +65,7 @@ def _stamp_version(filename: str) -> None:
6465
setup(
6566
name="GitPython",
6667
cmdclass={"build_py":build_py,"sdist":sdist},
67-
version=VERSION,
68+
version=version,
6869
description="GitPython is a Python library used to interact with Git repositories",
6970
author="Sebastian Thiel, Michael Trier",
7071
author_email="byronimo@gmail.com, mtrier@gmail.com",
@@ -75,7 +76,10 @@ def _stamp_version(filename: str) -> None:
7576
package_dir={"git":"git"},
7677
python_requires=">=3.7",
7778
install_requires=requirements,
78-
extras_require={"test":test_requirements},
79+
extras_require={
80+
"test":test_requirements,
81+
"doc":doc_requirements,
82+
},
7983
zip_safe=False,
8084
long_description=long_description,
8185
long_description_content_type="text/markdown",

‎tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ ignore_outcome = true
3636
[testenv:html]
3737
description = Build HTML documentation
3838
base_python = py{39,310,311,312,38,37}
39-
deps =-rdoc/requirements.txt
39+
extras = doc
4040
allowlist_externals = make
4141
commands =
4242
makeBUILDDIR={env_tmp_dir}/doc/build -C doc clean

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp