Skip to content

Commit

Permalink
[libc][docs] add redirect for math/index.html
Browse files Browse the repository at this point in the history
commit a9aff44 ("[libc][docs] reorganize documentation (llvm#118836)")

moved https://libc.llvm.org/math/index.html to
https://libc.llvm.org/headers/math/index.html which makes links from various
slide decks stale.

There's an extension for sphinx that can generate redirects.  Add a dependency
on that, then use it to create a redirect so that those older links still work.

I was able to install this sphinx extension via:

    $ sudo apt install python3-sphinx-reredirects

We may need to install this on whatever server generates the llvm
documentation.
  • Loading branch information
nickdesaulniers committed Dec 17, 2024
1 parent e8a6563 commit 811f689
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion libc/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,11 @@

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ["sphinx.ext.intersphinx", "sphinx.ext.todo"]
extensions = [
"sphinx.ext.intersphinx",
"sphinx.ext.todo",
"sphinx_reredirects"
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
Expand Down Expand Up @@ -261,3 +265,7 @@

# Enable this if you want TODOs to show up in the generated documentation.
todo_include_todos = True

redirects = {
"math/index": "../headers/math/index.html"
}

0 comments on commit 811f689

Please sign in to comment.