[libc][docs] add redirect for math/index.html #120274
Conversation
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.
|
@llvm/pr-subscribers-libc Author: Nick Desaulniers (nickdesaulniers) Changescommit a9aff44 ("[libc][docs] reorganize documentation (#118836)") moved https://libc.llvm.org/math/index.html to There's an extension for sphinx that can generate redirects. Add a dependency I was able to install this sphinx extension via: We may need to install this on whatever server generates the llvm Full diff: https://github.com/llvm/llvm-project/pull/120274.diff 1 Files Affected:
diff --git a/libc/docs/conf.py b/libc/docs/conf.py
index 502a479b3eb2c5..ca4b5e25f5dffc 100644
--- a/libc/docs/conf.py
+++ b/libc/docs/conf.py
@@ -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"]
@@ -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"
+}
|
|
✅ With the latest revision this PR passed the Python code formatter. |
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/178/builds/1136 Here is the relevant piece of the build log for the reference |
|
yeah, looks like this isn't going to work... |
|
@diogoteles08 , @marcauberer any idea how we're supposed to be able to add sphinx plugins...? |
|
I've emailed @gkistanova to see if we can install the dependency on the bot or not. |
|
It might be better to update the bot to run |
|
Indeed. pip-compile --generate-hashes --output-file=requirements-hashed.txt requirements.txt |
|
oh man, I can't figure out how to install |
|
|
|
We have a corporate policy on "externally managed python environments" that blocks the usage of |
|
Surprised I have not run into that policy yet... Can you do a venv? |
|
Updating the hashes in #120315. The bot will still be broken, but the fix is either:
|
This is what we should be doing. I think a couple other bots already do it. Should be a relatively simple zorg patch. |
|
zorg/buildbot/builders/SphinxDocsBuilder.py ? |
|
Looks right to me. |
commit a9aff44 ("[libc][docs] reorganize documentation (#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:
We may need to install this on whatever server generates the llvm
documentation.