Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions sphinx/ext/viewcode.py
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,10 @@ def should_generate_module_page(app: Sphinx, modname: str) -> bool:


def collect_pages(app: Sphinx) -> Generator[Tuple[str, Dict[str, Any], str], None, None]:
if (app.builder.name.startswith('epub') and
not app.builder.env.config.viewcode_enable_epub):
return

env = app.builder.env
if not hasattr(env, '_viewcode_modules'):
return
Expand Down
19 changes: 19 additions & 0 deletions tests/test_ext_viewcode.py
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,22 @@ def find_source(app, modname):

assert result.count('href="_modules/not_a_package/submodule.html#not_a_package.submodule.Class3.class_attr"') == 1
assert result.count('This is the class attribute class_attr') == 1


@pytest.mark.sphinx(buildername='epub', testroot='ext-viewcode', freshenv=True)
def test_epub_pages_disabled(app, status, warning):
app.builder.build_all()

modules_dir = app.outdir / '_modules'
assert not modules_dir.exists()


@pytest.mark.sphinx(buildername='epub', testroot='ext-viewcode', freshenv=True,
confoverrides={'viewcode_enable_epub': True})
def test_epub_pages_enabled(app, status, warning):
app.builder.build_all()

modules_dir = app.outdir / '_modules'
assert (modules_dir / 'index.xhtml').isfile()
assert (modules_dir / 'spam' / 'mod1.xhtml').isfile()
assert (modules_dir / 'spam' / 'mod2.xhtml').isfile()