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

Commit62567fc

Browse files
authored
docs: Render changes in sphinx-autoissues (#396)
2 parents6211d0e +0dafcf4 commit62567fc

File tree

4 files changed

+65
-71
lines changed

4 files changed

+65
-71
lines changed

‎CHANGES‎

Lines changed: 45 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,12 @@ $ pip install --user --upgrade --pre libvcs
1515

1616
###Development
1717

18-
- Remove`.pre-commit-config.yaml`: This can be done less obtrusively via flake8
19-
and having the user run the tools themselves.
18+
- Remove`.pre-commit-config.yaml`: This can be done less obtrusively via flake8 and having the user
19+
run the tools themselves.
20+
21+
###Documentation
22+
23+
- Render changelog in sphinx-autoissues (#396)
2024

2125
##libvcs 0.14.0 (2022-07-31)
2226

@@ -25,12 +29,11 @@ $ pip install --user --upgrade --pre libvcs
2529
- New and improved logo
2630
-**Improved typings**
2731

28-
Now[`mypy --strict`] compliant ({issue}`390`)
32+
Now[`mypy --strict`] compliant (#390)
2933

3034
[`mypy --strict`]:https://mypy.readthedocs.io/en/stable/command_line.html#cmdoption-mypy-strict
3135

32-
-**Parser**: Experimental VCS URL parsing added ({issue}`376`, {issue}`381`, {issue}`384`,
33-
{issue}`386`):
36+
-**Parser**: Experimental VCS URL parsing added (#376,#381,#384,#386):
3437

3538
VCS Parsers return {func}`dataclasses.dataclass` instances. The new tools support validation,
3639
parsing, mutating and exporting into URLs consumable by the VCS.
@@ -74,16 +77,16 @@ $ pip install --user --upgrade --pre libvcs
7477

7578
###Breaking changes
7679

77-
-{issue}`391` Removed`flat` keyword argument for {class}`libvcs.projects.git.GitProject`. This was
78-
unusedand the equivalent can be retrieved via`.to_dict()` on`GitRemote`
79-
-{issue}`379` Support for`git+git` URLs removed. Pip removed these in 21.0 due to them being
80-
insecure[^pip-git+git]
81-
-{issue}`372` Typings moved from`libvcs.types` -> {mod}`libvcs._internal.types`
82-
-{issue}`377` Remove deprecated functions and exceptions
80+
-#391 Removed`flat` keyword argument for {class}`libvcs.projects.git.GitProject`. This was unused
81+
and the equivalent can be retrieved via`.to_dict()` on`GitRemote`
82+
-#379 Support for`git+git` URLs removed. Pip removed these in 21.0 due to them being insecure
83+
[^pip-git+git]
84+
-#372 Typings moved from`libvcs.types` -> {mod}`libvcs._internal.types`
85+
-#377 Remove deprecated functions and exceptions
8386

8487
- Removed`libvcs.shortcuts`
8588
- Removed`libvcs.shortcuts.create_project_from_pip_url()`: This will be replaced in future
86-
versions by{issue}`376` / parsing utilities
89+
versions by#376 / parsing utilities
8790
- Moved`libvcs.shortcuts.create_project()` to {func}`libvcs._internal.shortcuts.create_project`
8891
- Removed {exc}`libvcs.exc.InvalidPipURL`
8992

@@ -109,8 +112,8 @@ $ pip install --user --upgrade --pre libvcs
109112

110113
###Cleanup
111114

112-
-{issue}`378` {issue}`380` Remove duplicate`uses_netloc` scheme for`git+ssh` (this was in cpython
113-
since 2.7 / 3.1[^git+ssh][^python:bugs:8657])
115+
-#378#380 Remove duplicate`uses_netloc` scheme for`git+ssh` (this was in cpython since 2.7 / 3.1
116+
[^git+ssh][^python:bugs:8657])
114117

115118
[^git+ssh]:`uses_netloc` added`'git'` and`'git+ssh'` in {mod}`urllib.parse`
116119

@@ -164,8 +167,7 @@ $ pip install --user --upgrade --pre libvcs
164167

165168
###Breaking changes
166169

167-
- {issue}`343`:`libvcs.cmd.core` moved to`libvcs._internal.run` to make it more clear the API is
168-
closed.
170+
-#343:`libvcs.cmd.core` moved to`libvcs._internal.run` to make it more clear the API is closed.
169171

170172
This includes {func}`~libvcs._internal.run.run`
171173

@@ -181,7 +183,7 @@ $ pip install --user --upgrade --pre libvcs
181183
from libvcs._internal.runimport run
182184
```
183185

184-
-{issue}`361`: {class}`~libvcs._internal.run.run`'s params are now a pass-through to
186+
-#361: {class}`~libvcs._internal.run.run`'s params are now a pass-through to
185187
{class}`subprocess.Popen`.
186188

187189
-`run(cmd, ...)` is now`run(args, ...)` to match`Popen`'s convention.
@@ -198,9 +200,9 @@ $ pip install --user --upgrade --pre libvcs
198200

199201
- Keyword-only arguments via[PEP 3102],[PEP 570]
200202

201-
-{issue}`366`:`libvcs.cmd` for hg, git, and svn updated to use
203+
-#366:`libvcs.cmd` for hg, git, and svn updated to use
202204

203-
-{issue}`364`: Project classes no longer accept positional arguments.
205+
-#364: Project classes no longer accept positional arguments.
204206

205207
Deprecated in >=0.13:
206208

@@ -219,27 +221,27 @@ $ pip install --user --upgrade --pre libvcs
219221

220222
### What's new
221223

222-
-**Commands**: Experimental command wrappers added ({issue}`346`):
224+
-**Commands**: Experimental command wrappers added (#346):
223225

224226
- {class}`libvcs.cmd.git.Git`
225227

226228
- {meth}`libvcs.cmd.git.Git.help`
227229
- {meth}`libvcs.cmd.git.Git.reset`
228230
- {meth}`libvcs.cmd.git.Git.checkout`
229231
- {meth}`libvcs.cmd.git.Git.status`
230-
- {meth}`libvcs.cmd.git.Git.config` via{issue}`360`
232+
- {meth}`libvcs.cmd.git.Git.config` via#360
231233

232234
-**Command**: Now support`-C` (which accepts`.git` dirs, see git's manual) in addition to `cwd`
233-
(subprocess-passthrough),{issue}`360`
235+
(subprocess-passthrough),#360
234236

235237
### Bug fixes
236238

237239
- Fix argumentinputfor commands, e.g.`git config--get color.diff` wouldnot properly
238-
pass-through to subprocess. git:{issue}`360`, svnand hg:{issue}`365`
240+
pass-through to subprocess. git:#360, svn and hg:#365
239241

240242
### Internals
241243

242-
-{issue}`362` [mypy] support added:
244+
-#362 [mypy] support added:
243245

244246
- Basic mypy tests nowpass
245247
- Type annotations added, including improved typingsfor:
@@ -252,12 +254,11 @@ $ pip install --user --upgrade --pre libvcs
252254
-`make mypy`and`make watch_mypy`
253255
- Automatic checking onCI
254256

255-
- {issue}`345``libvcs.utils`->`libvcs._internal` to make it more obvious the APIs are strictly
256-
closed.
257+
-#345 `libvcs.utils` -> `libvcs._internal` to make it more obvious the APIs are strictly closed.
257258
-`StrOrPath`->`StrPath`
258-
-{issue}`336`: {class}`~libvcs._internal.subprocess.SubprocessCommand`: Encapsulated
259-
{mod}`subprocess` callin a {func}`dataclasses.dataclass`for introspecting, modifying, mocking
260-
and controllingexecution.
259+
-#336: {class}`~libvcs._internal.subprocess.SubprocessCommand`: Encapsulated {mod}`subprocess` call
260+
in a {func}`dataclasses.dataclass`for introspecting, modifying, mockingand controlling
261+
execution.
261262
- Dataclass helper: {class}`~libvcs._internal.dataclasses.SkipDefaultFieldsReprMixin`
262263

263264
Skip default fieldsinobject representations.
@@ -268,7 +269,7 @@ $ pip install --user --upgrade --pre libvcs
268269
### Documentation
269270

270271
- Document`libvcs.types`
271-
-{issue}`362`: Improve developer documentation to note [mypy]and have tabbed examplesfor flake8.
272+
-#362: Improve developer documentation to note [mypy] and have tabbed examples for flake8.
272273

273274
[mypy]: http://mypy-lang.org/
274275

@@ -279,14 +280,14 @@ $ pip install --user --upgrade --pre libvcs
279280
## libvcs 0.12.4 (2022-05-30)
280281

281282
- _Backportfrom0.13.x_ Fix argumentinputfor hgand svn commands, wouldnot properlypass-through
282-
to subprocess.{issue}`365`
283+
to subprocess.#365
283284

284285
## libvcs 0.12.3 (2022-05-28)
285286

286287
### Bug fixes
287288

288289
- _Backportfrom0.13.x_. Fix argumentinputfor git commands, e.g.`git config--get color.diff`
289-
wouldnot properlypass-through to subprocess.{issue}`360`
290+
wouldnot properlypass-through to subprocess.#360
290291

291292
## libvcs 0.12.2 (2022-05-10)
292293

@@ -306,7 +307,7 @@ $ pip install --user --upgrade --pre libvcs
306307
### Breaking
307308

308309
-`GitRepo`,`SVNRepo`,`MercurialRepo`,`BaseRepo` have been renamed to`GitProject`,`SVNProject`,
309-
`MercurialProject`,`BaseProject` ({issue}`327`)
310+
`MercurialProject`,`BaseProject` (#327)
310311
-`GitProject`,`SVNProject`,`MercurialProject`,`BaseProject` have been moved to
311312
`libvcs.projects.{module}.{Module}Project`
312313
-`repo_dir` paramis renamed to`dir`:
@@ -315,19 +316,19 @@ $ pip install --user --upgrade --pre libvcs
315316

316317
After:`GitProject(url='...',dir='...')`
317318

318-
{issue}`324`
319+
#324
319320

320321
-`dir` to`pathlib`,`BaseProject.path`->`BaseProject.dir`
321-
- Logging functions moved to {attr}`libvcs.projects.base.BaseProject.log` ({issue}`322`)
322+
- Logging functions moved to {attr}`libvcs.projects.base.BaseProject.log` (#322)
322323
- Rename`ProjectLoggingAdapter` to`CmdLoggingAdapter`
323324
-`CmdLoggingAdapter`: Rename`repo_name` param to`keyword`
324325
-`create_repo`->`create_project`
325-
-`GitRemote`and`GitStatus`: Move to {func}`dataclasses.dataclass` ({issue}`329`)
326-
-`extract_status()`: Move to`GitStatus.from_stdout` ({issue}`329`)
326+
-`GitRemote`and`GitStatus`: Move to {func}`dataclasses.dataclass` (#329)
327+
-`extract_status()`: Move to`GitStatus.from_stdout` (#329)
327328

328329
### What's new
329330

330-
-**Commands**: Experimental command wrappers added ({issue}`319`):
331+
-**Commands**: Experimental command wrappers added (#319):
331332

332333
- {class}`libvcs.cmd.git.Git`
333334

@@ -388,10 +389,10 @@ $ pip install --user --upgrade --pre libvcs
388389

389390
### Development
390391

391-
- Add codeql analysis ({issue}`303`)
392-
- git test suite: Lots of parametrization ({issue}`309`)
392+
- Add codeql analysis (#303)
393+
- git test suite: Lots of parametrization (#309)
393394
-CI: Use poetry cachingfrom
394-
[@actions/setup v3.1](https://github.com/actions/setup-python/releases/tag/v3.1.0), ({issue}`316`)
395+
[@actions/setup v3.1](https://github.com/actions/setup-python/releases/tag/v3.1.0), (#316)
395396
- New constantsfor`str`->class mappings
396397

397398
- {data}`libvcs.projects.constants.DEFAULT_VCS_CLASS_MAP`
@@ -401,14 +402,14 @@ $ pip install --user --upgrade --pre libvcs
401402
- Remove toxand tox-poetry-installer. It turns out installing poetry inside a poetry project
402403
doesn't work well. (`poetry update`, `poetry publish`, etc. commands would fail)
403404
- Add [doctest](https://docs.python.org/3/library/doctest.html) w/
404-
[pytest+ doctest](https://docs.pytest.org/en/7.1.x/how-to/doctest.html), ({issue}`321`).
405+
[pytest+ doctest](https://docs.pytest.org/en/7.1.x/how-to/doctest.html), (#321).
405406
- Publish to PyPI viaCI when git tags areset.
406407

407408
### Documentation
408409

409410
-API: Split documentation of modules to separate pages
410-
- Fix sphinx-issues ({issue}`321`)
411-
- Experimentwith sphinx-autoapi ({issue}`328`)for table of contents support
411+
- Fix sphinx-issues (#321)
412+
- Experimentwith sphinx-autoapi (#328) for table of contents support
412413

413414
## libvcs 0.11.1 (2022-03-12)
414415

‎docs/conf.py‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
"sphinx.ext.todo",
2929
"sphinx.ext.linkcode",
3030
"sphinx_inline_tabs",
31-
"sphinx_issues",
31+
"sphinx_autoissues",
3232
"sphinx_copybutton",
3333
"sphinxext.opengraph",
3434
"sphinxext.rediraffe",
@@ -86,6 +86,10 @@
8686
]
8787
}
8888

89+
# sphinx-autoissues
90+
issuetracker="github"
91+
issuetracker_project="vcs-python/libvcs"
92+
8993
# sphinx.ext.autodoc
9094
autoclass_content="both"
9195
autodoc_member_order="bysource"
@@ -116,9 +120,6 @@
116120
copybutton_prompt_is_regexp=True
117121
copybutton_remove_prompts=True
118122

119-
# sphinx-issues
120-
issues_github_path="vcs-python/libvcs"
121-
122123
# sphinxext-rediraffe
123124
rediraffe_redirects="redirects.txt"
124125
rediraffe_branch="master~1"

‎poetry.lock‎

Lines changed: 13 additions & 21 deletions
Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

‎pyproject.toml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,12 @@ sphinx = "*"
6767
furo ="*"
6868
sphinx-autobuild ="*"
6969
sphinx-autodoc-typehints ="*"
70-
sphinx-issues ="*"
7170
sphinx-inline-tabs ="*"
7271
sphinxext-opengraph ="*"
7372
sphinx-copybutton ="*"
7473
sphinxext-rediraffe ="*"
7574
sphinx-autoapi ="*"
75+
sphinx-autoissues ="*"
7676
myst_parser ="*"
7777

7878
### Testing ###
@@ -98,14 +98,14 @@ mypy = "*"
9898
[tool.poetry.extras]
9999
docs = [
100100
"sphinx",
101-
"sphinx-issues",
102101
"sphinx-autoapi",
103102
"sphinx-autodoc-typehints",
104103
"sphinx-autobuild",
105104
"sphinx-copybutton",
106105
"sphinxext-opengraph",
107106
"sphinx-inline-tabs",
108107
"sphinxext-rediraffe",
108+
"sphinx-autoissues",
109109
"myst_parser",
110110
"furo",
111111
]

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp