aboutsummaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* docs: Add intersphinx linkagesBrian Harring2024-01-271-0/+10
| | | | | | | | | For any references that go back into those, they're not reachable for doc rendering without this. Signed-off-by: Brian Harring <ferringb@gmail.com> Closes: https://github.com/pkgcore/pkgcheck/pull/658 Signed-off-by: Arthur Zamarin <arthurzam@gentoo.org>
* docs/config: explain when repo config is usedArthur Zamarin2023-05-191-1/+3
| | | | | Resolves: https://github.com/pkgcore/pkgcheck/issues/581 Signed-off-by: Arthur Zamarin <arthurzam@gentoo.org>
* Fix config loading if XDG_CONFIG_HOME is definedAlberto Gireud2023-04-241-4/+5
| | | | | | Signed-off-by: Alberto Gireud <agireud@amazon.com> Closes: https://github.com/pkgcore/pkgcheck/pull/573 Signed-off-by: Arthur Zamarin <arthurzam@gentoo.org>
* format using blackArthur Zamarin2022-12-294-132/+139
| | | | Signed-off-by: Arthur Zamarin <arthurzam@gentoo.org>
* fix docs generation styleArthur Zamarin2022-12-153-8/+14
| | | | Signed-off-by: Arthur Zamarin <arthurzam@gentoo.org>
* docs/conf.py: use snakeoil extensionArthur Zamarin2022-11-192-36/+7
| | | | Signed-off-by: Arthur Zamarin <arthurzam@gentoo.org>
* docs: fix newlines & linksArthur Zamarin2022-08-112-2/+2
| | | | Signed-off-by: Arthur Zamarin <arthurzam@gentoo.org>
* doc: drop unused MakefileTim Harder2021-03-221-193/+0
|
* doc: update api docsTim Harder2021-02-131-5/+10
| | | | Fixes #286.
* doc: bump copyright dateTim Harder2021-02-131-1/+1
|
* doc: move config doc to man dirTim Harder2021-02-132-1/+1
|
* doc: drop old development docsTim Harder2021-02-133-193/+0
|
* doc: drop unnecessary man subpageTim Harder2021-02-132-9/+1
|
* doc: don't expand content in main pageTim Harder2021-02-131-0/+1
|
* doc: drop freenode channel referenceTim Harder2020-12-221-2/+0
|
* doc: update config-related docs to include CHECKSETS infoTim Harder2020-12-181-5/+23
|
* sort imports with isortTim Harder2020-11-163-5/+4
|
* doc: minor config-related updatesTim Harder2020-02-091-5/+6
|
* doc: fix build with changed objects module layoutTim Harder2020-02-053-7/+7
|
* doc/config.rst: simplify example listTim Harder2020-01-311-20/+8
|
* doc/config.rst: add example showing default target repo overrideTim Harder2020-01-311-0/+7
|
* doc/config.rst: add reporter and cache usage setting config exampleTim Harder2020-01-311-0/+8
|
* doc: add initial config file documentation to man pageTim Harder2020-01-312-0/+51
|
* doc/conf.py: drop unnecessary py2 supportTim Harder2020-01-281-2/+0
|
* docs: drop old readthedocs setupTim Harder2020-01-281-7/+0
|
* drop parallelism item from todo list since it's supportedTim Harder2020-01-231-1/+0
| | | | [skip ci]
* doc: add gentoo repo specific notes for relevant keyword/check outputTim Harder2020-01-162-3/+9
|
* doc: drop todo entries that are irrelevant or have been finishedTim Harder2019-10-051-8/+0
| | | | [skip ci]
* base: use a regular class for scope objectsTim Harder2019-09-302-4/+4
|
* use scope instead of threshold for resultsTim Harder2019-09-301-1/+1
| | | | And use it to properly sort sequences of results.
* doc: keywords: add result keyword level to outputTim Harder2019-09-221-1/+2
|
* drop repoman references from man pageTim Harder2019-09-131-1/+1
|
* pkgcheck: drop _known_checks and _known_keywords usageTim Harder2019-08-163-17/+7
|
* doc: add related checks to keywords outputTim Harder2019-07-312-3/+16
|
* doc: make known results into keyword links for checks outputTim Harder2019-07-301-1/+1
|
* doc: try to preserve the formatting of check/keyword/reporter docsTim Harder2019-07-293-8/+17
| | | | That are pulled from the docstrings of the related classes.
* doc: make reporter names into subsections in man pageTim Harder2019-07-291-4/+5
|
* doc: simplify checks/keywords by pulling scopes from known scope listTim Harder2019-07-283-30/+15
| | | | | Also, use sub-headers for check/keyword names so they can be directly linked to in the generated html doc from external sites.
* doc: update man page sections for pkgcheck showTim Harder2019-07-212-7/+13
|
* bump copyrightTim Harder2019-07-151-1/+1
|
* doc/conf.py: update pkgdist.version() to module_version()Tim Harder2019-01-081-1/+1
|
* doc/man: fix typo so subcommands are included in man pageTim Harder2018-12-011-1/+1
|
* initial work towards using f-stringsTim Harder2018-06-271-2/+2
|
* doc: fix custom content generation for man pageTim Harder2018-06-184-18/+7
|
* doc/man/pkgcheck.rst: update for new snakeoil man page generationTim Harder2018-06-181-3/+4
|
* setup: use pkgdist from snakeoilTim Harder2018-06-181-2/+3
|
* fix docs generation on readthedocsTim Harder2017-09-232-10/+9
|
* doc/conf.py: strip extra whitespace before module docstring for man pagesTim Harder2017-09-211-1/+1
| | | | | Otherwise the main description header can get mangled if its on a separate line.
* pkgcheck: move description to script moduleTim Harder2017-09-131-6/+1
|
* doc/generate/pkgcheck/*: support passing in a custom file handle for outputTim Harder2017-08-293-28/+49
|