Get Gentoo!
gentoo.org sites
gentoo.org Wiki Bugs Forums Packages
Planet Archives Sources
Infra Status
summaryrefslogtreecommitdiff
path: root/eclass/docs.eclass
Commit message (Collapse)AuthorAgeFilesLines
* Move {app-doc → app-text}/doxygenMichał Górny2024-01-121-2/+2
| | | | | | | | Per the category metadata, app-doc/ is reserved for documentation *files* and not software. Move it to app-text/ where it seems a better fit. Signed-off-by: Michał Górny <mgorny@gentoo.org>
* docs.eclass: fix sphinx/mkdocs docs building in pep517 modeAndrew Ammerlaan2023-08-251-5/+23
| | | | | | | | | | | This patch copies the sphinx-build logic from python-utils-r1.eclass to use 'python -m mkdocs' instead of plain 'mkdocs' whenever possible. This fixes building mkdocs themes in pep517 mode where the very themes we are installing would otherwise be unavailable for building the documentation. Closes: https://bugs.gentoo.org/878047 Closes: https://bugs.gentoo.org/877823 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@gentoo.org>
* docs.eclass: define missing python_check_deps()Andrew Ammerlaan2023-07-171-26/+33
| | | | | | | and remove some code duplication Closes: https://bugs.gentoo.org/910278 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@gentoo.org>
* docs.eclass: Quote argument of ":" commandUlrich Müller2023-03-261-10/+10
| | | | | | This avoids globbing, see: https://www.shellcheck.net/wiki/SC2223 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass: standardize prologue/epilogueDavid Seifert2023-03-171-2/+2
| | | | | Closes: https://github.com/gentoo/gentoo/pull/30061 Signed-off-by: David Seifert <soap@gentoo.org>
* python-single-r1.eclass: drop EAPI 6 supportDavid Seifert2022-12-271-3/+3
| | | | Signed-off-by: David Seifert <soap@gentoo.org>
* python-r1.eclass: drop EAPI 6 supportDavid Seifert2022-12-271-1/+1
| | | | Signed-off-by: David Seifert <soap@gentoo.org>
* python-any-r1.eclass: drop EAPI 6 supportDavid Seifert2022-12-271-1/+1
| | | | Signed-off-by: David Seifert <soap@gentoo.org>
* docs.eclass: drop EAPI 6 supportDavid Seifert2022-12-271-17/+7
| | | | Signed-off-by: David Seifert <soap@gentoo.org>
* docs.eclass: add initialize_git_repo helper functionAndrew Ammerlaan2022-11-161-0/+35
| | | | Signed-off-by: Andrew Ammerlaan <andrewammerlaan@gentoo.org>
* docs.eclass: allow multiple doc builders in one ebuildAndrew Ammerlaan2022-11-161-18/+28
| | | | Signed-off-by: Andrew Ammerlaan <andrewammerlaan@gentoo.org>
* *.eclass: @ECLASS-VARIABLE renamed to @ECLASS_VARIABLEUlrich Müller2022-03-241-6/+6
| | | | | Bug: https://bugs.gentoo.org/835396 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass/docs.eclass: invert (B)DEPEND if conditionAndrew Ammerlaan2021-07-011-1/+1
| | | | | | | | | As suggested by Soap (Thank You!) Makes this part more future proof, and removes the "," that shouldn't have been there. Signed-off-by: Andrew Ammerlaan <andrewammerlaan@gentoo.org>
* eclass/docs.eclass: EAPI 8 supportAndrew Ammerlaan2021-06-301-4/+4
| | | | | | Add support for EAPI 8, and update the PYTHON_COMPAT var in example. Signed-off-by: Andrew Ammerlaan <andrewammerlaan@gentoo.org>
* */*: Update my email addressAndrew Ammerlaan2021-05-191-2/+2
| | | | Signed-off-by: Andrew Ammerlaan <andrewammerlaan@gentoo.org>
* eclass/docs.eclass: quickfix, add missing "s"Andrew Ammerlaan2021-03-111-1/+1
| | | | | Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Signed-off-by: Joonas Niilola <juippis@gentoo.org>
* eclass/docs.eclass: make compatible with python-single-r1Andrew Ammerlaan2021-01-281-51/+111
| | | | | | | | | | | | | python-single-r1 does not have the pyhton_gen_any-dep function, use the pyhton_gen_cond_dep instead also a much needed update to the documentation of this eclass. Fixed typos, and added proper examples. Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Closes: https://github.com/gentoo/gentoo/pull/19078 Signed-off-by: Joonas Niilola <juippis@gentoo.org>
* eclass: [QA] Revert multiple meaningless doc changesMichał Górny2020-12-281-7/+1
| | | | | | | | | | | Revert multiple meaningless eclass documentation changes, notably adding a lot of placeholders and documenting implementation details. These changes were aimed at silencing (valid) documentation warnings without actually providing valuable documentation to the end users. While some of these changes were beneficial, it would take a lot of effort to review them all and the author is unwilling to fix his mistakes. Signed-off-by: Michał Górny <mgorny@gentoo.org>
* eclass/docs: fixup documentationAaron Bauman2020-12-161-1/+7
| | | | Signed-off-by: Aaron Bauman <bman@gentoo.org>
* eclass/docs: quick fixesAndrew Ammerlaan2020-12-081-28/+10
| | | | | | | | | | | | | | | | - remove DOCS_EXTRA_ARGS: it causes too many problems with "unexpected arguments" and it is not used anyway - fix the append_deps function: apperently I messed up somewhere and all deps but the first got ignored - remove the check_deps function: it is not required and is causing more problems at the moment (did the python eclasses change the way they handle this function?) Package-Manager: Portage-2.3.98, Repoman-2.3.22 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Signed-off-by: Joonas Niilola <juippis@gentoo.org>
* eclass/docs: quick fix with doxygenAndrew Ammerlaan2020-12-071-1/+1
| | | | | | | Package-Manager: Portage-3.0.11, Repoman-3.0.2 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Closes: https://github.com/gentoo/gentoo/pull/18530 Signed-off-by: Joonas Niilola <juippis@gentoo.org>
* eclass/docs: setup mkdocs deps and build docsAndrew Ammerlaan2020-12-051-0/+354
works with sphinx, mkdocs and doxygen. Based on distutils_enable_sphinx, but unlike distutils also works for non-python packages Package-Manager: Portage-2.3.98, Repoman-2.3.22 Signed-off-by: Andrew Ammerlaan <andrewammerlaan@riseup.net> Signed-off-by: Jason A. Donenfeld <zx2c4@gentoo.org>