Commit graph

8 commits

Author SHA1 Message Date
Newbyte
e5dfbd9293
CI: Skip removing files that start with test in docs check
Tests were moved out of the pmb directory into their own test directory,
so no need to try to exclude them when they shouldn't be there anyway.
If test "documentation" appears in the docs with this, there's a test
that is where it shouldn't be and a separate bug.

Part-of: https://gitlab.postmarketos.org/postmarketOS/pmbootstrap/-/merge_requests/2619
2025-07-06 21:26:19 +02:00
Oliver Smith
559710c69a
CI: docs: fail on warning (MR 2506) 2024-12-03 10:08:43 +01:00
Robert Eckelmann
07592b2ab6
.ci/docs.sh: add py3-sphinxcontrib-jquery to fix the failing search (MR 2500)
Signed-off-by: Robert Eckelmann <longnoserob@postmarketos.org>
2024-11-24 18:30:06 +09:00
Luca Weiss
d64573f1b1
ci: Remove outdated sphinx-build command check (MR 2451)
We now run the job in chroot, so remove the unnecessary check. If
sphinx-build is missing for some reason, it will fail a bit further in
the script anyways.
2024-10-27 02:29:20 +02:00
Luca Weiss
35cd64086f
Improvements to documentation (MR 2440)
* Make sure all Python modules are documented by adding a bit of shell
  to .ci/docs.sh
* Remove non-existing module references from .rst
* Fix various warnings from sphinx by adjusting Python docstrings
* Add class member docs to ApkindexBlock
2024-10-21 21:46:26 +02:00
Luca Weiss
4019636f72
ci: Run docs job in chroot (MR 2413)
Use the new "Artifacts" directive for .ci/docs.sh and run the job in the
pmbootstrap chroot to avoid needing to install sphinx dependencies on
the host.

Fixes #2352
2024-10-17 19:01:30 +02:00
Oliver Smith
89a3136f08
docs: support markdown (MR 2361)
Let's write all new documentation in markdown, and convert existing ones
at some point. I think we are all much more familiar with markdown than
with the rst format.
2024-07-16 00:34:06 +02:00
Robert Eckelmann
d28174bf95
ci: add job to generate docs (MR 2266) 2024-05-14 14:36:24 +02:00