fix towncrier and link check

fschuch · Mar 22, 2024 · eef58f4 · eef58f4
1 parent 588df71
commit eef58f4
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 |         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| QA      | [![CI](https://github.com/fschuch/xcompact3d_toolbox/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/fschuch/xcompact3d_toolbox/actions/workflows/ci.yaml) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/fschuch/xcompact3d_toolbox/main.svg)](https://results.pre-commit.ci/latest/github/fschuch/xcompact3d_toolbox/main)[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=fschuch_xcompact3d_toolbox&metric=coverage)](https://sonarcloud.io/summary/new_code?id=fschuch_xcompact3d_toolbox)[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fschuch_xcompact3d_toolbox&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fschuch_xcompact3d_toolbox)        |
+| QA      | [![CI](https://github.com/fschuch/xcompact3d_toolbox/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/fschuch/xcompact3d_toolbox/actions/workflows/ci.yaml) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/fschuch/xcompact3d_toolbox/main.svg)](https://results.pre-commit.ci/latest/github/fschuch/xcompact3d_toolbox/main)[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fschuch_xcompact3d_toolbox&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fschuch_xcompact3d_toolbox)[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=fschuch_xcompact3d_toolbox&metric=coverage)](https://sonarcloud.io/summary/new_code?id=fschuch_xcompact3d_toolbox)        |
 | Docs    | [![Docs](https://github.com/fschuch/xcompact3d_toolbox/actions/workflows/docs.yaml/badge.svg?branch=main)](https://github.com/fschuch/xcompact3d_toolbox/actions/workflows/docs.yaml)[![Documentation Status](https://readthedocs.org/projects/xcompact3d_toolbox/badge/?version=latest)](https://xcompact3d-toolbox.readthedocs.io/en/latest/?badge=latest)                                                                                                                                                                                                                                                                                                                                                                                                                 |
 | Package | [![PyPI - Version](https://img.shields.io/pypi/v/xcompact3d-toolbox.svg?logo=pypi&label=PyPI)](https://pypi.org/project/xcompact3d-toolbox/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/xcompact3d-toolbox.svg?logo=python&label=Python)](https://pypi.org/project/xcompact3d-toolbox/)                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | Meta    | [![Wizard Template](https://img.shields.io/badge/Wizard-Template-%23447CAA)](https://github.com/fschuch/wizard-template) [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/) [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![PyPI - License](https://img.shields.io/pypi/l/xcompact3d-toolbox?color=blue)](https://github.com/fschuch/xcompact3d_toolbox/blob/master/LICENSE) [![EffVer Versioning](https://img.shields.io/badge/version_scheme-EffVer-0097a7)](https://jacobtomlinson.dev/effver) |
@@ -26,7 +26,7 @@ For developers, it works as a rapid prototyping tool, to test concepts and then
 ## Useful links
 
 - [Documentation](https://xcompact3d-toolbox.readthedocs.io/);
-- [Changelog](https://github.com/fschuch/xcompact3d_toolbox/blob/master/CHANGELOG.md);
+- [Changelog](https://github.com/fschuch/xcompact3d_toolbox/blob/master/docs/news.md);
 - [Suggestions for new features and bug report](https://github.com/fschuch/xcompact3d_toolbox/issues);
 - [See what is coming next (Project page)](https://github.com/fschuch/xcompact3d_toolbox/projects/1);
 - [Xcompact3d's repository](https://github.com/xcompact3d/Incompact3d).

diff --git a/docs/index.rst b/docs/index.rst
@@ -27,7 +27,6 @@ compare results to validate any future Fortran implementations.
 **Useful links**
 
 * `View on GitHub`_;
-* `Changelog`_;
 * `Suggestions for new features and bug report`_;
 * `See what is coming next (Project page)`_.
 
@@ -44,10 +43,6 @@ It is possible to install using pip::
 There are other dependency sets for extra functionality::
 
    pip install xcompact3d-toolbox[visu] # interactive visualization with hvplot and others
-   pip install xcompact3d-toolbox[doc]  # dependencies to build the documentation
-   pip install xcompact3d-toolbox[dev]  # tools for development
-   pip install xcompact3d-toolbox[test] # tools for testing
-   pip install xcompact3d-toolbox[all]  # all the above
 
 To install from source, clone de repository::
 
@@ -135,7 +130,6 @@ Examples
 .. image:: https://www.fschuch.com/en/slides/2021-x3d-dev-meeting/Output.gif
 
 .. _`View on GitHub`: https://github.com/fschuch/xcompact3d_toolbox
-.. _`Changelog`: https://github.com/fschuch/xcompact3d_toolbox/blob/master/CHANGELOG.md
 .. _`Suggestions for new features and bug report`: https://github.com/fschuch/xcompact3d_toolbox/issues
 .. _`See what is coming next (Project page)`: https://github.com/fschuch/xcompact3d_toolbox/projects/1
 

diff --git a/docs/news.md b/docs/news.md
@@ -1,22 +1,16 @@
 # What’s New
 
-<!-- markdown-link-check-disable -->
-
 All notable changes to this project will be documented in this page.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Intended Effort Versioning](https://jacobtomlinson.dev/effver/) (EffVer for short).
 The changes for the upcoming release can be found in [changelog.d](https://github.com/fschuch/xcompact3d_toolbox/tree/main/changelog.d/).
 
-<!-- markdown-link-check-enable -->
-
 <!-- WARNING: This file is auto-generated. Do not manually update this file. -->
 
-<!-- towncrier release notes start -->
+<!-- markdown-link-check-disable-next-line -->
 
 ## [1.2.0rc0](https://github.com/fschuch/xcompact3d_toolbox/releases/tag/v1.2.0rc0) - 2024-03-21
 
-\================================================================================================
-
 ### Added
 
 - Added [loguru](https://loguru.readthedocs.io/en/stable/) to enhance logging in the project

diff --git a/towncrier.toml b/towncrier.toml
@@ -2,9 +2,10 @@
 package = "xcompact3d_toolbox"
 directory = "changelog.d"
 filename = "docs/news.md"
-start_string = "<!-- towncrier release notes start -->\n"
+start_string = "<!-- markdown-link-check-disable-next-line -->\n"
 title_format = "## [{version}](https://github.com/fschuch/xcompact3d_toolbox/releases/tag/v{version}) - {project_date}"
 issue_format = "[#{issue}](https://github.com/fschuch/xcompact3d_toolbox/issues/{issue})"
+underlines = ["", "", ""]
 
 [[tool.towncrier.type]]
 directory = "security"