This is an archive of the discontinued LLVM Phabricator instance.

[lldb/infrastructure] Revamp lldb.llvm.org
ClosedPublic

Authored by mib on Aug 18 2023, 4:07 PM.

Details

Summary

This patch brings a fresh coat of paint to the LLDB website.

It uses the furo theme from the suggested theme list, adds some
changes to the css to make it use the full browser window width and
removes the table of contents since the theme generates it automatically.

This patch also rewrites the tables for "GDB to LLDB command map" to
convert them from raw HTML to native inlined code blocks.

To generate the website, make sure you install the theme first with
pip install furo, enable sphinx in the cmake invocation then run
ninja docs-lldb-html

Discourse: https://discourse.llvm.org/t/rfc-revamping-lldbs-website

Signed-off-by: Med Ismail Bennani <ismail@bennani.ma>

Diff Detail

Event Timeline

mib created this revision.Aug 18 2023, 4:07 PM
mib created this object with edit policy "No One".
Herald added a project: Restricted Project. · View Herald TranscriptAug 18 2023, 4:07 PM
mib requested review of this revision.Aug 18 2023, 4:07 PM
mib changed the visibility from "Public (No Login Required)" to "No One".
mib changed the visibility from "No One" to "Custom Policy".Aug 18 2023, 4:15 PM
mib updated this revision to Diff 552462.Aug 22 2023, 12:04 PM
mib edited the summary of this revision. (Show Details)
mib added a reviewer: Restricted Project.
mib set the repository for this revision to rG LLVM Github Monorepo.
mib changed the visibility from "Custom Policy" to "Public (No Login Required)".
mib changed the edit policy from "No One" to "All Users".
mib edited projects, added Restricted Project; removed Restricted Project.
mib added a subscriber: Restricted Project.

Fix some of the GDB to LLDB command map formatting issues

Herald added a project: Restricted Project. · View Herald TranscriptAug 22 2023, 12:04 PM
mib edited the summary of this revision. (Show Details)Aug 22 2023, 12:11 PM
JDevlieghere added inline comments.Aug 23 2023, 9:00 AM
lldb/docs/conf.py
52–57

We should do something similar for the furo theme.

mib updated this revision to Diff 552811.Aug 23 2023, 11:17 AM
mib marked an inline comment as done.

Address @JDevlieghere feedback by adding exception handling if the theme is not installed.

mib updated this revision to Diff 552871.Aug 23 2023, 1:43 PM

Revert deletions to formatting.rst

This patch changes the theme and removes the inline table-of-contents that are always shown on the right. If there are any other changes needed to better support the theme we can apply them as we discover them. LGTM.

This revision is now accepted and ready to land.Aug 23 2023, 1:45 PM
mib added a comment.Aug 24 2023, 7:38 AM

Given we didn't receive more feedback on this, I'll land it now. If there are other comments, we can address those after the fact.

This revision was automatically updated to reflect the committed changes.

Given we didn't receive more feedback on this, I'll land it now. If there are other comments, we can address those after the fact.

Hello! It seems the changes here have taken out the sphinx publish bot: https://lab.llvm.org/buildbot/#/builders/89/builds/46884

The issue appears to be this bit:

Theme error:
no theme named 'furo' found (missing theme.conf?)

If it's going to take a while to address, I'd recommend reverting the patch so that the bot goes back to green.

Given we didn't receive more feedback on this, I'll land it now. If there are other comments, we can address those after the fact.

Hello! It seems the changes here have taken out the sphinx publish bot: https://lab.llvm.org/buildbot/#/builders/89/builds/46884

The issue appears to be this bit:

Theme error:
no theme named 'furo' found (missing theme.conf?)

If it's going to take a while to address, I'd recommend reverting the patch so that the bot goes back to green.

Hey @aaron.ballman, I've reached out to @tonic & @gkistanova (who was CC'ed to the Buildbot failure email) via email to install the theme. It should be as simple as running /usr/bin/python3 -m pip install furo on the generator bot (as-worker-4 I guess), so let's give them some time to do it. Thanks!

Given we didn't receive more feedback on this, I'll land it now. If there are other comments, we can address those after the fact.

Hello! It seems the changes here have taken out the sphinx publish bot: https://lab.llvm.org/buildbot/#/builders/89/builds/46884

The issue appears to be this bit:

Theme error:
no theme named 'furo' found (missing theme.conf?)

If it's going to take a while to address, I'd recommend reverting the patch so that the bot goes back to green.

Hey @aaron.ballman, I've reached out to @tonic & @gkistanova (who was CC'ed to the Buildbot failure email) via email to install the theme. It should be as simple as running /usr/bin/python3 -m pip install furo on the generator bot (as-worker-4 I guess), so let's give them some time to do it. Thanks!

Thanks!

That bot is responsible for updating the documentation on the website, so it being down for an extended period of time is disruptive (none of our docs get updated). I'm fine giving the bot owners some time to do the install if they're around and able to get to it quickly, but if it can't be resolved in a few hours, I'd still appreciate a revert.

mib added a comment.Aug 24 2023, 10:38 AM

Given we didn't receive more feedback on this, I'll land it now. If there are other comments, we can address those after the fact.

Hello! It seems the changes here have taken out the sphinx publish bot: https://lab.llvm.org/buildbot/#/builders/89/builds/46884

The issue appears to be this bit:

Theme error:
no theme named 'furo' found (missing theme.conf?)

If it's going to take a while to address, I'd recommend reverting the patch so that the bot goes back to green.

Hey @aaron.ballman, I've reached out to @tonic & @gkistanova (who was CC'ed to the Buildbot failure email) via email to install the theme. It should be as simple as running /usr/bin/python3 -m pip install furo on the generator bot (as-worker-4 I guess), so let's give them some time to do it. Thanks!

Thanks!

That bot is responsible for updating the documentation on the website, so it being down for an extended period of time is disruptive (none of our docs get updated). I'm fine giving the bot owners some time to do the install if they're around and able to get to it quickly, but if it can't be resolved in a few hours, I'd still appreciate a revert.

Makes sense. Thanks for your patience :)

mib added a comment.Aug 24 2023, 11:45 AM

Given that the bot is still red, I've reverted the patch in dfb48dcc9cb6217bd62aed1dc8a5f30736eafba7

mib reopened this revision.Aug 24 2023, 11:46 AM
This revision is now accepted and ready to land.Aug 24 2023, 11:46 AM

Given that the bot is still red, I've reverted the patch in dfb48dcc9cb6217bd62aed1dc8a5f30736eafba7

Thank you for the revert! I can confirm the publish bot is now green again.

This revision was automatically updated to reflect the committed changes.
lldb/docs/use/formatting.rst