Skip to content

docs(sphinx): migrate docs theme to shibuya - #14209

Open
hwhsu1231 wants to merge 1 commit into
apple:mainfrom
hwhsu1231-fork:shibuya-theme
Open

hwhsu1231 wants to merge 1 commit into
apple:mainfrom
hwhsu1231-fork:shibuya-theme

Conversation

@hwhsu1231

Copy link
Copy Markdown

Replace the sphinx-bootstrap-theme with the shibuya theme and update the Sphinx configuration accordingly:

  • Set html_theme to "shibuya"
  • Set html_logo to "../FDB_logo.svg"
  • Drop the sphinx_bootstrap_theme import
  • Drop the sphinxcontrib.jquery extension
  • Drop the bootstrap-specific theme options
  • Add discussion_url/github_url social links
  • Add the "Edit this page" link in html_context

Replace the `sphinx-bootstrap-theme` with the `shibuya` theme and update
the Sphinx configuration accordingly:

- Set `html_theme` to `"shibuya"`
- Set `html_logo` to `"../FDB_logo.svg"`
- Drop the `sphinx_bootstrap_theme` import
- Drop the `sphinxcontrib.jquery` extension
- Drop the bootstrap-specific theme options
- Add `discussion_url`/`github_url` social links
- Add the "Edit this page" link in `html_context`
@hwhsu1231

Copy link
Copy Markdown
Author

Preview the documentation

Run the following commands to preview the documentation:

uv run --with-requirements documentation/sphinx/requirements.txt \
sphinx-build \
    -b html \
    -D version=8.0.0 \
    -D release=8.0.0 \
    -c documentation/sphinx \
    documentation/sphinx/source \
    documentation/build

firefox documentation/build/index.html

Screenshots:

screenshot_20261003_021732

@saintstack

Copy link
Copy Markdown
Contributor

@hwhsu1231 Why should we do this? Thank you.

@hwhsu1231

hwhsu1231 commented Oct 2, 2026 •

Copy link
Copy Markdown
Author

Why should we do this? Thank you.

@saintstack There are various factors:

  1. The Bootstrap theme hasn't been updated for nearly 4 years.
  2. Most modern themes like Shibuya adopt a three-column layout, which is more user-friendly.
  3. The Shibuya theme supports dark/light modes, whereas the Bootstrap theme only supports light mode by default.

@hwhsu1231

Copy link
Copy Markdown
Author

Additionally, if time permits later on, I also plan to use widgets from the sphinx-design extension (such as grids, cards, buttons, etc.) to improve the documentation.

@saintstack

Copy link
Copy Markdown
Contributor

@hwhsu1231 Thank you. For a change like this, the way the docs look, I'd suggest bringing it up on fdb forum and/or over in discord just to give folks prior-notice. Talk up the benefits and link to images of what it'll look like. Thanks.

@hwhsu1231

Copy link
Copy Markdown
Author

@saintstack

Copy link
Copy Markdown
Contributor

@hwhsu1231 Thanks for posting. Lets see if any feedback.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants