Skip to content

Releases: breathe-doc/breathe

2023-02-28 - Breathe v4.35.0

31 Mar 19:07
v4.35.0
Compare
Choose a tag to compare

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

2022-06-20 - Breathe v4.34.0

20 Jun 18:54
v4.34.0
7e9f397
Compare
Choose a tag to compare
  • 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

14 Feb 17:11
v4.33.1
2a68310
Compare
Choose a tag to compare
  • Avoid warning about multiple graphviz directives. #804

2022-02-14 - Breathe v4.33.0

14 Feb 00:44
v4.33.0
1d0d6eb
Compare
Choose a tag to compare
  • 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

30 Jan 02:04
v4.32.0
55b34d5
Compare
Choose a tag to compare
  • 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 is
    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 to True. #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

14 Sep 23:59
v4.31.0
a06ad44
Compare
Choose a tag to compare
  • 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

2021-05-06 - Breathe v4.30.0

06 May 19:46
v4.30.0
8269283
Compare
Choose a tag to compare
  • Fix retval rendering. #687
  • Correctly label example as C. #690
  • apidoc: add -m, --members option flag. #694

2021-04-30 - Breathe v4.29.2

30 Apr 15:47
v4.29.2
8e45b5e
Compare
Choose a tag to compare
  • Remove stale six dep. #682
  • Render fields with multiple names instead of crashing. #685
  • Start pytest via module instead of exe. #686

2021-04-23 - Breathe v4.29.1

23 Apr 01:40
v4.29.1
8143ea7
Compare
Choose a tag to compare
  • 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

2021-04-09 - Breathe v4.29.0

09 Apr 19:55
v4.29.0
19b3962
Compare
Choose a tag to compare
  • Do not add inline modifier for C#. #668
  • Use add_css_file 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