Add sphinx.ext.githubpages to publish the docs on GitHub Pages

1 files changed, 24 insertions, 0 deletions

diff --git a/sphinx/ext/githubpages.py b/sphinx/ext/githubpages.py
new file mode 100644
index 000000000..17b858a32
--- /dev/null
+++ b/sphinx/ext/githubpages.py
@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+"""
+    sphinx.ext.githubpages
+    ~~~~~~~~~~~~~~~~~~~~~~
+
+    To publish HTML docs at GitHub Pages, create .nojekyll file.
+
+    :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+"""
+
+import os
+import sphinx
+
+
+def create_nojekyll(app, env):
+    if app.builder.format == 'html':
+        path = os.path.join(app.builder.outdir, '.nojekyll')
+        open(path, 'wt').close()
+
+
+def setup(app):
+    app.connect('env-updated', create_nojekyll)
+    return {'version': sphinx.__display_version__, 'parallel_read_safe': True}