Step 1
Rename docs
folder to docs_src
.
Step 2
Move docs_src/_build
folder to docs
.
Step 3
Change build_sphinx
and upload_sphinx
sections in setup.cfg
:
[build_sphinx]
source-dir = docs_src/
build-dir = docs
[upload_sphinx]
upload-dir = docs/html
Step 4
Add docs/doctrees/
to .gitignore
.
Step 5
Add empty docs/.nojekyll
file.
Step 6
Add docs/index.html
file:
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="refresh" content="0; url='html/'" />
</head>
<body>
</body>
</html>
Step 7
Go to GitHub project page. Select Settings
tab. On GitHub Pages
section set Source
to master branch /docs folder
.