Recent Releases of breathe
breathe - Breathe v5.0.0a2
What's Changed
- Fix docstring missing quotes by @Rotzbua in https://github.com/breathe-doc/breathe/pull/1020
- Fix some incorrect indents in the document by @koyuki7w in https://github.com/breathe-doc/breathe/pull/1032
- Enable imgconverter extension to fix LaTeX documentation build by @mitya57 in https://github.com/breathe-doc/breathe/pull/1027
- Bump astral-sh/setup-uv from 5 to 6 in the github-actions group by @dependabot in https://github.com/breathe-doc/breathe/pull/1025
- Support members in a Doxygen 1.9.7 group by @JasperCraeghs in https://github.com/breathe-doc/breathe/pull/934
- Performance improvements, new tests, more typing annotations and miscellaneous fixes by @Rouslan in https://github.com/breathe-doc/breathe/pull/967
- Comment out csharp dependency by @michaeljones in https://github.com/breathe-doc/breathe/pull/1035
New Contributors
- @koyuki7w made their first contribution in https://github.com/breathe-doc/breathe/pull/1032
- @dependabot made their first contribution in https://github.com/breathe-doc/breathe/pull/1025
- @JasperCraeghs made their first contribution in https://github.com/breathe-doc/breathe/pull/934
- @Rouslan made their first contribution in https://github.com/breathe-doc/breathe/pull/967
Full Changelog: https://github.com/breathe-doc/breathe/compare/v4.36.0...v5.0.0a2
- Python
Published by michaeljones 12 months ago
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 https://github.com/breathe-doc/breathe/pull/914
- Remove python 2 code by @Rotzbua in https://github.com/breathe-doc/breathe/pull/949
- Update
test_rendererso that tests pass with Sphinx 7.2. by @gareth-rees in https://github.com/breathe-doc/breathe/pull/976 - Fix PosixPath issue with Sphinx 7.2 by @scottamain in https://github.com/breathe-doc/breathe/pull/964
- Avoid
RemovedInSphinx80Warningin path-manipulation code. by @gareth-rees in https://github.com/breathe-doc/breathe/pull/977 - Move project metadata to pyproject.toml, clean-up by @mwtoews in https://github.com/breathe-doc/breathe/pull/883
- Fix README: Bump Python to >= 3.7 by @Rotzbua in https://github.com/breathe-doc/breathe/pull/946
- Add make.bat for building on Windows by @hwhsu1231 in https://github.com/breathe-doc/breathe/pull/971
- fix(ci): reorder
sphinxinstallation by @Rotzbua in https://github.com/breathe-doc/breathe/pull/953 - .github/workflows/unit_tests.yml: Update it by @t-b in https://github.com/breathe-doc/breathe/pull/887
- Update GH Action to current release by @Rotzbua in https://github.com/breathe-doc/breathe/pull/954
- Add documentation on writing tests for Breathe by @emilydolson in https://github.com/breathe-doc/breathe/pull/931
- Update dependencies & GH Actions by @Rotzbua in https://github.com/breathe-doc/breathe/pull/955
- Resolve full title for doxygenpage and doxygengroup and allow for omitting the title all together by @RaumZeit in https://github.com/breathe-doc/breathe/pull/939
- Do not re-assign
nodesvariable in renderer/sphinxrenderer.py by @RaumZeit in https://github.com/breathe-doc/breathe/pull/938 - Insert signature name for use with Sphinx ToC by @scottamain in https://github.com/breathe-doc/breathe/pull/959
- Remove outdated list of supported targets from documentation by @saraedum in https://github.com/breathe-doc/breathe/pull/1001
- feat(ci): Add python 3.13 and Sphinx 8.1 by @Rotzbua in https://github.com/breathe-doc/breathe/pull/1006
- Fix test suite under Sphinx 7.4+ by @yut23 in https://github.com/breathe-doc/breathe/pull/1007
- Fix building documentation in CI by @yut23 in https://github.com/breathe-doc/breathe/pull/1008
- Fix linter warnings by @yut23 in https://github.com/breathe-doc/breathe/pull/1009
- Fix test failure with latest Sphinx master by @yut23 in https://github.com/breathe-doc/breathe/pull/1010
- Fix: typos in docs and error msg by @Rotzbua in https://github.com/breathe-doc/breathe/pull/1011
- chore: move mypy config to
pyproject.tomlby @Rotzbua in https://github.com/breathe-doc/breathe/pull/1014 - Enable dependabot for GitHub Actions by @Rotzbua in https://github.com/breathe-doc/breathe/pull/1015
- Remove travis from docs by @Rotzbua in https://github.com/breathe-doc/breathe/pull/1017
- chore: improve lint tools by @Rotzbua in https://github.com/breathe-doc/breathe/pull/1016
- Fix errors in template specialization with qualified arguments by @yut23 in https://github.com/breathe-doc/breathe/pull/1012
- Add GitHub Actions release workflow for Trusted Publishing by @AA-Turner in https://github.com/breathe-doc/breathe/pull/1023
New Contributors
- @Rotzbua made their first contribution in https://github.com/breathe-doc/breathe/pull/949
- @gareth-rees made their first contribution in https://github.com/breathe-doc/breathe/pull/976
- @scottamain made their first contribution in https://github.com/breathe-doc/breathe/pull/964
- @mwtoews made their first contribution in https://github.com/breathe-doc/breathe/pull/883
- @hwhsu1231 made their first contribution in https://github.com/breathe-doc/breathe/pull/971
- @emilydolson made their first contribution in https://github.com/breathe-doc/breathe/pull/931
- @RaumZeit made their first contribution in https://github.com/breathe-doc/breathe/pull/939
- @saraedum made their first contribution in https://github.com/breathe-doc/breathe/pull/1001
- @yut23 made their first contribution in https://github.com/breathe-doc/breathe/pull/1007
- @AA-Turner made their first contribution in https://github.com/breathe-doc/breathe/pull/1023
Full Changelog: https://github.com/breathe-doc/breathe/compare/v4.35.0...v4.36.0
- Python
Published by AA-Turner over 1 year ago
breathe - 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.
- Pull lone literal blocks in paragraphs up to produce correct doctree. #833
- Fix tests for changes in Sphinx 5.3. #865
- Bump Python requirement to 3.7. #866
- Support Sphinx 6. #885
- Support
:sort:option to sort sections by name. #879
- Python
Published by vermeeren over 3 years ago
breathe - 2022-06-20 - Breathe v4.34.0
- Treat .unparsed as plain text. #806
- Remove unneeded type: ignore annotations. #813
- Fix internal
NodeFindervisitor 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
- Python
Published by vermeeren about 4 years ago
breathe - 2022-02-14 - Breathe v4.33.1
- Avoid warning about multiple graphviz directives. #804
- Python
Published by vermeeren over 4 years ago
breathe - 2022-02-14 - Breathe v4.33.0
- Fix duplicate
staticin 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
- Python
Published by vermeeren over 4 years ago
breathe - 2022-01-30 - Breathe v4.32.0
- Added
breathe_doxygen_aliasesconfig variable. #729 - Render
\remark/\remarksand\see/\sausing Sphinx/Docutils admonition style nodes. #756 - Render C++ scoped enums differently than unscoped enums, and with their underlying type. #753
- Render
\retvallists using dedicated field list when Sphinx >= 4.3 is used. #749 - Make
.. doxygenfunctionhandle 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#includelines 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
- Python
Published by vermeeren over 4 years ago
breathe - 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
staticin 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
- Python
Published by vermeeren almost 5 years ago
breathe - 2021-05-06 - Breathe v4.30.0
- Fix retval rendering. #687
- Correctly label example as C. #690
- apidoc: add -m, --members option flag. #694
- Python
Published by vermeeren about 5 years ago
breathe - 2021-04-30 - Breathe v4.29.2
- Remove stale six dep. #682
- Render fields with multiple names instead of crashing. #685
- Start pytest via module instead of exe. #686
- Python
Published by vermeeren about 5 years ago
breathe - 2021-04-23 - Breathe v4.29.1
- Splice out parameter direction in field lists. #675
- Fixes for Sphinx v4. #676
- Fix paragraph in paragraph rendering. #678
- Strip names before lookup in doxygenfunction. #679
- When rendering template params, insert name by parsing. #681
- Python
Published by vermeeren about 5 years ago
breathe - 2021-04-09 - Breathe v4.29.0
- Do not add inline modifier for C#. #668
- Use addcssfile instead of deprecated/removed add_stylesheet. #669
- Use native docutils for field lists, notes, and warnings. #670
- Handle directives returning no nodes on error. #672
- Python
Published by vermeeren about 5 years ago