Skip to content

Commit 286d793

Browse files
committed
docs: Add instructions to fix GitHub Pages build error
- GitHub Pages needs to be configured to use gh-pages branch instead of master - This requires manual configuration in repository settings - The gh-pages branch contains only a redirect to ReadTheDocs
1 parent 60f42c6 commit 286d793

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

GITHUB_PAGES_FIX.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# GitHub Pages Fix Instructions
2+
3+
The GitHub Pages build is failing because it's trying to process Python files. To fix this:
4+
5+
## Option 1: Change GitHub Pages Source (Recommended)
6+
7+
1. Go to: https://github.com/AliAkhtari78/SpotifyScraper/settings/pages
8+
2. Under "Source", change from:
9+
- Branch: `master`
10+
- Folder: `/ (root)`
11+
3. To:
12+
- Branch: `gh-pages`
13+
- Folder: `/ (root)`
14+
4. Click "Save"
15+
16+
The `gh-pages` branch has been created with only a minimal redirect page to ReadTheDocs.
17+
18+
## Option 2: Disable GitHub Pages
19+
20+
If you don't need GitHub Pages (since documentation is on ReadTheDocs):
21+
22+
1. Go to: https://github.com/AliAkhtari78/SpotifyScraper/settings/pages
23+
2. Look for an option to disable GitHub Pages
24+
3. Or change the source to "None" if available
25+
26+
## Why This Is Happening
27+
28+
GitHub Pages is trying to build the site using Jekyll from the master branch, which includes all Python source files. The build fails when it tries to process these files. The gh-pages branch contains only a simple HTML redirect page, which will build successfully.
29+
30+
## Result
31+
32+
After making this change, the "pages build and deployment" workflow should succeed, and https://aliakhtari78.github.io/SpotifyScraper/ will redirect to the ReadTheDocs documentation.

0 commit comments

Comments
 (0)