On 10/27/24 12:13 AM, kal...@debian.org wrote:
Hi Dan
On Sun, 18 Feb 2024 08:37:15 -0800 Dan Helfman <wit...@torsion.org> wrote:
Upstream dev here. Please let me know if there's anything I can do to
make this easier. (Ideally in the form of a borgmatic ticket.) Today,
the online documentation is "packaged" and served as a container image,
but I realize that's not the most convenient way to consume offline
documentation in Debian.
I had a look but the current build is to complex to have
documentation built from source with the package.
Ideally, with python project, we have a sphinx documentation which
integrate nicely. But this is quite some work to migrate the current doc
to something else I guess.
An alternative would be to release the documentation already built for
the tag being released. For instance as an extra tarbal in the release
page.
What do you think?
I'd prefer not to migrate to Sphinx, but what I did was put a tarball of
the generated HTML for the docs into the packages repository of
borgmatic. You can find it here:
https://projects.torsion.org/borgmatic-collective/borgmatic/packages
If you click on borgmatic-docs, you'll see that the URL has the version
number in it, so you should be able to fetch it programmatically for a
particular version.
I hope that helps. Please let me know if you have any feedback on this.
Thanks,
Dan
