Releases: breathe-doc/breathe
Releases · breathe-doc/breathe
Breathe v4.36.0
https://pypi.org/project/breathe/4.36.0/
What's Changed
- Fix mistake in spelling of inheritance by @michaeljones in #914
- Remove python 2 code by @Rotzbua in #949
- Update
test_renderer
so that tests pass with Sphinx 7.2. by @gareth-rees in #976 - Fix PosixPath issue with Sphinx 7.2 by @scottamain in #964
- Avoid
RemovedInSphinx80Warning
in path-manipulation code. by @gareth-rees in #977 - Move project metadata to pyproject.toml, clean-up by @mwtoews in #883
- Fix README: Bump Python to >= 3.7 by @Rotzbua in #946
- Add make.bat for building on Windows by @hwhsu1231 in #971
- fix(ci): reorder
sphinx
installation by @Rotzbua in #953 - .github/workflows/unit_tests.yml: Update it by @t-b in #887
- Update GH Action to current release by @Rotzbua in #954
- Add documentation on writing tests for Breathe by @emilydolson in #931
- Update dependencies & GH Actions by @Rotzbua in #955
- Resolve full title for doxygenpage and doxygengroup and allow for omitting the title all together by @RaumZeit in #939
- Do not re-assign
nodes
variable in renderer/sphinxrenderer.py by @RaumZeit in #938 - Insert signature name for use with Sphinx ToC by @scottamain in #959
- Remove outdated list of supported targets from documentation by @saraedum in #1001
- feat(ci): Add python 3.13 and Sphinx 8.1 by @Rotzbua in #1006
- Fix test suite under Sphinx 7.4+ by @yut23 in #1007
- Fix building documentation in CI by @yut23 in #1008
- Fix linter warnings by @yut23 in #1009
- Fix test failure with latest Sphinx master by @yut23 in #1010
- Fix: typos in docs and error msg by @Rotzbua in #1011
- chore: move mypy config to
pyproject.toml
by @Rotzbua in #1014 - Enable dependabot for GitHub Actions by @Rotzbua in #1015
- Remove travis from docs by @Rotzbua in #1017
- chore: improve lint tools by @Rotzbua in #1016
- Fix errors in template specialization with qualified arguments by @yut23 in #1012
- Add GitHub Actions release workflow for Trusted Publishing by @AA-Turner in #1023
New Contributors
- @Rotzbua made their first contribution in #949
- @gareth-rees made their first contribution in #976
- @scottamain made their first contribution in #964
- @mwtoews made their first contribution in #883
- @hwhsu1231 made their first contribution in #971
- @emilydolson made their first contribution in #931
- @RaumZeit made their first contribution in #939
- @saraedum made their first contribution in #1001
- @yut23 made their first contribution in #1007
- @AA-Turner made their first contribution in #1023
Full Changelog: v4.35.0...v4.36.0
2023-02-28 - Breathe v4.35.0
Note: This release was not PGP signed on PyPI due to key availability issue. See #901 for details.
2022-06-20 - Breathe v4.34.0
- Treat .unparsed as plain text. #806
- Remove unneeded type: ignore annotations. #813
- Fix internal
NodeFinder
visitor for when non-Docutils nodes are
present in the content of a directive. #812 - Rename lint workflow. #814
- Type check pygments and limit docutils stub version. #819
- Convert dot files' relative path to absolute. #821
- CI, update Sphinx versions to test. #834
- CI, update for Sphinx 5.0.1. #846
- Fix inconsistency in example. #843
- Fix C# enum rendering crash. #849
- Drop Sphinx 3 support, add Sphinx 5 support. #850
- CICD: Disable python 3.6 for Sphinx master tests. #853
- Populate default include text-node's data field instead of raw-source.
#828
2022-02-14 - Breathe v4.33.1
- Avoid warning about multiple graphviz directives. #804
2022-02-14 - Breathe v4.33.0
- Fix duplicate
static
in variable declarations. #794 - Update CICD for Sphinx 4.4.0 series. #795
- Pin version of black in CICD and reformat files. #792
- Fix code block highlighting. #760
- Refactoring, cleanup and typing improvements. #802
- Doxygen dot graphs to Sphinx graphviz. #757
- Support externally hosted images. #705
- Address a peculiarity in Doxygen aliases in doc. #770
- Add flag to doxygengroup, doxygennamespace to display only the description.
#718 - Add support for MD block quotes with attribution(s). #759
2022-01-30 - Breathe v4.32.0
- Added
breathe_doxygen_aliases
config variable. #729 - Render
\remark
/\remarks
and\see
/\sa
using Sphinx/Docutils
admonition style nodes. #756 - Render C++ scoped enums differently than unscoped enums, and with their
underlying type. #753 - Render
\retval
lists using dedicated field list when Sphinx >= 4.3 i 10000 s
used. #749 - Make
.. doxygenfunction
handle function template specializations. #750 - Properly handle field-lists and admonitions in the detailed description of
classes and functions. #764 - Add
:confval:`breathe_show_include`
to control whether#include
lines are shown. Defaults toTrue
. #725 - Fix sys.path adjustment in doc config. #734
- Fix sphinx renderer variable and function visitors for C#. #737
- Fix sphinx renderer class visitor for C#. #738
- Auto-format python code with black. #743
- Extend flake8 and address some style issues. #745
- Fix black formatting warning. #747
- Update Sphinx and Python versions tested against. #765
- Fix friend functions for older Doxygen versions. #769
- Doxygen >= 1.9.2 supports C++20 concepts, add support for them. #779
- Change the way directives are added to adhere to the interface,
e.g., avoiding myst-parser to crash. #780 - Improved list of included files (with cross-references for local includes).
#763 - Update flake8 and mypy related stuff. #781
- Update readme with logo and sponsorship info. #784
- Store version number in both setup.py and init.py. #789
- CICD: lint: continue with other jobs if black fails. #791
2021-09-14 - Breathe v4.31.0
- Collapse multiple retvals into a single bullet list. #697
- Fix mypy issues on CI. #731
- Print usage message from 'compare' doc script. #727
- Test against Sphinx 4.0.3, 4.1.2 and 4.1.x branch. #721
- Fix duplicate
static
in function declarations. #717 #720 - Directive refactoring. #698
- Handle parsing errors. #711
- Make doxygenfunction more robust when matching parameters. #722 #723
- Separate, link and style the changelog. #735
- Update changelog and readme ahead of release. #739
- CICD: Track Sphinx 4.2.x development series. #741