librealsense icon indicating copy to clipboard operation
librealsense copied to clipboard

librealsense.github.io yields a 404

Open hernot opened this issue 1 year ago • 9 comments

  • Before opening a new issue, we wanted to provide you with some useful suggestions (Click "Preview" above for a better view):

  • All users are welcomed to report bugs, ask questions, suggest or request enhancements and generally feel free to open new issue, even if they haven't followed any of the suggestions above :)


Required Info
Camera Model not relevant
Firmware Version not relevant
Operating System & Version not relevant
Kernel Version (Linux Only) not relevant
Platform not relevant
SDK Version librealsense2
Language all
Segment not relevant
Documentation librealsense.github.io

Issue Description

any link leading to documentation on https://librealsense.github.io yields a 404 http error. Seems as if the links would either not be up to date, the last documentation build did not complete sucessfully leaving corrupt pages or the service is down. Just tested.

hernot avatar Feb 15 '24 15:02 hernot

Hi @hernot The https://intelrealsense.github.io/ address that contains the official API documentation is also experiencing the same 404 issue at the time of writing this. These addresses may return on their own later.

In the meantime, there is a version of the documentation at the link below that draws directly from the official API documentation and is not currently affected by the 404.

https://unanancyowen.github.io/librealsense2_apireference/classes.html

MartyG-RealSense avatar Feb 15 '24 15:02 MartyG-RealSense

@MartyG-RealSense Thank you very much, but as of today the https://intelrealsense.github.io/ pages there is no gracefull comeback of the librealsense.github.op pages. Address still returns 404 state saying that there are no pages. Possibly on the last build something went unnoticed or false classified (warning instead of error) severely wrong.

grafik

hernot avatar Feb 19 '24 16:02 hernot

Thanks very much for reporting this issue again. I have highlighted it to my Intel RealSense colleagues.

MartyG-RealSense avatar Feb 19 '24 18:02 MartyG-RealSense

Trying to navigate to the intelreasense github page still gives 404 error.

Is there any other documentation on pyrealsense2 wrapper out there? I tried building the docs locally but that generates just an empty template.

Z14-A avatar Mar 02 '24 06:03 Z14-A

The pyrealsense2 documentation is currently offline due to the 404 issue. However, you can use the Wayback Machine internet page archiving site to access a version of the documentation from 2023.

https://web.archive.org/web/20230328071532/https://intelrealsense.github.io/librealsense/python_docs/_generated/pyrealsense2.html

MartyG-RealSense avatar Mar 02 '24 07:03 MartyG-RealSense

Hi @Z14-A Was the Wayback Machine documentation link above helpful for you, please? Thanks!

MartyG-RealSense avatar Mar 21 '24 08:03 MartyG-RealSense

Yes, wayback machine was helpful. Got references to all the classes and corresponding functions and attributes. Nevertheless, it still is a fallback option. Would highly appreciate pointers to creating offline documentation locally. Thank you.

Z14-A avatar Mar 21 '24 09:03 Z14-A

Whilst it is possible to build librealsense documentation locally from its downloadable source code using doxygen, I think that is just going to install documentation relevant to the C++ API rather than the pyrealsense2 wrapper.

https://github.com/IntelRealSense/librealsense/blob/master/doc/readme.md#documentation

MartyG-RealSense avatar Mar 21 '24 10:03 MartyG-RealSense

Hi @hernot and @Z14-A The C++ API docs site is now restored. Work is continuing on restoration of the pyrealsense2 site. Thanks so much for your patience!

MartyG-RealSense avatar May 30 '24 09:05 MartyG-RealSense

Hi everyone, the pyrealsense2 docs site is now restored.

https://intelrealsense.github.io/librealsense/python_docs/

MartyG-RealSense avatar Jul 18 '24 10:07 MartyG-RealSense

Case closed due to documentation sites having been restored.

MartyG-RealSense avatar Jul 24 '24 11:07 MartyG-RealSense