Skip to content

Update sphinx theme#152

Merged
justdave merged 1 commit into
bugzilla:mainfrom
dannycolin:update-docs
Jun 21, 2026
Merged

Update sphinx theme#152
justdave merged 1 commit into
bugzilla:mainfrom
dannycolin:update-docs

Conversation

@dannycolin

@dannycolin dannycolin commented Jan 14, 2026

Copy link
Copy Markdown
Contributor

Details

Use the default readthedocs theme instead of our custom theme. This ensure we use the same theme for both 5.x and 6.x documentation. We also benefit from niceties included in the latest readthedocs theme that our custom theme doesn't provide (e.g better mobile layout).

Additional info

bug 2010419

NOTE: Bug number is required. If you haven't filed a bug on https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla yet, don't submit the Pull Request. Please edit the above link to put the bug number both immediately after the # character and after the = character at the end. You can delete this paragraph once you've added your bug number.

Test Plan

cd [harmory folder]/docs/en
python -m venv venv
pip install -r requirements.txt
make html
python -m http.server -d ./html

You might need to adjust the sphinx version installed in your venv depending on your OS (e.g. Fedora 43 requires Sphinx 7.3+ because it comes with Python 3.14). This shouldn't be an issue in the runner.

@dannycolin dannycolin marked this pull request as ready for review January 16, 2026 22:10
@dannycolin dannycolin requested a review from justdave January 16, 2026 22:10
@justdave justdave self-assigned this Jan 19, 2026
@justdave

Copy link
Copy Markdown
Member

Using the GitHub link to rebase this branch since it's out of date...

Use the default readthedocs theme instead of our custom theme. This
ensure we use the same theme for both 5.x and 6.x documentation. We
also benefit from niceties included in the latest readthedocs theme
that our custom theme doesn't provide (e.g better mobile layout).
@justdave

Copy link
Copy Markdown
Member

@justdave justdave merged commit abaaa83 into bugzilla:main Jun 21, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants