QuantEcon / QuantEcon/actions

True Sphinx incrementality via mtime manipulation keyed to the cache-build SHA

Open
#156 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Shell
Stars
0
Forks
1
Avg merge
32m
Merged PRs (30d)
3

Description

#92 Phase 3: true Sphinx incrementality via mtime manipulation keyed to the cache-build SHA — touch only the PR diff so Sphinx rebuilds only changed pages.

  • mtime scheme keyed to the SHA the cache was built at
  • Full rebuild on deletions/renames/_toc.yml/_config.yml

Design notes and rejected alternatives (single-page builds, Sphinx -j) in PROJECT-OPTIMIZE-PREVIEWS.md.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read PROJECT-OPTIMIZE-PREVIEWS.md first, including the rejected alternatives, then trace the cache-build SHA and PR diff used by the Sphinx build. Define the mtime scheme and the full-rebuild cases for deletions, renames, _toc.yml, and _config.yml; done means Sphinx rebuilds only changed pages while those cases trigger a full rebuild.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, shell
Domain
build-system, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.