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

Incorrectly displayed version selector in non-versioned docs #1667

Closed
hyrodium opened this issue Aug 7, 2021 · 2 comments · Fixed by #1825
Closed

Incorrectly displayed version selector in non-versioned docs #1667

hyrodium opened this issue Aug 7, 2021 · 2 comments · Fixed by #1825
Labels
Format: HTML Related to the default HTML output Type: Bug

Comments

@hyrodium
Copy link
Contributor

hyrodium commented Aug 7, 2021

We can generate non-versioned docs since #1616 is merged. But in the following case, versions will be displayed incorrectly.

  • github.com/<user>/<user>.github.io is versioned
  • github.com/<user>/<repo> is non-versioned

In this case, https://<user>.github.io/<repo> shows a version selector of github.com/<user>/<user>.github.io.

@fredrikekre
Copy link
Member

Do you have a live example? I don't really understand the issue.

@hyrodium
Copy link
Contributor Author

hyrodium commented Oct 21, 2021

Here's an example:

In the seminar log, I can see the version selector from the homepage.

image

This is because, the generated HTML file of the seminar log looks for ../versions.js even if it's non-versioned. (If can't find the versions.js file, the version selector will not be displayed.)

In this cases, the path of versions.js is https://hyrodium.github.io/versions.js, and it is equivalent to:

To solve this issue, we need to add some information to makedocs about whether it is versioned or not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Format: HTML Related to the default HTML output Type: Bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants