summaryrefslogtreecommitdiffstats
path: root/doc/usage/extensions/githubpages.rst
blob: 6d56a303699fcd102d8a7b0077e47dcb117bd972 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
:mod:`sphinx.ext.githubpages` -- Publish HTML docs in GitHub Pages
==================================================================

.. module:: sphinx.ext.githubpages
   :synopsis: Publish HTML docs in GitHub Pages

.. versionadded:: 1.4

.. versionchanged:: 2.0
   Support ``CNAME`` file

This extension creates ``.nojekyll`` file on generated HTML directory to publish
the document on GitHub Pages.

It also creates a ``CNAME`` file for custom domains when :confval:`html_baseurl`
set.