Skip to content

Conversation

@amotl
Copy link
Member

@amotl amotl commented Nov 6, 2025

About

The most recent theme allows parallel builds, so let's use them also here.

References

/cc @surister

@amotl amotl requested review from matriv and seut November 6, 2025 16:31
@coderabbitai
Copy link

coderabbitai bot commented Nov 6, 2025

Walkthrough

Documentation configuration strings updated: docs/build.json badge version changed 2.1.2 → 2.1.4; docs/requirements.txt bumped crate-docs-theme 0.41.0.dev2 → 0.42.0. No code or behavioral changes.

Changes

Cohort / File(s) Change Summary
Docs build metadata
docs/build.json
Badge message version updated 2.1.2 → 2.1.4 (string change only)
Docs dependency pin
docs/requirements.txt
crate-docs-theme bumped 0.41.0.dev2 → 0.42.0

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Files are configuration-only and contain simple version string updates.

Possibly related PRs

Suggested labels

maintenance

Suggested reviewers

  • surister

Poem

🐰 A hop and a nibble, I tweak and I store,
Versions refreshed on the docs’ little door,
From old strings to new, a soft little thud,
Crates and badges aligned — tidy and mud-free! 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Enable parallel builds by using newest theme and docs builder' directly relates to the main objective - updating dependencies to enable parallel builds.
Description check ✅ Passed The description explains the purpose of the changes (enabling parallel builds with the newest theme) and provides a relevant reference, which aligns with the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch parallel

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6c937ac and a83172e.

📒 Files selected for processing (2)
  • docs/build.json (1 hunks)
  • docs/requirements.txt (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/build.json
  • docs/requirements.txt
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Build docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@amotl amotl added the maintenance C'est la vie. label Nov 6, 2025
Copy link
Contributor

@matriv matriv left a comment

Choose a reason for hiding this comment

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

I guess we don't call sphinx here to add -j auto? right?

@amotl
Copy link
Member Author

amotl commented Nov 6, 2025

I guess we don't call sphinx here to add -j auto, right?

Right, that invocation is pulled in from crate-docs. After merging this patch, workstation users (mostly humans) should re-run the make reset, make dev incantation, and that's it.

GHA workflows will invoke make check, so this is also covered and provided by crate-docs.

Honestly, I don't know exactly how/where Sphinx is invoked on RTD. It must be the .readthedocs.yml file where to configure that?

@amotl
Copy link
Member Author

amotl commented Nov 6, 2025

About how/where Sphinx is invoked on RTD?

It is possible that we would need to customize the RTD build job in this case.

In turn, this would create a redundancy. Maybe we can also use crate-docs on RTD, making it invoke make html to avoid the redundancies? Let's explore this within a subsequent patch...

@amotl amotl merged commit daef231 into main Nov 6, 2025
3 checks passed
@amotl amotl deleted the parallel branch November 6, 2025 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance C'est la vie.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants