mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
33c8b1d952
Github Pages allows you to link a custom domain to your Github Pages site by adding a `CNAME` file at the top-level of your `docs` directory. The `githubpages` extension already inserts a `.nojekyll` file in the `docs` directory, so it's a good place to add support for this `CNAME` file as well.
33 lines
1.0 KiB
Python
33 lines
1.0 KiB
Python
"""
|
|
test_ext_githubpages
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Test sphinx.ext.githubpages extension.
|
|
|
|
:copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
import pytest
|
|
|
|
|
|
@pytest.mark.sphinx('html', testroot='ext-githubpages')
|
|
def test_githubpages(app, status, warning):
|
|
app.builder.build_all()
|
|
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, status, warning):
|
|
app.builder.build_all()
|
|
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, status, warning):
|
|
app.builder.build_all()
|
|
assert (app.outdir / '.nojekyll').exists()
|
|
assert (app.outdir / 'CNAME').text() == 'sphinx-doc.org'
|