IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Clean up the CNAME file in `sphinx.ext.githubpages` (#11295)

Browse Source 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
This commit is contained in:
Martin Liška 2023-04-06 23:46:50 +02:00 committed by GitHub
parent c1c2d758c9
commit 26eb2ef7c4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 38 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
sphinx/ext/githubpages.py
View File

@ -3,7 +3,7 @@
from __future__ import annotations from __future__ import annotations
import os import os
import urllib import urllib.parse
from typing import Any from typing import Any
import sphinx import sphinx
@ -11,19 +11,44 @@ from sphinx.application import Sphinx
from sphinx.environment import BuildEnvironment from sphinx.environment import BuildEnvironment
def create_nojekyll_and_cname(app: Sphinx, env: BuildEnvironment) -> None: def _get_domain_from_url(url: str) -> str:
if app.builder.format == 'html': """Get the domain from a URL."""
open(os.path.join(app.builder.outdir, '.nojekyll'), 'wb').close() return url and urllib.parse.urlparse(url).hostname or ''
html_baseurl = app.config.html_baseurl
if html_baseurl: def create_nojekyll_and_cname(app: Sphinx, env: BuildEnvironment) -> None:
domain = urllib.parse.urlparse(html_baseurl).hostname """Manage the ``.nojekyll`` and ``CNAME`` files for GitHub Pages.
if domain and not domain.endswith(".github.io"):
with open(os.path.join(app.builder.outdir, 'CNAME'), 'w', For HTML-format builders (e.g. 'html', 'dirhtml') we unconditionally create
encoding="utf-8") as f: the ``.nojekyll`` file to signal that GitHub Pages should not run Jekyll
# NOTE: don't write a trailing newline. The `CNAME` file that's processing.
# auto-generated by the Github UI doesn't have one.
f.write(domain) If the :confval:`html_baseurl` option is set, we also create a CNAME file
with the domain from ``html_baseurl``, so long as it is not a ``github.io``
domain.
If this extension is loaded and the domain in ``html_baseurl`` no longer
requires a CNAME file, we remove any existing ``CNAME`` files from the
output directory.
"""
if app.builder.format != 'html':
return
open(os.path.join(app.builder.outdir, '.nojekyll'), 'wb').close()
cname_path = os.path.join(app.builder.outdir, 'CNAME')
domain = _get_domain_from_url(app.config.html_baseurl)
# Filter out GitHub Pages domains, as they do not require CNAME files.
if domain and not domain.endswith(".github.io"):
with open(cname_path, 'w', encoding="utf-8") as f:
# NOTE: don't write a trailing newline. The `CNAME` file that's
# auto-generated by the GitHub UI doesn't have one.
f.write(domain)
else:
try:
os.unlink(cname_path)
except FileNotFoundError:
pass
def setup(app: Sphinx) -> dict[str, Any]: def setup(app: Sphinx) -> dict[str, Any]: