Sync from SUSE:SLFO:Main python-breathe revision 4a1a6ec3284c7d0140590b416a0cefc0

This commit is contained in:
Adrian Schröter 2024-05-03 20:16:30 +02:00
commit b2882c64f2
5 changed files with 483 additions and 0 deletions

23
.gitattributes vendored Normal file
View File

@ -0,0 +1,23 @@
## Default LFS
*.7z filter=lfs diff=lfs merge=lfs -text
*.bsp filter=lfs diff=lfs merge=lfs -text
*.bz2 filter=lfs diff=lfs merge=lfs -text
*.gem filter=lfs diff=lfs merge=lfs -text
*.gz filter=lfs diff=lfs merge=lfs -text
*.jar filter=lfs diff=lfs merge=lfs -text
*.lz filter=lfs diff=lfs merge=lfs -text
*.lzma filter=lfs diff=lfs merge=lfs -text
*.obscpio filter=lfs diff=lfs merge=lfs -text
*.oxt filter=lfs diff=lfs merge=lfs -text
*.pdf filter=lfs diff=lfs merge=lfs -text
*.png filter=lfs diff=lfs merge=lfs -text
*.rpm filter=lfs diff=lfs merge=lfs -text
*.tbz filter=lfs diff=lfs merge=lfs -text
*.tbz2 filter=lfs diff=lfs merge=lfs -text
*.tgz filter=lfs diff=lfs merge=lfs -text
*.ttf filter=lfs diff=lfs merge=lfs -text
*.txz filter=lfs diff=lfs merge=lfs -text
*.whl filter=lfs diff=lfs merge=lfs -text
*.xz filter=lfs diff=lfs merge=lfs -text
*.zip filter=lfs diff=lfs merge=lfs -text
*.zst filter=lfs diff=lfs merge=lfs -text

BIN
breathe-4.35.0.tar.gz (Stored with Git LFS) Normal file

Binary file not shown.

354
python-breathe.changes Normal file
View File

