sphinx/tests/test_extensions/test_ext_githubpages.py
2024-11-22 21:54:26 +00:00

35 lines
939 B
Python

"""Test sphinx.ext.githubpages extension."""
from __future__ import annotations
import pytest
@pytest.mark.sphinx('html', testroot='ext-githubpages')
def test_githubpages(app):
app.build(force_all=True)
assert (app.outdir / '.nojekyll').exists()
assert not (app.outdir / 'CNAME').exists()
@pytest.mark.sphinx(
'html',
testroot='ext-githubpages',
confoverrides={'html_baseurl': 'https://sphinx-doc.github.io'},
)
def test_no_cname_for_github_io_domain(app):
app.build(force_all=True)
assert (app.outdir / '.nojekyll').exists()
assert not (app.outdir / 'CNAME').exists()
@pytest.mark.sphinx(
'html',
testroot='ext-githubpages',
confoverrides={'html_baseurl': 'https://sphinx-doc.org'},
)
def test_cname_for_custom_domain(app):
app.build(force_all=True)
assert (app.outdir / '.nojekyll').exists()
assert (app.outdir / 'CNAME').read_text(encoding='utf8') == 'sphinx-doc.org'