Sync from SUSE:SLFO:Main python-gi-docgen revision bfa0cd8db6e6d5283405c048b4a76098

This commit is contained in:
2024-12-13 11:29:14 +01:00
parent c6d9ca7aed
commit 39881af9ad
6 changed files with 193 additions and 44 deletions

50
README.license Normal file
View File

@@ -0,0 +1,50 @@
# "Borrowed" from the Fedora folks - and slightly adapted (regarding what
# gets installed, or not, in our spec file):
#
# Based on the “Copyright and Licensing terms” in README.md, on the
# contents of .reuse/dep5, and on inspection of SPDX headers or other file
# contents with assistance from licensecheck.
#
# The entire source is (Apache-2.0 OR GPL-3.0-or-later) except the
# following files that are packaged or are used to generate packaged files:
#
# MIT:
# - gidocgen/templates/basic/fzy.js
# - gidocgen/templates/basic/solarized-{dark,light}.js
#
# CC0-1.0:
# - gi-docgen.pc.in (from which gi-docgen.pc is generated)
# - gidocgen/templates/basic/*.png
# - docs/CODEOWNERS (not packaged)
# - examples/*.toml (not packaged)
#
# Note that CC0-1.0 is allowed for content only; these files may reasonably
# be called content.
#
# Additionally, the following sources are under licenses other than
# (ASL 2.0 or GPL-3.0-or-later), but are not packaged in any of the binary
# RPMs:
#
# CC0-1.0:
# - .editorconfig (not installed)
# - .gitlab-ci.yml (not installed)
# - gi-docgen.doap (not installed)
# - MANIFEST.in (not installed)
# - pytest.ini (not installed)
#
# CC-BY-SA-3.0:
# - docs/gi-docgen.{png,svg} (for HTML docs; not currently packaged)
# - code-of-conduct.md (not installed)
#
# OFL-1.1:
# - gidocgen/templates/basic/*.{woff,woff2}
#
# GPL-2.0-or-later:
# - test/gir/{Utility-1.0,Regress-1.0}.gir (not installed; test only)
#
# LGPL-2.0-or-later:
# - test/gir/{GLib,GObject,Gio}-2.0.gir (not installed; test only)
#
# LGPL-2.0-or-later OR MPL-1.1:
# - test/gir/cairo-1.0.gir (not installed; test only)
#

BIN
gi-docgen-2023.1.tar.gz (Stored with Git LFS)

Binary file not shown.

BIN
gi_docgen-2024.1.tar.gz (Stored with Git LFS) Normal file

Binary file not shown.

View File

@@ -0,0 +1,2 @@
# We don't want to split the package only because of one file.
addFilter("E: devel-file-in-non-devel-package");

View File

@@ -1,3 +1,90 @@
-------------------------------------------------------------------
Tue May 21 11:06:47 UTC 2024 - Dominique Leuenberger <dimstar@opensuse.org>
- Update to version 2024.1:
+ Added
- Add unit testing for link syntax
- Support link to enumeration members
- Add favicon support
- Add proper anchor for enum members
- Parse optional anchors in links
- Generate a link to finish functions
- Add 'inline' to C declarations for inline callables
- Make the logo a link to the index
- Clear search when pressing Escape
+ Changed
- Update the wording for transfer modes
- Turn deprecation notices into admonitions
- Improve filesystem string type docs
+ Fixed
- Fix doubled paragraph tags around descriptions
- Append period after last line in more cases
- Documentation fixes
- Use the basename of the urlmap file
+ Removed
- Revert "generate: Add fallback for missing "since""
-------------------------------------------------------------------
Tue Feb 20 18:20:41 UTC 2024 - Michael Gorse <mgorse@suse.com>
- Require python3-tomli if python3-base is on v3.6 (ie, SLE 15).
-------------------------------------------------------------------
Sat Nov 25 20:05:02 UTC 2023 - Bjørn Lie <bjorn.lie@gmail.com>
- Update to version 2023.3:
+ Fixed:
- Add missing dependency
- Add missing test data to the source archive
- Changes from version 2023.2:
+ Added:
- Use packaging module to properly compare versions
- Add "implements" in class definition pseudocode
- Ignore the first class instance struct field
- Parse default-value attribute
- Test the gtk-doc sigil parsing
- Support admonitions in docblocks
- Add link to the extra content files location in the source
repository
- Search for GIR XML in $GI_GIR_PATH and /usr/share/gir-1.0
- Add fallback for missing "since"
+ Changed:
- Redesign the search results
- Redesign the index for enumeration types
+ Fixed:
- Match dependencies list in the index and sidebar
- Use KeyboardEvent.key to focus search input
- Build fixes for subproject use
- Remove display:flex from headings
- Split transfer notes based on direction
- Clarify signal flags
- Hide build section if empty
- Always explicitely use utf-8 when reading/writing files
- Use color-scheme: dark when in dark mode
- Drop python3-tomli BuildRequires: No longer needed.
- Add python3-packaging BuildRequires/Requires: New dependency.
-------------------------------------------------------------------
Tue Jan 10 13:13:36 UTC 2023 - Luciano Santos <luc14n0@opensuse.org>
- Drop python3-coverage and python3-green package sugestion as they
are really meant for development, not for packaging purposes.
- Drop update-alternatives facility. GI-DocGen turned out to be a
non-user-facing software, so there's no need to have alternatives
for it and we're already producing only the main Python 3 flavor
anyway.
- Change URL tag from gitlab.gnome.org/ebassi/gi-docgen to
gitlab.gnome.org/GNOME/gi-docgen. GI-DocGen is an official
project under the GNOME umbrella now.
- Update "Apache-2.0 AND GPL-3.0-or-later AND CC0-1.0" License tag
to "(Apache-2.0 OR GPL-3.0-or-later) AND CC0-1.0 AND MIT AND
OFL-1.1", to account for a couple of missed licenses, and a
choice between Apache and GPL licenses.
- Following the changes from version 2023.1, use tomli Python
module as build and runtime requirement for Python older than
3.11. Otherwise, the tomllib Python module, provided by the
standard library, is going to be used instead.
-------------------------------------------------------------------
Fri Jan 6 19:34:04 UTC 2023 - Bjørn Lie <bjorn.lie@gmail.com>

