Pcl: [Documentation] Web documentation is broken

[mehditlili]

Describe the bug

Some links from a documentation page that lead to other documentation pages do not work. Not sure if this is an isolated case or if that happens to many pages.
The current web-hosted documentation can be accessed via the github page.

Context

Checking headers from the documentation

Expected behavior

A working web-hosted documentation

Current Behavior

404 Error not found

To Reproduce

In this page click on #include <pcl/PointIndices.h>on the top of the page, it will lead you to a non-existing page.

[kunaltyagi]

PCL README has links to the new locations. Sorry for the inconvenience

[mehditlili]

@kunaltyagi The new documentation seems to have some problems too. If you go to this page for example and click on #include <pcl/PointIndices.h> on the top it will lead to a non-existing page.

[kunaltyagi]

@SergioRAgostinho are the sources being generated?

[SergioRAgostinho]

No idea, this is doxygen stuff which means it should reflect the master branch of https://github.com/PointCloudLibrary/documentation.

I only touched the tutorials and advanced :/. Better to leave this open.

[mehditlili]

I edited the issue to remove the stuff related to Google searches.

[stale[bot]]

Marking this as stale due to 30 days of inactivity. It will be closed in 7 days if no further activity occurs.

[kunaltyagi]

@aPonza: the sources don't seem to be generated on the documentation CI

[aPonza]

I had an old build and the file it should be pointing to is PointIndices_8h_source.html and not _point_indices_8h_source.html, let me see if master has this issue.

[aPonza]

master indeed produces the file _point_indices_8h_source.html, not sure why it would be unreachable, is the server inspectable? Could there have been a push issue?

[kunaltyagi]

is the server inspectable

The CI code is in .ci/azure-pipelines/documentation.yaml

[aPonza]

I know the docker is, I was thinking about
https://pointclouds.org/documentation/

Also I should run the CI doc job locally to double check master on its
machine and not on mine, you're right, I can do that tomorrow though. In
fact it might be the likely culprit, with the change to 20.04

On Sat, 6 Jun 2020, 04:35 Kunal Tyagi, [e-mail] wrote:

is the server inspectable

The CI code is in .ci/azure-pipelines/documentation.yaml

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/PointCloudLibrary/pcl/issues/4057#issuecomment-639961573,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/AJKALD5X24UOJYUQCR3HBYLRVGTO5ANCNFSM4M2LMURA
.

[aPonza]

I can confirm doc CI generates _point_indices_8h_source.html. I think the issue lies in the server, as I said before, but I'm not sure how it could. In fact it seems linked to how the page's name starts with an underscore, check this page's header, or this one for example.

[kunaltyagi]

This is quite ... interesting. The OP's link has suffix structpcl_1_1_point_indices.html

On the documentation repo, a file exists, with same suffix and prefix https://github.com/PointCloudLibrary/documentation/blob/gh-pages/.

The link on header file points to a _point_indices_8h_source.html, and we can check if https://github.com/PointCloudLibrary/documentation/blob/gh-pages/_point_indices_8h_source.html exists.

Spoiler: It does.

[aPonza]

That's what I'm saying, my example pages' linked headers (1, 2) exist as well, so it's likely a problem in the service. Anyways, I had no idea what I was looking for was a repo, though... this makes it...eh...

[kunaltyagi]

This is an issue with GitHub pages? o.O I created a GitLab page setup, and guess what?

The links work

[aPonza]

From jekyll's docs:

Every file or directory beginning with the following characters: ., _ , # or ~ in the source directory will not be included in the destination folder. Such paths will have to be explicitly specified via the config file in the include directive to make sure they’re copied over:

include:
 - _pages
 - .htaccess

but it does seem weird we'd notice just now. Where would said config be stored (not anywhere in the repo I can see)? Or are we configuring some flags/anything else site-related somewhere? Found out from https://github.com/jekyll/jekyll/issues/8009 which says in the end it's a user issue.

BTW: I checked one of the problematic pages' source and it's, of course, identical to the uploaded version save for the timestamp and the page-title's home directory.

[kunaltyagi]

Where would said config be stored

In the repo. If you can't see, it doesn't exist.

Thanks for digging in to find the error