Skip to content

Commit 1727f6f

Browse files
committed
fix: changelog in source dir
1 parent 2d96632 commit 1727f6f

File tree

8 files changed

+17
-7
lines changed

8 files changed

+17
-7
lines changed

doc/source/changelog.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Release notes
2+
#############
3+
4+
This document contains the release notes for the |project| project.
5+
6+
.. vale off
7+
8+
.. towncrier release notes start
9+
10+
.. vale on
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

doc/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,4 @@ The Ansys tools project is a collection of tools for the PyAnsys ecosystem.
4848
user_guide/index
4949
api/index
5050
contributing
51+
changelog

pyproject.toml

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -103,13 +103,12 @@ addopts = "-ra --cov=ansys.tools.common --cov-report html:.cov/html --cov-report
103103

104104
[tool.towncrier]
105105
package = "ansys.tools.common"
106-
directory = "doc/changelog.d"
107-
filename = "CHANGELOG.md"
108-
start_string = "<!-- towncrier release notes start -->\n"
109-
underlines = [ "", "", "" ]
110-
template = "doc/changelog.d/changelog_template.jinja"
111-
title_format = "## [{version}](https://github.com/ansys/ansys-tools-common/releases/tag/v{version}) - {project_date}"
112-
issue_format = "[#{issue}](https://github.com/ansys/ansys-tools-common/pull/{issue})"
106+
directory = "doc/source/changelog"
107+
filename = "doc/source/changelog.rst"
108+
start_string = ".. towncrier release notes start\n"
109+
template = "doc/changelog/template"
110+
title_format = "`{version} <https://github.com/ansys/pystk/releases/tag/v{version}>`_ - {project_date}"
111+
issue_format = "`#{issue} <https://github.com/ansys/pystk/pull/{issue}>`_"
113112

114113
[[tool.towncrier.type]]
115114
directory = "added"

0 commit comments

Comments
 (0)