-
-
Notifications
You must be signed in to change notification settings - Fork 25.9k
DOC Fix broken link to docs #15364
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 Fix broken link to docs #15364
Conversation
@jnothman @rth @NicolasHug Adds a documentation page that just redirects. https://79890-843222-gh.circle-artifacts.com/0/doc/documentation.html redirects to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nits but LGTM, can't hurt I guess
doc/templates/documentation.html
Outdated
<meta http-equiv="Refresh" content="0; url={{ pathto('index') }}" /> | ||
</head> | ||
<body> | ||
<p>Please follow <a href="{{ pathto('index') }}">this link</a>.</p> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe something like
"You will be automatically redirected to the main page"
doc/conf.py
Outdated
@@ -171,7 +171,8 @@ | |||
|
|||
# Additional templates that should be rendered to pages, maps page names to | |||
# template names. | |||
html_additional_pages = {'index': 'index.html'} | |||
html_additional_pages = {'index': 'index.html', | |||
'documentation': 'documentation.html'} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
'documentation': 'documentation.html'} | |
'documentation': 'documentation.html'} # redirects to index``` |
<!DOCTYPE html> | ||
<html> | ||
<head> | ||
<meta http-equiv="Refresh" content="0; url={{ pathto('index') }}" /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should probably also use a <link rel=canonical
to tell search engines this is permanent
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! CI is failing because of an unrelated issue on master..
Can confirm it works now @oke-aditya . Maybe the build wasn't updated yet when you tried |
|
Reference Issues/PRs
Fixes #15362
What does this implement/fix? Explain your changes.
Adds documentation as a redirect to index