View File

@@ -1,7 +1,7 @@
#
# spec file for package python-gi-docgen
#
# Copyright (c) 2023 SUSE LLC
# Copyright (c) 2024 SUSE LLC
#
# All modifications and additions to the file contributed by third parties
# remain the property of their copyright owners, unless otherwise agreed
@@ -18,62 +18,72 @@
%define pythons python3
Name: python-gi-docgen
Version: 2023.1
Version: 2024.1
Release: 0
Summary: Documentation tool for GObject-based libraries
License: Apache-2.0 AND GPL-3.0-or-later AND CC0-1.0
URL: https://gitlab.gnome.org/ebassi/gi-docgen
Source: https://files.pythonhosted.org/packages/source/g/gi-docgen/gi-docgen-%{version}.tar.gz
Summary: A documentation generator for GObject-based libraries
# For reference, as some scripts are known to reorder things:
# (Apache-2.0 OR GPL-3.0-or-later) AND CC0-1.0 AND MIT AND OFL-1.1
License: (Apache-2.0 OR GPL-3.0-or-later) AND CC0-1.0 AND MIT AND OFL-1.1
URL: https://gitlab.gnome.org/GNOME/gi-docgen
Source: https://files.pythonhosted.org/packages/source/g/gi-docgen/gi_docgen-%{version}.tar.gz
Source98: README.license
Source99: %{name}-rpmlintrc
BuildRequires: %{python_module setuptools}
BuildRequires: %{python_module wheel}
BuildRequires: python-rpm-macros
# SECTION test requirements
BuildRequires: %{python_module Jinja2}
BuildRequires: %{python_module Markdown}
BuildRequires: %{python_module MarkupSafe}
BuildRequires: %{python_module Pygments}
BuildRequires: %{python_module toml}
BuildRequires: %{python_module typogrify}
# /SECTION
BuildRequires: fdupes
Requires: python-Jinja2
Requires: python-Markdown > 3.2.0
Requires: python-MarkupSafe
Requires: python-Pygments
Requires: python-toml
Requires: python-typogrify
Suggests: python-coverage
Suggests: python-green
BuildRequires: python-rpm-macros
## Build system dependencies
BuildRequires: python3-setuptools
BuildRequires: python3-wheel
##
BuildRequires: python3-Jinja2
BuildRequires: python3-Markdown
BuildRequires: python3-MarkupSafe
BuildRequires: python3-Pygments
BuildRequires: python3-packaging
BuildRequires: python3-typogrify
Requires: python3-Jinja2
Requires: python3-Markdown > 3.2.0
Requires: python3-MarkupSafe
Requires: python3-Pygments
Requires: python3-packaging
Requires: python3-typogrify
Requires: (python3-tomli if ((python310-base with python3-base) or (python39-base with python3-base)))
Requires: (python3-tomli if python3-base < 3.7)
Obsoletes: python38-gi-docgen < %{version}
BuildArch: noarch
%python_subpackages
%description
Documentation tool for GObject-based libraries
GI-DocGen is a document generator for GObject-based libraries.
GObject is the base type system of the GNOME project. GI-Docgen
reuses the introspection data generated by GObject-based libraries
to generate the API reference of these libraries, as well as other
ancillary documentation.
%prep
%autosetup -n gi-docgen-%{version} -p1
%autosetup -n gi_docgen-%{version} -p1
# Copy README.license to the source tree, so we can use the %%doc macro on it.
cp %{SOURCE98} .
%build
%python_build
%python3_build
%install
%python_install
%python_clone -a %{buildroot}%{_bindir}/gi-docgen
%python_expand %fdupes %{buildroot}%{$python_sitelib}
%post
%python_install_alternative gi-docgen
%postun
%python_uninstall_alternative gi-docgen
%python3_install
%fdupes %{buildroot}%{python3_sitelib}
%files %{python_files}
%doc README.md
%license LICENSES LICENSES/Apache-2.0.txt LICENSES/GPL-3.0-or-later.txt
%python_alternative %{_bindir}/gi-docgen
%{python_sitelib}/*
%doc README.md README.license
%license LICENSES/Apache-2.0.txt
%license LICENSES/GPL-3.0-or-later.txt
%license LICENSES/MIT.txt
%license LICENSES/OFL-1.1.txt
%license LICENSES/CC0-1.0.txt
%{_bindir}/gi-docgen
%{python3_sitelib}/gidocgen/
%{python3_sitelib}/gi_docgen-%{version}-py%{python3_version}.egg-info/
%{_mandir}/man1/gi-docgen.1%{?ext_man}
%{_datadir}/pkgconfig/gi-docgen.pc