Skip to content

Conversation

@pushfoo
Copy link
Member

@pushfoo pushfoo commented Jan 19, 2025

TL;DR: Ship 3.0 by letting you edit CSS without ./make.py clean 😱!

How do I use this & When?

Does CSS not copy right on your local machine? Then:

  1. cd $ARCADE_DIR
  2. touch .ENABLE_DEVMACHINE_SPHINX_STATIC_FIX
  3. ./make.py html or ./make.py serveas usual

Why do this?

TL;DR: Debugging CSS is already hard enough

  1. Sphinx's _static has been making CSS harder by being broken since at least 2015
  2. This fixes it for both:

Technical Details

  1. Sphinx rebuilds haven't copied updated CSS correctly since at least 2015 (Files from _static are not copied automatically sphinx-doc/sphinx#1810)
  2. The solutions have traditionally been:
    • The equivalent of our ./make.py clean (slow, hurts)
    • Write your own awful kludge
  3. There's a fix in the works upstream, but...

Does this affect CI runs / readthedocs / code quality scans?

No.

@pushfoo pushfoo merged commit 049ec48 into development Jan 20, 2025
9 checks passed
@einarf einarf deleted the temp_fix_sphinx_copy_issue branch January 26, 2025 10:57
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