.. index::
   pair: sphinx;  github

.. _sphinx_to_github:

=======================
Sphinx to github
=======================


.. seealso::

   - https://github.com/michaeljones/sphinx-to-github



This project is designed to help you get around the github-pages Jekyll behaviour
of ignoring top level directories starting with an underscore.

This is solved in a much neater way by creating a .nojekyll in the root of you
github-pages which will disable Jekyll as described here and here.

This makes this project largely useless!

Thank you to acdha for making me aware of this.


.. _acdha:  https://github.com/acdha