Skip to content

Commit 03cced2

Browse files
committed
trying to fix docs
1 parent da95053 commit 03cced2

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/buildsite.sh

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,15 @@ git checkout -b gh-pages
3636
# directories that start with an underscore (_) can remain
3737
touch .nojekyll
3838

39+
# Add README
40+
cat > README.md <<EOF
41+
# README for the GitHub Pages Branch
42+
This branch is simply a cache for the website and is not intended to be viewed on github.com.
43+
For more information on how this site is built using Sphinx, Read the Docs, and GitHub Actions/Pages, see:
44+
* https://www.docslikecode.com/articles/github-pages-python-sphinx/
45+
* https://tech.michaelaltfield.net/2020/07/18/sphinx-rtd-github-pages-1
46+
EOF
47+
3948
# Copy the resulting html pages built from Sphinx to the gh-pages branch
4049
git add .
4150

0 commit comments

Comments
 (0)