Skip to content

docs: let the page use the full viewport width - #1231

Merged
vringar merged 1 commit into
masterfrom
docs/full-width-layout
Sep 6, 2026
Merged

vringar merged 1 commit into
masterfrom
docs/full-width-layout

Conversation

@vringar

@vringar vringar commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

Alabaster centres a fixed 940px page by default, so the navigation sidebar floats in the middle of the screen and wide content is squeezed into a narrow column. The requirements matrix in developers/Stealth-Requirements.rst is the worst case — a wide table wrapped into roughly a third of a modern display.

html_theme_options = {
    "page_width": "100%",
    "sidebar_width": "260px",
}

page_width and sidebar_width are alabaster's own options, confirmed against the installed theme's theme.conf. There was no html_theme_options block at all before this, so the theme was running entirely on defaults.

The sidebar ends up flush against the left edge and the body takes the remaining width.

One caveat on reviewing this: the effect is most visible on pages that #1154 adds, so the Read the Docs preview for this PR shows the change against the current docs only.

Copilot AI lite review requested due to automatic review settings September 6, 2026 16:01

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The change is small and low-risk, with only a minor doc-comment clarity issue noted.

Pull request overview

Adjusts the Sphinx docs theme configuration so OpenWPM’s documentation uses the full viewport width, avoiding Alabaster’s default centered fixed-width layout that squeezes wide content (e.g., large tables).

Changes:

  • Add html_theme_options for the Alabaster theme to set page_width to 100%.
  • Set a fixed sidebar_width to keep the navigation consistent while letting the body expand.
File summaries
File Description
docs/conf.py Configures Alabaster theme options to use full-width pages with a fixed-width sidebar.
Review details
  • Files reviewed: 1/2 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/conf.py
Comment on lines +71 to +74
# Alabaster centres a fixed 940px page, which leaves the sidebar floating
# mid-screen and wraps wide tables (e.g. the requirements matrix in
# developers/Stealth-Requirements.rst) into a narrow column. Use the whole
# viewport: the sidebar sits flush left and the body takes the rest.
@vringar
vringar force-pushed the docs/full-width-layout branch from 13b1f10 to 6c11e3f Compare September 6, 2026 16:15
@vringar
vringar enabled auto-merge September 6, 2026 16:16
@vringar
vringar added this pull request to the merge queue Sep 6, 2026
@codecov

codecov Bot commented Sep 6, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 62.31%. Comparing base (975b09c) to head (6e0f811).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1231   +/-   ##
=======================================
  Coverage   62.31%   62.31%           
=======================================
  Files          40       40           
  Lines        3930     3930           
=======================================
  Hits         2449     2449           
  Misses       1481     1481           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to no response for status checks Sep 6, 2026
Alabaster centres a fixed 940px page by default, which leaves the navigation
sidebar floating in the middle of the screen and squeezes wide content into a
narrow column. The requirements matrix in developers/Stealth-Requirements.rst
is the worst case: a wide table wrapped into roughly a third of a modern
display.

Span the viewport instead, so the sidebar sits flush against the left edge and
the body gets every remaining pixel.
@vringar
vringar force-pushed the docs/full-width-layout branch from 6c11e3f to 6e0f811 Compare September 6, 2026 20:23
@vringar
vringar enabled auto-merge September 6, 2026 20:34
@vringar
vringar added this pull request to the merge queue Sep 6, 2026
Merged via the queue into master with commit 14745c4 Sep 6, 2026
15 checks passed
@vringar
vringar deleted the docs/full-width-layout branch September 6, 2026 21:42
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