app-doc/cantera-docs: New package
authorband-a-prend <torokhov-s-a@yandex.ru>
Sat, 29 Sep 2018 20:44:27 +0000 (23:44 +0300)
committerMichał Górny <mgorny@gentoo.org>
Wed, 28 Nov 2018 10:30:18 +0000 (11:30 +0100)
The commit adds new package 'app-doc/cantera-docs' (2.4.0) that install
the API documentatoin for 'sci-libs/cantera' package.

Description:
Cantera Doxygen API Documentation for C++ library and Sphinx API Documentation
for CTI tool, Python module and Matlab interface.

Unfortunately there is no official documentation tarball for latest version
of Cantera. So this package download the tarball build by myself from sources.
This tarball includes modifications of 'Menubar' to navigate local sections.

https://user-images.githubusercontent.com/18756734/46048699-7bd74b00-c133-11e8-8fe2-77480a33ef19.png

and patch for async loading remote javascript and css files that allow
to render pages without long delays in some cases of offline reading.

Signed-off-by: Sergey Torokhov <torokhov_s_a@mail.ru>
Closes: https://github.com/gentoo/gentoo/pull/10017
Signed-off-by: Michał Górny <mgorny@gentoo.org>
app-doc/cantera-docs/Manifest [new file with mode: 0644]
app-doc/cantera-docs/cantera-docs-2.4.0.ebuild [new file with mode: 0644]
app-doc/cantera-docs/metadata.xml [new file with mode: 0644]

diff --git a/app-doc/cantera-docs/Manifest b/app-doc/cantera-docs/Manifest
new file mode 100644 (file)
index 0000000..3119f74
--- /dev/null
@@ -0,0 +1 @@
+DIST cantera-docs-2.4.0.tar.xz 4915944 BLAKE2B c7c40651ec8b4c6f6488c49cc991a115f08d6053b3383e28660028e72a55b2c231bfcfde976bec5e2be85828e642668d71730bdc803198bdcdee0631c09208ec SHA512 182475b180e65bb8bd7d5259a3b2a385b2b7c7db61a258a460c3e5fa91ae101306702ea3f00c6996a65ae8ebd1985dcc84b6d8291434578938efbb584db94c40
diff --git a/app-doc/cantera-docs/cantera-docs-2.4.0.ebuild b/app-doc/cantera-docs/cantera-docs-2.4.0.ebuild
new file mode 100644 (file)
index 0000000..9a9bf21
--- /dev/null
@@ -0,0 +1,29 @@
+# Copyright 1999-2018 Gentoo Foundation
+# Distributed under the terms of the GNU General Public License v2
+
+EAPI=6
+
+inherit desktop
+
+DESCRIPTION="Documentation API reference for Cantera package libraries"
+HOMEPAGE="https://cantera.org"
+SRC_URI="https://github.com/band-a-prend/gentoo-overlay/releases/download/ct-docs-${PV}/${P}_modified_menu.tar.xz -> ${P}.tar.xz"
+
+LICENSE="BSD"
+SLOT="0"
+KEYWORDS="~amd64 ~x86"
+IUSE=""
+
+RDEPEND="
+       x11-misc/xdg-utils
+"
+
+S="${WORKDIR}/"
+
+src_install() {
+       insinto /usr/share/cantera/doc/
+       doins -r "${S}/."
+
+       make_desktop_entry "/usr/bin/xdg-open /usr/share/cantera/doc/doxygen/html/index.html" "Cantera Doxygen Documentation" "text-html" "Development"
+       make_desktop_entry "/usr/bin/xdg-open /usr/share/cantera/doc/sphinx/html/index.html" "Cantera Sphinx Documentation" "text-html" "Development"
+}
diff --git a/app-doc/cantera-docs/metadata.xml b/app-doc/cantera-docs/metadata.xml
new file mode 100644 (file)
index 0000000..8515d68
--- /dev/null
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
+<pkgmetadata>
+  <maintainer type="person">
+    <email>torokhov_s_a@mail.ru</email>
+    <name>Sergey Torokhov</name>
+  </maintainer>
+  <maintainer type="project">
+    <email>proxy-maint@gentoo.org</email>
+    <name>Proxy Maintainers</name>
+  </maintainer>
+<longdescription lang="en">
+Cantera Doxygen API Documentation for C++ library
+and Sphinx API Documentation for CTI tool, Python module and Matlab interface.
+</longdescription>
+</pkgmetadata>