Search code examples
pythongithubpython-sphinx

Sphinx docs displaying locally but not at URL when pushed to GitHub

I generated Python docs using Sphinx using make html. When I opened index.html in my browser the docs displayed as expected and all links worked as expected.

I then committed all docs and pushed to a branch in GitHub.

When I access the url https://<my company>.github.io/<my repo>/ the page displays but the CSS isn't working and some of the links do not work. Does anybody know why this might be?

Solution

  • The problem was that some files were missing. After reading this I added an empty .nojekyll which resolved the issue.