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

add 404 page to docs #2059

Closed
wants to merge 3 commits into from
Closed

add 404 page to docs #2059

wants to merge 3 commits into from

Conversation

maxpietsch
Copy link
Member

@maxpietsch maxpietsch commented May 20, 2020

implements a 404 page, replacing the default Maze page

  • uses the sphinx-notfound-page plugin
  • had to install it explicitly via pip in github workflow, updated the README and added a requirements.txt file in docs/
  • added the dependency to a new readthedocs yml config file

With this plugin, loading a nonexistent URL still emits a 404 signal.

One issue is that on the 404.html page, if one selects a different version of the docs from the menu, one is redirected to a 404.html page relative to that version (which does not exist for older versions) instead of reusing and following the actual link.
For instance: https://mrtrix.readthedocs.io/en/docs_404/does_not_exist --> https://mrtrix.readthedocs.io/en/latest/404.html instead of
https://mrtrix.readthedocs.io/en/latest/does_not_exist

@maxpietsch maxpietsch changed the base branch from master to dev May 20, 2020 08:13
@maxpietsch maxpietsch changed the base branch from dev to doctest June 3, 2020 08:58
@maxpietsch maxpietsch changed the base branch from doctest to dev June 4, 2020 07:23
@maxpietsch
Copy link
Member Author

maxpietsch commented Jun 4, 2020

cherry-picked 4d46989 aad948b and 60acb3b into doctest

@maxpietsch maxpietsch closed this Jun 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant