search

tryolabs / norfair

Lightweight Python library for adding real-time multi-object tracking to any detector.
https://tryolabs.github.io/norfair/
BSD 3-Clause "New" or "Revised" License
2.42k stars 247 forks source link

Broken documentation link #190

Closed joshfox10 closed 2 years ago

joshfox10 commented 2 years ago

It appears the documentation is no longer available since the link does not appear to work. Is there somewhere else I can obtain the documentation?

dekked commented 2 years ago

Hi @joshfox10!

The documentation is available on this site: https://tryolabs.github.io/norfair/

The links in the main README seem to work.

Can you specify which link is broken for you?

Thanks!

dekked commented 2 years ago

By any chance were you referring to https://github.com/tryolabs/norfair/pull/192?

joshfox10 commented 2 years ago

Hi @dekked, A few months ago there was a thorough documentation that described the different functions in detail, specifically 'paths', the function to skip frames, etc. I can no longer find that documentation throughout the various pages. Is it still available? Thanks!

dekked commented 2 years ago

I am unsure what you mean. Here is the documentation on Paths.

This documentation is the same as this old one but in a different format.

image

Using the menu on the left you can read the docs for each one of the classes. Is this what you were looking for?

joshfox10 commented 2 years ago

Hi @dekked , Yes, that looks like it has the info. Thanks for pointing that out.
Apologies!

dekked commented 2 years ago

No worries! Feel free to keep asking questions :)