Fix GitHub Pages documentation rendering #413
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes the GitHub Pages documentation site which was showing raw HTML instead of rendered pages.
Problem
The documentation at https://policyengine.github.io/policyengine-us-data/ was not rendering properly because MyST was generating absolute paths (like
/build/) that don't work when served from a GitHub Pages subdirectory.Solution
Set the
BASE_URLenvironment variable to/policyengine-us-datawhen building documentation for deployment. MyST uses this to generate correct relative paths.Test
The documentation will render correctly at https://policyengine.github.io/policyengine-us-data/ after this fix is deployed.