3f899e34a5
[skip changelog]
220 lines
6.7 KiB
RPMSpec
220 lines
6.7 KiB
RPMSpec
# Sphinx-generated HTML documentation is not suitable for packaging; see
|
||
# https://bugzilla.redhat.com/show_bug.cgi?id=2006555 for discussion.
|
||
#
|
||
# We can generate PDF documentation as a substitute.
|
||
%bcond_without doc_pdf
|
||
|
||
Name: gi-docgen
|
||
Version: 2023.1
|
||
Release: %autorelease
|
||
Summary: Documentation tool for GObject-based libraries
|
||
|
||
# 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 (-doc subpackage)
|
||
# - examples/*.toml (-doc subpackage)
|
||
#
|
||
# 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 (Apache-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} (removed in prep)
|
||
#
|
||
# 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)
|
||
License: (Apache-2.0 OR GPL-3.0-or-later) AND MIT AND CC0-1.0
|
||
URL: https://gitlab.gnome.org/GNOME/gi-docgen
|
||
Source0: %{url}/-/archive/%{version}/gi-docgen-%{version}.tar.bz2
|
||
|
||
# We are prohibited from bundling fonts, and we are prohibited from shipping
|
||
# fonts in web font formats; see
|
||
# https://docs.fedoraproject.org/en-US/packaging-guidelines/FontsPolicy/#_web_fonts.
|
||
#
|
||
# Since upstream uses *only* web fonts, we need a patch. We haven’t offered it
|
||
# upstream since upstream has no reason NOT to use web fonts.
|
||
#
|
||
# This patch removes all references to WOFF/WOFF2 font files (which we still
|
||
# must remove in %%prep) and ensures the CSS correctly references corresponding
|
||
# local system fonts.
|
||
Patch: gi-docgen-2022.2-no-web-fonts.patch
|
||
|
||
BuildArch: noarch
|
||
|
||
BuildRequires: python3-devel
|
||
|
||
BuildRequires: python3dist(pytest)
|
||
|
||
# Documentation
|
||
%if %{with doc_pdf}
|
||
BuildRequires: make
|
||
BuildRequires: python3dist(sphinx)
|
||
BuildRequires: python3dist(sphinx-rtd-theme)
|
||
BuildRequires: python3-sphinx-latex
|
||
BuildRequires: latexmk
|
||
%endif
|
||
|
||
# Unbundling fonts:
|
||
BuildRequires: font(redhatdisplay)
|
||
BuildRequires: font(redhatdisplayblack)
|
||
BuildRequires: font(redhatdisplaymedium)
|
||
BuildRequires: font(redhattext)
|
||
BuildRequires: font(redhattextmedium)
|
||
BuildRequires: font(sourcecodepro)
|
||
BuildRequires: font(sourcecodeprosemibold)
|
||
|
||
# Unbundling fonts:
|
||
Requires: gi-docgen-fonts = %{version}-%{release}
|
||
|
||
# Trivial fork of https://github.com/jhawthorn/fzy.js (looks like it was
|
||
# basically just wrapped in an IIFE). Given that modification, it’s not clear
|
||
# how we could unbundle it, either downstream or with some kind of upstream
|
||
# support.
|
||
#
|
||
# It’s not clear what version was used for the fork.
|
||
Provides: bundled(js-fzy)
|
||
|
||
%description
|
||
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.
|
||
|
||
GI-DocGen is not a general purpose documentation tool for C libraries.
|
||
|
||
While GI-DocGen can be used to generate API references for most GObject/C
|
||
libraries that expose introspection data, its main goal is to generate the
|
||
reference for GTK and its immediate dependencies. Any and all attempts at
|
||
making this tool more generic, or to cover more use cases, will be weighted
|
||
heavily against its primary goal.
|
||
|
||
GI-DocGen is still in development. The recommended use of GI-DocGen is to add
|
||
it as a sub-project to your Meson build system, and vendor it when releasing
|
||
dist archives.
|
||
|
||
You should not depend on a system-wide installation until GI-DocGen is declared
|
||
stable.
|
||
|
||
|
||
%package fonts
|
||
Summary: Metapackage providing fonts for gi-docgen output
|
||
# Really, there is nothing copyrightable in this metapackage, so we give it the
|
||
# overall license of the project.
|
||
License: Apache-2.0 OR GPL-3.0-or-later
|
||
|
||
Requires: font(redhatdisplay)
|
||
Requires: font(redhatdisplayblack)
|
||
Requires: font(redhatdisplaymedium)
|
||
Requires: font(redhattext)
|
||
Requires: font(redhattextmedium)
|
||
Requires: font(sourcecodepro)
|
||
Requires: font(sourcecodeprosemibold)
|
||
|
||
%description fonts
|
||
Because web fonts from upstream are not bundled in the gi-docgen package,
|
||
documentation packages generated with gi-docgen must depend on this metapackage
|
||
to ensure the proper system fonts are present.
|
||
|
||
|
||
%package doc
|
||
Summary: Documentation for gi-docgen
|
||
License: (Apache-2.0 OR GPL-3.0-or-later) AND CC0-1.0
|
||
|
||
%description doc
|
||
Documentation for gi-docgen.
|
||
|
||
|
||
%generate_buildrequires
|
||
%pyproject_buildrequires
|
||
|
||
|
||
%prep
|
||
%autosetup -p1
|
||
|
||
# Remove all bundled fonts. See gi-docgen-*-no-web-fonts.patch.
|
||
find . -type f \( -name '*.woff' -o -name '*.woff2' \) -print -delete
|
||
|
||
|
||
%build
|
||
%pyproject_wheel
|
||
|
||
%if %{with doc_pdf}
|
||
sphinx-build -b latex -j%{?_smp_build_ncpus} docs %{_vpath_builddir}/_latex
|
||
%make_build -C %{_vpath_builddir}/_latex LATEXMKOPTS='-quiet'
|
||
%endif
|
||
|
||
|
||
%install
|
||
%pyproject_install
|
||
%pyproject_save_files gidocgen
|
||
|
||
install -t '%{buildroot}%{_pkgdocdir}' -D -m 0644 -p \
|
||
CHANGES.md \
|
||
CONTRIBUTING.md \
|
||
docs/CODEOWNERS \
|
||
README.md
|
||
%if %{with doc_pdf}
|
||
install -t '%{buildroot}%{_pkgdocdir}' -p -m 0644 \
|
||
'%{_vpath_builddir}/_latex/gi-docgen.pdf'
|
||
%endif
|
||
cp -rp examples '%{buildroot}%{_pkgdocdir}/'
|
||
|
||
|
||
%check
|
||
%pytest
|
||
|
||
|
||
%files -f %{pyproject_files}
|
||
%license LICENSES/*.txt .reuse/dep5
|
||
|
||
%{_bindir}/gi-docgen
|
||
%{_mandir}/man1/gi-docgen.1*
|
||
# Normally, this would go in a -devel package, but there is little point in
|
||
# providing a -devel package for *just* the .pc file when there are no
|
||
# libraries or headers.
|
||
%{_datadir}/pkgconfig/gi-docgen.pc
|
||
|
||
|
||
%files fonts
|
||
# Empty; this is a metapackage
|
||
|
||
|
||
%files doc
|
||
%license LICENSES/*.txt .reuse/dep5
|
||
%doc %{_pkgdocdir}
|
||
|
||
|
||
%changelog
|
||
%autochangelog
|