@ -0,0 +1,354 @@
-------------------------------------------------------------------
Tue Aug 29 02:48:53 UTC 2023 - Steve Kowalik <steven.kowalik@suse.com>
- Upgrade to 4.35:
* Pull lone literal blocks in paragraphs up to produce correct doctree.
* Fix tests for changes in Sphinx 5.3.
* Bump Python requirement to 3.7.
* Support Sphinx 6.
* Support sort option to sort sections by name.
- Drop patch Fix-tests-for-Sphinx-5.3.0.patch, included upstream.
- Add patch support-sphinx-7.2.patch:
* Support Sphinx 7.2 changes.
- Switch to pyproject macros.
-------------------------------------------------------------------
Thu Jul 6 10:23:41 UTC 2023 - ecsos <ecsos@opensuse.org>
- Add %{?sle15_python_module_pythons}
-------------------------------------------------------------------
Fri Mar 24 12:30:29 UTC 2023 - Daniel Garcia <daniel.garcia@suse.com>
- Remove not needed requirement setuptools
-------------------------------------------------------------------
Thu Nov 3 12:24:28 UTC 2022 - Daniel Garcia <daniel.garcia@suse.com>
- Remove not needed dep python-six
-------------------------------------------------------------------
Fri Oct 28 06:53:44 UTC 2022 - Daniel Garcia <daniel.garcia@suse.com>
- Add Fix-tests-for-Sphinx-5.3.0.patch to make the package compatible with
Sphinx 5.3.0
-------------------------------------------------------------------
Tue Oct 25 12:46:34 UTC 2022 - ecsos <ecsos@opensuse.org>
- Fix build errors in Leap and Tumbleweed.
-------------------------------------------------------------------
Fri Sep 23 02:44:31 UTC 2022 - Yogalakshmi Arunachalam <yarunachalam@suse.com>
- version update to 4.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
-------------------------------------------------------------------
Mon Mar 7 13:43:13 UTC 2022 - pgajdos@suse.com
- version update to 4.33.1
- 2022-02-14 - **Breathe v4.33.1**
- Avoid warning about multiple graphviz directives.
`#804 <https://github.com/michaeljones/breathe/pull/804>`__
- 2022-02-14 - **Breathe v4.33.0**
- Fix duplicate ``static`` in variable declarations.
`#794 <https://github.com/michaeljones/breathe/pull/794>`__
- Update CICD for Sphinx 4.4.0 series.
`#795 <https://github.com/michaeljones/breathe/pull/795>`__
- Pin version of black in CICD and reformat files.
`#792 <https://github.com/michaeljones/breathe/pull/792>`__
- Fix code block highlighting.
`#760 <https://github.com/michaeljones/breathe/pull/760>`__
- Refactoring, cleanup and typing improvements.
`#802 <https://github.com/michaeljones/breathe/pull/802>`__
- Doxygen dot graphs to Sphinx graphviz.
`#757 <https://github.com/michaeljones/breathe/pull/757>`__
- Support externally hosted images.
`#705 <https://github.com/michaeljones/breathe/pull/705>`__
- Address a peculiarity in Doxygen aliases in doc.
`#770 <https://github.com/michaeljones/breathe/pull/770>`__
- Add flag to doxygengroup, doxygennamespace to display only the description.
`#718 <https://github.com/michaeljones/breathe/pull/718>`__
- Add support for MD block quotes with attribution(s).
`#759 <https://github.com/michaeljones/breathe/pull/759>`__
- 2022-01-30 - **Breathe v4.32.0**
- Added ``breathe_doxygen_aliases`` config variable.
`#729 <https://github.com/michaeljones/breathe/pull/729>`__
- Render ``\remark``/``\remarks`` and ``\see``/``\sa`` using Sphinx/Docutils
admonition style nodes.
`#756 <https://github.com/michaeljones/breathe/pull/756>`__
- Render C++ scoped enums differently than unscoped enums, and with their
underlying type.
`#753 <https://github.com/michaeljones/breathe/pull/753>`__
- Render ``\retval`` lists using dedicated field list when Sphinx >= 4.3 is
used.
`#749 <https://github.com/michaeljones/breathe/pull/749>`__
- Make ``.. doxygenfunction`` handle function template specializations.
`#750 <https://github.com/michaeljones/breathe/pull/750>`__
- Properly handle field-lists and admonitions in the detailed description of
classes and functions.
`#764 <https://github.com/michaeljones/breathe/pull/764>`__
- Add ``:confval:`breathe_show_include``` to control whether ``#include``
lines are shown. Defaults to ``True``.
`#725 <https://github.com/michaeljones/breathe/pull/725>`__
- Fix sys.path adjustment in doc config.
`#734 <https://github.com/michaeljones/breathe/pull/734>`__
- Fix sphinx renderer variable and function visitors for C#.
`#737 <https://github.com/michaeljones/breathe/pull/737>`__
- Fix sphinx renderer class visitor for C#.
`#738 <https://github.com/michaeljones/breathe/pull/738>`__
- Auto-format python code with black.
`#743 <https://github.com/michaeljones/breathe/pull/743>`__
- Extend flake8 and address some style issues.
`#745 <https://github.com/michaeljones/breathe/pull/745>`__
- Fix black formatting warning.
`#747 <https://github.com/michaeljones/breathe/pull/747>`__
- Update Sphinx and Python versions tested against.
`#765 <https://github.com/michaeljones/breathe/pull/765>`__
- Fix friend functions for older Doxygen versions.
`#769 <https://github.com/michaeljones/breathe/pull/769>`__
- Doxygen >= 1.9.2 supports C++20 concepts, add support for them.
`#779 <https://github.com/michaeljones/breathe/pull/779>`__
- Change the way directives are added to adhere to the interface,
e.g., avoiding myst-parser to crash.
`#780 <https://github.com/michaeljones/breathe/pull/780>`__
- Improved list of included files (with cross-references for local includes).
`#763 <https://github.com/michaeljones/breathe/pull/763>`__
- Update flake8 and mypy related stuff.
`#781 <https://github.com/michaeljones/breathe/pull/781>`__
- Update readme with logo and sponsorship info.
`#784 <https://github.com/michaeljones/breathe/pull/784>`__
- Store version number in both setup.py and __init__.py.
`#789 <https://github.com/michaeljones/breathe/pull/789>`__
- CICD: lint: continue with other jobs if black fails.
`#791 <https://github.com/michaeljones/breathe/pull/791>`__
- actually does not require python-mock
-------------------------------------------------------------------
Sat Jan 15 15:24:12 UTC 2022 - Dirk Müller <dmueller@suse.com>
- update to 4.31.0:
* Collapse multiple retvals into a single bullet list
* Fix mypy issues on CI
* Print usage message from 'compare' doc script
* Test against Sphinx 4.0.3, 4.1.2 and 4.1.x branch
* Fix duplicate ``static`` in function declarations
* Directive refactoring
* Handle parsing errors
* Make doxygenfunction more robust when matching parameters
* Separate, link and style the changelog
* Update changelog and readme ahead of release
* CICD: Track Sphinx 4.2.x development series
-------------------------------------------------------------------
Tue Jun 1 16:05:57 UTC 2021 - Matej Cepl <mcepl@suse.com>
- Update to 4.30.0:
- Fix retval rendering. #687
- Correctly label example as C. #690
- apidoc: add -m, --members option flag. #694
- 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
- Code and documentation for membergroups and members-only options.
#637
- Add example.tag to gitignore as it gets modified during build
process. #644
- Add support for content-only flag when rendering pages. #645
- When rendering a section, add target after title. #647
- Render pages content in order. #651
- Adds an ID to the rubric created for each section of a group. #658
- Add missing getter and setter for C#. #661
- Add support for rowspan/colspan to tables. #642
-------------------------------------------------------------------
Thu Feb 25 03:13:38 UTC 2021 - Steve Kowalik <steven.kowalik@suse.com>
- Update to 4.27.0:
* Add various specifiers to functions and variables. #628
* Add multiply inherited class for PHP objects. #630
* Initial support for table rendering. #632
* Add rendering of \section, \subsection and \subsubsection. #635
* Sphinx 3.5 compatibility. #640
* Fix linking to sections. #639
* Add table examples to documentation. #638
* Fix doxygenfile causing duplicate IDs for unspecified sections. #622
* Fixes for doxygenfunction (friend keyword, friend class, arg checks). #623
* Add test for ellipsis ('...') in args. #610
* Sphinx 3.4.x compatibility. #617
* Adapt friendclass to Doxygen 1.9. #618
* Add support for \parblock parsing and rendering. #603
* Allow lookup in doxygenfunction without writing param names. #606
-------------------------------------------------------------------
Wed Dec 9 23:29:13 UTC 2020 - Benjamin Greiner <code@bnavigator.de>
- Update to v4.24.1
* Fix anchors on pages generated by Doxygen >= 1.8.17. #602
- Breathe v4.24.0
* Update CI for Sphinx 3.3.x and fix test mock. #597
* Add support for xrefitem based page generation (doxygenpage).
#596
- Breathe v4.23.0
* Add initial xrefsect support. #589
-------------------------------------------------------------------
Wed Oct 14 01:38:22 UTC 2020 - Steve Kowalik <steven.kowalik@suse.com>
- Update to 4.22.1:
* Fix anonymous struct/union usage in C domain. #585
* New boolean breathe_show_enumvalue_initializer option specifying whether
value of enumvalue should be displayed. #581
* Fix Read the Docs build. #567
* Document doxygenclass template specialisation spacing. #570
* Update upper Sphinx release to <3.4. #571
* Reuse breathe.__version__ in setup.py. #572
* Document :inner: for the doxygengroup section. #573
* Add support for verbatim inline elements. #560
* Fix wrong refid when Doxygen SEPARATE_MEMBER_PAGES is YES. #566
* Allow Sphinx 3.2. #561
* Update CI scripts with new Sphinx versions. #552
* Add support for C# using sphinx-csharp. #550
* Doc, fix typo, :source: -> :project:. #551
* Add support for innergroup. #556
* Avoid duplicate doxygen targets when debug tracing. #563
-------------------------------------------------------------------
Fri Jun 26 08:45:26 UTC 2020 - Guillaume GARDET <guillaume.gardet@opensuse.org>
- update to 4.19.2:
* Fix crash when visiting typedef. #547
-------------------------------------------------------------------
Mon Jun 15 10:33:19 UTC 2020 - Tomáš Chvátal <tchvatal@suse.com>
- Use tag, not random sha
-------------------------------------------------------------------
Sun Jun 14 09:41:23 UTC 2020 - Dirk Mueller <dmueller@suse.com>
- update to 4.19.1:
* Mark package as compatible with Sphinx 3.1.
* Refactoring. #528
* Make debug config variables available in conf.py. #533
* Fix warning formatting for function lookup. #535
* Correctly reverse nested namespaces in get_qualification. #540
-------------------------------------------------------------------
Tue Jun 2 12:57:04 UTC 2020 - Matej Cepl <mcepl@suse.com>
- Increase required version of Sphinx to the one where module
cstructobject was introduced. (bsc#1168627)
-------------------------------------------------------------------
Wed May 27 12:01:04 UTC 2020 - pgajdos@suse.com
- version update to 4.18.1
* 2020-05-10 - Breathe v4.18.1
- Fix friend class rendering and allow friend struct. #522
- Add extern examples to doc and remove variable hack. #526
- Render function candidates without using Sphinx directives. #524
* 2020-05-02 - Breathe v4.18.0
- Support tiles in verbatim blocks. #517
* 2020-05-01 - Breathe v4.17.0
- Scoped rendering, better integration with Sphinx, misc fixes. #512
* 2020-04-19 - Breathe v4.16.0
- Strictly depend on Sphinx's minor version. #498
- Simplifications and fixes, use more of modern Sphinx natively. #503
- Add section option to the doxygen(auto)file directive. #501
- Fix link generation when enum is inside a group (enum FQDN). #508
- Fix creation of LaTeX math formulas. #506
- Improve documentation for doxygen(auto)file section option. #509
* 2020-04-07 - Breathe v4.15.0
- Add license file to distribution. #492
- Update for Sphinx 3. #491
-------------------------------------------------------------------
Wed May 27 09:36:31 UTC 2020 - Petr Gajdos <pgajdos@suse.com>
- %python3_only -> %python_alternative
-------------------------------------------------------------------
Tue Apr 14 08:59:32 UTC 2020 - Paolo Stivanin <info@paolostivanin.com>
- Update to 4.14.2:
* Fixes to use Sphinx 2.4.4
* Switch to pytest from nose.
- Remove 0001-Add-MockApp.emit.patch
-------------------------------------------------------------------
Thu Apr 2 08:06:45 UTC 2020 - Dan Čermák <dcermak@suse.com>
- Fix FTBFS due to test failure
Add patch: 0001-Add-MockApp.emit.patch
This is cherry picked from https://github.com/michaeljones/breathe/pull/486
and fixes test failures with sphinx 2.4.4
-------------------------------------------------------------------
Sun Feb 2 16:00:02 UTC 2020 - aloisio@gmx.com
- Update to version 4.14.1
* Use sphinx core instead of mathbase ext. #469
* Fix test failure for Sphinx >= 2.2.2. #472
version 4.14.0:
* Add events attribute to MockApp. #452
* Add bit field support for C/C++. #454
* Add alias and variable template support. #461
-------------------------------------------------------------------
Fri Sep 13 11:12:14 UTC 2019 - Tomáš Chvátal <tchvatal@suse.com>
- Update to 4.13.1:
* no upstream changelog
-------------------------------------------------------------------
Thu Jun 6 13:29:38 UTC 2019 - Tomáš Chvátal <tchvatal@suse.com>
- Update to 4.13.0:
* Fixes for Sphinx 2.0
-------------------------------------------------------------------
Tue Mar 19 14:57:47 UTC 2019 - Tomáš Chvátal <tchvatal@suse.com>
- Update to 4.12.0:
* More sphinx fixes
- Remove merged patch sphinx18.patch
-------------------------------------------------------------------
Wed Mar 6 14:17:25 UTC 2019 - Tomáš Chvátal <tchvatal@suse.com>
- Update to 4.11.1:
* Fixes for newer sphinx releases
- Switch to github tarball for tests and license
- Add patch to fix build with sphinx 1.8:
* sphinx18.patch
-------------------------------------------------------------------
Tue Dec 4 12:46:19 UTC 2018 - Matej Cepl <mcepl@suse.com>
- Remove superfluous devel dependency for noarch package
-------------------------------------------------------------------
Mon Sep 18 16:51:24 UTC 2017 - toddrme2178@gmail.com
- Fix provides/obsoletes
-------------------------------------------------------------------
Fri Sep 8 15:50:22 UTC 2017 - toddrme2178@gmail.com
- Initial version

77
python-breathe.spec Normal file
View File

@ -0,0 +1,77 @@
#
# spec file for package python-breathe
#
# Copyright (c) 2023 SUSE LLC
#
# All modifications and additions to the file contributed by third parties
# remain the property of their copyright owners, unless otherwise agreed
# upon. The license for this file, and modifications and additions to the
# file, is the same license as for the pristine package itself (unless the
# license for the pristine package is not an Open Source License, in which
# case the license is the MIT License). An "Open Source License" is a
# license that conforms to the Open Source Definition (Version 1.9)
# published by the Open Source Initiative.
# Please submit bugfixes or comments via https://bugs.opensuse.org/
#
%define modname breathe
%{?sle15_python_module_pythons}
Name: python-breathe
Version: 4.35.0
Release: 0
Summary: Sphinx Doxygen renderer
License: BSD-3-Clause
URL: https://github.com/michaeljones/breathe
Source: https://github.com/michaeljones/%{modname}/archive/v%{version}.tar.gz#/%{modname}-%{version}.tar.gz
Patch0: support-sphinx-7.2.patch
BuildRequires: %{python_module Sphinx >= 4.0}
BuildRequires: %{python_module docutils >= 0.12}
BuildRequires: %{python_module pip}
BuildRequires: %{python_module pytest}
BuildRequires: %{python_module setuptools}
BuildRequires: %{python_module wheel}
BuildRequires: fdupes
BuildRequires: python-rpm-macros
Requires: python-Sphinx >= 4.0
Requires: python-docutils >= 0.12
Requires(post): update-alternatives
Requires(postun):update-alternatives
Provides: python-sphinxcontrib-breathe = %{version}
Obsoletes: python-sphinxcontrib-breathe < %{version}
BuildArch: noarch
%python_subpackages
%description
Breathe is an extension to reStructuredText and Sphinx to be
able to read and render Doxygen xml output.
%prep
%autosetup -p1 -n breathe-%{version}
%build
%pyproject_wheel
%check
%pytest
%install
%pyproject_install
%python_clone -a %{buildroot}%{_bindir}/breathe-apidoc
%python_expand %fdupes %{buildroot}%{$python_sitelib}
%post
%python_install_alternative breathe-apidoc
%postun
%python_uninstall_alternative breathe-apidoc
%files %{python_files}
%doc README.rst
%license LICENSE
%python_alternative %{_bindir}/breathe-apidoc
%{python_sitelib}/breathe
%{python_sitelib}/breathe-%{version}.dist-info
%changelog

26
support-sphinx-7.2.patch Normal file
View File

@ -0,0 +1,26 @@
Index: breathe-4.35.0/tests/test_renderer.py
===================================================================
--- breathe-4.35.0.orig/tests/test_renderer.py
+++ breathe-4.35.0/tests/test_renderer.py
@@ -35,7 +35,7 @@ def app(test_params, app_params, make_ap
"""
args, kwargs = app_params
assert "srcdir" in kwargs
- kwargs["srcdir"].makedirs(exist_ok=True)
+ kwargs["srcdir"].mkdir(parents=True, exist_ok=True)
(kwargs["srcdir"] / "conf.py").write_text("")
app_ = make_app(*args, **kwargs)
yield app_
Index: breathe-4.35.0/breathe/project.py
===================================================================
--- breathe-4.35.0.orig/breathe/project.py
+++ breathe-4.35.0/breathe/project.py
@@ -113,7 +113,7 @@ class ProjectInfoFactory:
# Assume general build directory is the doctree directory without the last component.
# We strip off any trailing slashes so that dirname correctly drops the last part.
# This can be overridden with the breathe_build_directory config variable
- self._default_build_dir = os.path.dirname(app.doctreedir.rstrip(os.sep))
+ self._default_build_dir = app.doctreedir.parent
self.project_count = 0
self.project_info_store: Dict[str, ProjectInfo] = {}
self.project_info_for_auto_store: Dict[str, AutoProjectInfo] = {}