From cc0cb59c7c9d4effbe58f4746bf25bc1d9dc5fef Mon Sep 17 00:00:00 2001 From: Matt Williams Date: Tue, 2 Aug 2022 10:14:25 +0000 Subject: [PATCH] Release 1.12.2 --- CHANGELOG.md | 71 +++++++++++++++++++++++++++--- pyproject.toml | 2 +- sphinxcontrib/doxylink/__init__.py | 2 +- 3 files changed, 68 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8cb9769..55f4786 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,117 +5,178 @@ SPDX-License-Identifier: BSD # Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + ## [Unreleased] + +## [1.12.2] - 2022-08-02 + ### Fixed + - Ignore friend declarations as members to avoid crash [PR #45] ## [1.12.1] - 2022-07-28 + ### Changed + - Improve performance of class SymbolMap [PR #42] ## [1.12.0] - 2022-05-06 -### Fixed -- Handle the `operator()` method correctly + ### Changed + - Update packaging to use Poetry [PR #39] +### Fixed + +- Handle the `operator()` method correctly + ## [1.11.2] - 2022-04-28 + ### Fixed + - Add support for sphinx parallel read/write [PR #37] ## [1.11.1] - 2021-11-15 + ### Fixed + - Only link to Doxygen's PDF output when Sphinx uses the latex format [PR #36] ## [1.11] - 2021-09-22 + ### Added + - Add feature to download remote and copy local pdf files [PR #35] ## [1.10] - 2021-09-10 + ### Fixed + - Fix links to files in Doxygen's PDF output [PR #34] ## [1.9] - 2021-09-02 + ### Added + - Add support for linking to Doxygen's PDF output [PR #32] ## [1.8] - 2021-01-28 + ### Added + - Add support for pages in addition to files [PR #25] - Add volatile as qualifier [PR #26] ## [1.7] - 2021-01-11 + ### Added + - Add support for argument packs in C++11 [PR #20] - Add support for linking to remote tag files [issue #12] - Add support for multiple tag files with the same name [PR #27] ## [1.6.1] - 2019-04-27 + ### Fixed + - Fix for deprecated `app.info()` [PR #23] ## [1.6] - 2018-07-22 + ### Added + - Add support for linking to Doxygen groups [issue #11]. - Add possibility to link to #DEFINE macros. + ### Fixed + - Do a better job of parsing compound fundamental types. - Rewrite internals to a more structured style. - Fix error in namespace resolution. ## [1.5] - 2017-12-09 + ### Fixed + - Fix #6: convert dict_values to list before indexing [Stein Heselmans] - fix parsing for C++11 functions with specifiers () final, () override or () = default [Elco Jacobs] ## [1.4] - 2017-12-04 + ### Removed + - Remove Python 2 compatibility -### Fix +- ### Fix - Add bug fix from Stein Heselmans to force the qualifier to be a single string ## [1.3] - 2012-09-13 + ### Fixed + - Add fix from Matthias Tuma from Shark3 to allow friend declarations inside classes. ## [1.2] - 2011-11-03 + ### Added + - Add Python 3 support ## [1.1] - 2011-02-19 + ### Added + - Add support for linking directly to struct definitions. - Allow to link to functions etc. which are in a header/source file but not a member of a class. ## [1.0] - 2010-12-14 + ### Added + - New Dependency: PyParsing (http://pyparsing.wikispaces.com/) - Completely new tag file parsing system. Allows for function overloading. - The parsed results are cached to speed things up. +- The parsed results are cached to speed things up. - Full usage documentation. Build with `sphinx-build -W -b html doc html`. + ### Fixed + - Fix problem with mixed slashes when building on Windows. ## [0.4] - 2010-08-15 + ### Added + - Allow URLs as base paths for the HTML links. + ### Fixed + - Don't append parentheses if the user has provided them already in their query. ## [0.3] - 2010-08-10 + ### Added + - Only parse the tag file once per run. This should increase the speed. - Automatically add parentheses to functions if the `add_function_parentheses` config variable is set. ## [0.2] - 2010-07-31 + ### Added + - When a target cannot be found, make the node an `inline` node so there's no link created. + ### Fixed + - No longer require a trailing slash on the `doxylink` config variable HTML link path. - Allow doxylinks to work correctly when created from a documentation subdirectory. ## [0.1] - 2010-07-22 + ### Added + - Initial release -[//]: # (C3-1-DKAC) +[//]: # (C3-2-DKAC) diff --git a/pyproject.toml b/pyproject.toml index 5d34cb1..babd300 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ [tool.poetry] name = "sphinxcontrib-doxylink" packages = [{include = "sphinxcontrib"}] -version = "1.12.1" +version = "1.12.2" description = "Sphinx extension for linking to Doxygen documentation." readme = "README.rst" documentation = "https://sphinxcontrib-doxylink.readthedocs.io" diff --git a/sphinxcontrib/doxylink/__init__.py b/sphinxcontrib/doxylink/__init__.py index 76faa04..680efa8 100644 --- a/sphinxcontrib/doxylink/__init__.py +++ b/sphinxcontrib/doxylink/__init__.py @@ -1,4 +1,4 @@ -__version__ = "1.12.1" +__version__ = "1.12.2" def setup(app):