Re: [gentoo-dev] Fwd: New eclass suggestion: docs.eclass

[Haelwenn (lanodan) Monnier]

[2020-04-27 18:10:43+0200] Andrew Ammerlaan:
> # Copyright 1999-2020 Gentoo Authors
> # Distributed under the terms of the GNU General Public License v2
>
> # @ECLASS: docs.eclass
> # @MAINTAINER:
> # Andrew Ammerlaan <andrewammerlaan@××××××.net>
> # @AUTHOR:
> # Author: Andrew Ammerlaan <andrewammerlaan@××××××.net>
> # Based on the work of: Michał Górny <mgorny@g.o>
> # @SUPPORTED_EAPIS: 5 6 7
> # @BLURB: A simple eclass to build documentation.
> # @DESCRIPTION:
> # A simple eclass providing functions to build documentation.
> #
> # Please note that docs sets RDEPEND and DEPEND unconditionally
> # for you.
> #
> # This eclass also appends "doc" to IUSE, and sets HTML_DOCS
> # to the location of the compiled documentation
> #
> # The aim of this eclass is to make it easy to add additional
> # doc builders. To do this, add a <DOCBUILDER>-setup and
> # <DOCBUILDER>-build function for your doc builder.
> # For python based doc builders you can use the
> # python_append_deps function to append [${PYTHON_USEDEP}]
> # automatically to additional dependencies
> #
> # For more information, please see the Python Guide:
> # https://dev.gentoo.org/~mgorny/python-guide/

Should change this part to not be about python docs, right?

>
> case "${EAPI:-0}" in
> 	0|1|2|3|4)
> 		die "Unsupported EAPI=${EAPI:-0} (too old) for ${ECLASS}"
> 		;;
> 	5|6|7)
> 		;;
> 	*)
> 		die "Unsupported EAPI=${EAPI} (unknown) for ${ECLASS}"
> 		;;
> esac
>
> # @ECLASS-VARIABLE: DOCBUILDER
> # @REQUIRED
> # @PRE_INHERIT
> # @DESCRIPTION:
> # Sets the doc builder to use, currently supports
> # sphinx and mkdocs
>
> # @ECLASS-VARIABLE: DOCDIR
> # @DESCRIPTION:
> # Sets the location of the doc builder config file.

Suggestion:
Path containing the doc builder config file(s).