Skip to content

Commit 682d9cd

Browse files
authored
docs: Render changes in sphinx-autoissues (#378)
2 parents f9278bb + 77f0586 commit 682d9cd

File tree

4 files changed

+29
-32
lines changed

4 files changed

+29
-32
lines changed

CHANGES

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ $ pipx install --suffix=@next 'vcspull' --pip-args '\--pre' --force
2929
- Remove `.pre-commit-config.yaml`: Let's not automate what the contributor could /
3030
should do themselves.
3131

32+
### Documentation
33+
34+
- Render changelog in sphinx-autoissues (#378)
35+
3236
### Bug fixes
3337

3438
- Fix cloning of mercurial repositories
@@ -63,21 +67,21 @@ Patch branch: [`v1.12.x`](https://github.com/vcs-python/vcspull/tree/v1.12.x)
6367
### Breaking changes
6468

6569
- Config location uses `XDG_CONFIG_HOME` from [XDG Base Directory],
66-
({issue}`367`).
70+
(#367).
6771

6872
Old path: `~/.vcspull`
6973

7074
New path: `XDG_CONFIG_HOME`, usually `~/.config/vcspull`
7175

7276
[xdg base directory]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
7377

74-
- Override config directory via `VCSPULL_CONFIGDIR` ({issue}`367`)
75-
- Switch from `str` to `pathlib.Path` ({issue}`364`)
78+
- Override config directory via `VCSPULL_CONFIGDIR` (#367)
79+
- Switch from `str` to `pathlib.Path` (#364)
7680
- Requires click 8+
7781

7882
### Compatibility
7983

80-
- Allow click 8.1.x ({issue}`372`)
84+
- Allow click 8.1.x (#372)
8185
- vcspull learned `-h` for help (thanks HN 2022-04-11)
8286
- Python 3.7 and 3.8 dropped (#356)
8387

@@ -118,7 +122,7 @@ Patch branch: [`v1.12.x`](https://github.com/vcs-python/vcspull/tree/v1.12.x)
118122

119123
### Compatibility
120124

121-
- Allow click 8.1.x (backport of {issue}`372`)
125+
- Allow click 8.1.x (backport of #372)
122126

123127
## vcspull 1.11.3 (2022-04-11)
124128

docs/conf.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
"sphinx.ext.todo",
2424
"sphinx.ext.napoleon",
2525
"sphinx.ext.linkcode",
26-
"sphinx_issues",
26+
"sphinx_autoissues",
2727
"sphinx_click.ext", # sphinx-click
2828
"sphinx_inline_tabs",
2929
"sphinx_copybutton",
@@ -83,6 +83,10 @@
8383
]
8484
}
8585

86+
# sphinx-autoissues
87+
issuetracker = "github"
88+
issuetracker_project = "vcs-python/vcspull"
89+
8690
# sphinx.ext.autodoc
8791
autoclass_content = "both"
8892
autodoc_member_order = "bysource"
@@ -109,9 +113,6 @@
109113
copybutton_prompt_is_regexp = True
110114
copybutton_remove_prompts = True
111115

112-
# sphinx-issues
113-
issues_github_path = "vcs-python/vcspull"
114-
115116
# sphinxext-rediraffe
116117
rediraffe_redirects = "redirects.txt"
117118
rediraffe_branch = "master~1"

poetry.lock

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

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@ sphinx-autoapi = "*"
6868
sphinx-autobuild = "*"
6969
sphinx-autodoc-typehints = "*"
7070
sphinx-click = "*"
71-
sphinx-issues = "*"
7271
sphinx-inline-tabs = "*"
7372
sphinxext-opengraph = "*"
7473
sphinx-copybutton = "*"
7574
sphinxext-rediraffe = "*"
75+
sphinx-autoissues = "*"
7676
myst_parser = "*"
7777

7878
### Testing ###
@@ -96,13 +96,13 @@ mypy = "*"
9696
[tool.poetry.extras]
9797
docs = [
9898
"sphinx",
99-
"sphinx-issues",
10099
"sphinx-click",
101100
"sphinx-autoapi",
102101
"sphinx-autodoc-typehints",
103102
"sphinx-autobuild",
104103
"sphinxext-rediraffe",
105104
"sphinx-copybutton",
105+
"sphinx-autoissues",
106106
"sphinxext-opengraph",
107107
"sphinx-inline-tabs",
108108
"myst_parser",

0 commit comments

Comments
 (0)