Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation class reference links broken #158

Open
sethgi opened this issue Jul 26, 2020 · 1 comment
Open

Documentation class reference links broken #158

sethgi opened this issue Jul 26, 2020 · 1 comment

Comments

@sethgi
Copy link

sethgi commented Jul 26, 2020

Hello,

On the documentation site, all class reference links seem to be broken.

For example, at page: https://ethz-adrl.github.io/ct/ct_doc/doc/html/core_tut_control.html

clicking on any of the links (such as ct::core::PIDController) gives a 404 error.

Because I couldn't find a class reference page on the docs, I'm not sure what the intended behavior here is, but it seems like either the links should be removed or repaired.

Thanks!
-Seth

@markusgft
Copy link
Member

Hi,
I can confirm the issue for cross-referencing. E.g. when you try to navigate go a class reference in ct_core while being on the ct_optcon pages, you will get a 404 error.
The following workaround worked for me (you may resort to this as long as we do not have a proper fix). Rather than clicking the link for the class reference directly, first navigate to the correct package in the main bar

Capture

e.g. click on ct_core ... .and then search for your class of interest, e.g. "PID-Controller" on the top right search window. This means more effort, but at least you can follow the doc in the meantime.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants