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

Doc builds index.html with invalid link to "annotated.php" #1652

Closed
FalcoGer opened this issue Apr 21, 2020 · 3 comments · Fixed by #1665
Closed

Doc builds index.html with invalid link to "annotated.php" #1652

FalcoGer opened this issue Apr 21, 2020 · 3 comments · Fixed by #1665
Projects
Milestone

Comments

@FalcoGer
Copy link

Subject of the issue

When building documents with the -DSFML_BUILD_DOC=TRUE flags, the index.html file will have a link to annotated.php

<div class="textblock"><h1><a class="anchor" id="welcome"></a>
Welcome</h1>
<p>Welcome to the official SFML documentation. Here you will find a detailed view of all the SFML <a href="./annotated.php">classes</a> and functions. <br />

However neither does this file exist, nor should a .php file be included in the offline documentation.

Your environment

  • OS: Ubuntu Mate 18.04 LTS (Linux *** 4.15.0-96-generic #97-Ubuntu SMP Wed Apr 1 03:25:46 UTC 2020 x86_64 x86_64 x86_64 GNU/Linux)
  • SFML Version: 2.5.1 (master 50e173e)
  • Your compiler and compiler version used: gcc/g++ (Ubuntu 9.3.0-10ubuntu2~18.04) 9.3.0
  • Special compiler flags used: none

Steps to reproduce

Build documentation and check index.html

Expected behavior

The word Classes links to a page with a list of classes, or isn't a linkg at all

Actual behavior

The word Classes links to annotated.php, which does not exist

@eXpl0it3r
Copy link
Member

Thanks for pointing this out. The same files are being used to generate the official documentation on the website and there exists an annotated.php. The link is part of the custom HTML for the landing page.
I don't really think, that's a big issue, but the only "fix" I see to keep it compatible, would be to just remove the link.

Do you have any other suggestion on how to solve this?

@FalcoGer
Copy link
Author

you could make it a fully qualified link to https://stml-dev.org/annotated.php (or wherever it is located) instead of using a relative link.

@eXpl0it3r
Copy link
Member

That unfortunately doesn't really work, if you're browsing an older version of the API documentation, for example like this: https://www.sfml-dev.org/documentation/2.3.1/annotated.php

I think it's probably better to just remove the link, as the same navigation point is available on the same page.

@eXpl0it3r eXpl0it3r added this to Discussion in SFML 2.6.0 via automation May 26, 2020
@eXpl0it3r eXpl0it3r added this to the 2.6 milestone May 26, 2020
@eXpl0it3r eXpl0it3r moved this from Discussion to Review & Testing in SFML 2.6.0 May 26, 2020
SFML 2.6.0 automation moved this from Review & Testing to Done May 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
SFML 2.6.0
  
Done
Development

Successfully merging a pull request may close this issue.

2 participants