Attempt to fix doc build broken by #2304 by pushfoo · Pull Request #2309 · pythonarcade/arcade · GitHub
Skip to content

Attempt to fix doc build broken by #2304#2309

Merged
pushfoo merged 1 commit into
developmentfrom
fix-doc-build-again
Jul 24, 2024
Merged

Attempt to fix doc build broken by #2304#2309
pushfoo merged 1 commit into
developmentfrom
fix-doc-build-again

Conversation

@pushfoo

@pushfoo pushfoo commented Jul 24, 2024

Copy link
Copy Markdown
Member

TL;DR #2304 broke readthedocs because it doesn't use make.py nor allow a good way to do so

What broke?

Color lookup filename read since we don't set the relative path: https://readthedocs.org/projects/arcade-library/builds/25093429/

  1. Build docs in build/ #2304 alters make.py to set the build directory
  2. It does not update readthedocs.yaml
  3. This doesn't matter since the only real control rtd offers comes in the form of:
    1. An environment variable control panel (aka bus factor) if it even works
    2. Overriding the entire build process 🙃

Changes

  1. Try to extract the root dir from the Sphinx object
  2. Convert to absolute path
  3. Pass the new path to the color table generation function instead
  4. Explain why further in the source
  5. Add some diagnostic printout with comments

@pushfoo

pushfoo commented Jul 24, 2024

Copy link
Copy Markdown
Member Author

@pushfoo pushfoo merged commit df415dd into development Jul 24, 2024
@einarf einarf deleted the fix-doc-build-again branch July 28, 2024 12:32
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.

1 participant