sleuthkit icon indicating copy to clipboard operation
sleuthkit copied to clipboard

Please provide 4.14.0 API docs

Open joachimmetz opened this issue 6 months ago • 6 comments

It looks like the 4.14.0 API docs (https://sleuthkit.org/sleuthkit/docs/api-docs/4.14.0/) have not been released yet. Please provide them

For contrast the 4.13.0 API docs are available https://sleuthkit.org/sleuthkit/docs/api-docs/4.13.0/

joachimmetz avatar Sep 07 '25 07:09 joachimmetz

I am thinking of moving the docs to GitHub and hanging them off the repo. Any suggestion on how to do it?

simsong avatar Sep 07 '25 07:09 simsong

what is currently used to generate them? Github Actions likely has examples/integrations for many different API documentation tools

joachimmetz avatar Sep 07 '25 07:09 joachimmetz

I think that they are made with doxagen or something. My question was where do you want them hosted. I suggested GitHub pages? Would that work for you?

On Sun, Sep 7, 2025 at 10:36 AM Joachim Metz @.***> wrote:

joachimmetz left a comment (sleuthkit/sleuthkit#3375) https://github.com/sleuthkit/sleuthkit/issues/3375#issuecomment-3263560267

what is currently used to generate them? Github Actions likely has examples/integrations for many different API documentation tools

— Reply to this email directly, view it on GitHub https://github.com/sleuthkit/sleuthkit/issues/3375#issuecomment-3263560267, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAMFHLFEG63ML6MT6VPLCIL3RPN6HAVCNFSM6AAAAACF2R3EP2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTENRTGU3DAMRWG4 . You are receiving this because you commented.Message ID: @.***>

simsong avatar Sep 07 '25 08:09 simsong

My question was where do you want them hosted. I suggested GitHub pages? Would that work for you?

Ah, I interpreted your question differently. Hosting them on http://github.io/ works for me, might be the easiest if you want to integrate with Github Actions

joachimmetz avatar Sep 07 '25 08:09 joachimmetz

Integrating with github actions is my plan, but hosting at github.io is from a branch, and so then the question is are we providing API docs for develop or release or what...

I'll chase this down and get back to you.

simsong avatar Sep 07 '25 10:09 simsong

I'll chase this down and get back to you.

Thx much appreciated, no hurries, I just stumbled upon this when updating the pytsk README

joachimmetz avatar Sep 07 '25 10:09 joachimmetz