mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
17 lines
491 B
ReStructuredText
17 lines
491 B
ReStructuredText
: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.
|